awcodes / shout
A simple inline contextual notice for Filament forms, basically just a fancy placeholder.
Fund package maintenance!
awcodes
Installs: 240 198
Dependents: 7
Suggesters: 0
Security: 0
Stars: 56
Watchers: 4
Forks: 10
Open Issues: 0
Requires
- php: ^8.1
- filament/filament: ^3.0
- spatie/laravel-package-tools: ^1.15
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9|^8.1
- orchestra/testbench: ^8.0|^9.0
- pestphp/pest: ^2.1
- pestphp/pest-plugin-laravel: ^2.0
- pestphp/pest-plugin-livewire: ^2.1
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2025-05-31 19:39:16 UTC
README
A simple inline contextual notice for Filament forms, basically just a fancy placeholder.
Installation
You can install the package via composer:
composer require awcodes/shout
Usage in Forms
Simply include the component in any of your form's schema()
methods.
use Awcodes\Shout\Components\Shout; Shout::make('so-important') ->content('This is a test') ->type('info') // or 'success', 'warning', 'danger'
Usage in Infolists
Simply include the component in any of your Infolist's schema()
methods.
use Awcodes\Shout\Components\ShoutEntry; ShoutEntry::make('so-important') ->content('This is a test') ->type('info') // or 'success', 'warning', 'danger'
Custom Colors
You can use the color()
method to set a custom color using Filament's Color Object.
use Awcodes\Shout\Components\Shout; use Filament\Support\Colors\Color; Shout::make('so-important') ->color(Color::Lime) Shout::make('so-important') ->color(Color::hex('#badA55'))
Icons
Changing the icon
use Awcodes\Shout\Components\Shout; Shout::make('so-important') ->icon('heroicon-s-circle-check')
Icon Size
use Awcodes\Shout\Components\Shout; Shout::make('so-important') ->iconSize('sm') // or 'md', 'lg', 'xl'
Disabling the icon
use Awcodes\Shout\Components\Shout; Shout::make('so-important') ->icon(false)
Headings
You can add a heading to your shout using the heading()
method. By default , the heading will be a h2 element, but you can override this by using an HtmlString
object.
use Awcodes\Shout\Components\Shout; Shout::make('so-important') ->heading('Important Notice') ->content('This is a test')
Actions
You can add actions to your shout using the actions()
method. This accepts an array of Filament Action objects.
In Forms
use Awcodes\Shout\Components\Shout; use Filament\Forms\Components\Actions\Action; Shout::make('so-important') ->content('This is a test') ->actions([ Action::make('action1') ->label('Action 1') ->url('https://example.com'), Action::make('action2') ->label('Action 2') ->url('https://example.com'), ])
In Infolists
use Awcodes\Shout\Components\ShoutEntry; use Filament\Infolists\Components\Actions\Action; ShoutEntry::make('so-important') ->content('This is a test') ->actions([ Action::make('action1') ->label('Action 1') ->url('https://example.com'), Action::make('action2') ->label('Action 2') ->url('https://example.com'), ])
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.