Documentation

• Installation
• Usage
• Usage with Custom Filament Themes
• Views

#Installation

You can install the package via composer:

composer require awcodes/shout

#Usage

use Awcodes\Shout\Shout;
 
Shout::make('success')
    ->content('This is a test')
    ->type('success|warning|danger|info') // defaults to info
    ->columnSpan('full')

Shout is a wrapper around Filament's Placeholder component, so it will also work with the methods available to that component.

You can also disable the icon, should you need to with the disableIcon() method.

use Awcodes\Shout\Shout;
 
Shout::make('so-important')
    ->content('This is a test')
    ->disableIcon()
    ->type('info')
    ->columnSpan('full')

#Usage with Custom Filament Themes

You will need to publish the config file and change disable_css to true. This will prevent the plugin from loading its default stylesheet.

php artisan vendor:publish --tag="shout-config"

Next you should add the views to your tailwind config file.

content: [
    ...
    'vendor/awcodes/shout/resources/views/**/*.blade.php'
]

Then rebuild your custom theme.

#Views

It is recommended that you DO NOT publish the views, but if you want to you can do so with the following command.

php artisan vendor:publish --tag="shout-views"