A simple inline contextual notice for Filament forms and infolist, basically just a fancy placeholder.
Package Version | Filament Version |
---|---|
1.x | 2.x |
2.x | 3.x |
3.x | 4.x |
If you are upgrading from version 2 to version 3, the ShoutEntry
component is no longer needed and has been removed. You can simply use the Shout
component directly in infolists.
You can install the package via composer:
composer require awcodes/shout
Important
If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.
After setting up a custom theme add the plugin's views to your theme css file or your app's css file if using the standalone packages.
@source '../../../../vendor/awcodes/shout/resources/**/*.blade.php';
Simply include the component in any of your form or infolists schema()
methods.
use Awcodes\Shout\Components\Shout;
Shout::make('so-important')
->content('This is a test')
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')
->content('This is a test')
->color(Color::Lime)
Shout::make('so-important')
->content('This is a test')
->color(Color::hex('#badA55'))
use Awcodes\Shout\Components\Shout;
Shout::make('so-important')
->content('This is a test')
->icon('heroicon-s-circle-check')
use Awcodes\Shout\Components\Shout;
Shout::make('so-important')
->content('This is a test')
->iconSize('sm|md|lg|xl')
use Awcodes\Shout\Components\Shout;
Shout::make('so-important')
->content('This is a test')
->icon(false)
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')
You can add actions to your shout using the actions()
method. This accepts an array of Filament Action objects.
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'),
])
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.