Skip to content

This package offers a straightforward and easy-to-use alert component for your Filament application. It allows you to quickly implement customizable alert messages, enhancing the user experience by providing clear and concise notifications.

License

Notifications You must be signed in to change notification settings

CodeWithDennis/filament-simple-alert

Repository files navigation

Filament Simple Alert

Latest Version on Packagist GitHub Code Style Action Status Total Downloads

This package offers a straightforward and easy-to-use alert component for your Filament application. It allows you to quickly implement customizable alert messages, enhancing the user experience by providing clear and concise notifications.

Simple Alert

Installation

You can install the package via composer:

composer require codewithdennis/filament-simple-alert

Make sure you add the following to your `tailwind.config.js file.

'./vendor/codewithdennis/filament-simple-alert/resources/**/*.blade.php',

Installing on a project with Tailwind already set up?

If you have installed filament into an existing project with Tailwind as part of it then you will need to [publish a custom theme](https://filamentphp.com/docs/3.x/panels/themes#creating-a-custom-theme for the styles to be applied correctly.

Usage

The alerts can be used in your infolists or forms, make sure you pick the right component.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
use CodeWithDennis\SimpleAlert\Components\Forms\SimpleAlert;

Simple Alerts

There are 4 types of simple alerts: danger, info, success, and warning.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->danger()
    ->info()
    ->success()
    ->warning()

If you would like to use a different color, you can use the color method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->color('purple')

Icon

By default, all simple alerts will have an icon. If you would like to change the icon, you can use the icon method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->color('purple')
    ->icon('heroicon-s-users')

Title

You can add a title to the alert by using the title method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->title('Hoorraayy! Your request has been approved! 🎉')

Description

You can add a description to the alert by using the description method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->description('This is the description')

Link

You can also add a link to the alert by using the link method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->info()
    ->link('https://filamentphp.com'),

If you would like to customize the link label, you can use the linkLabel method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->info()
    ->link('https://filamentphp.com')
    ->linkLabel('Read more!'),

If you would like the link to open in a new tab, you can use the linkBlank method.

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->info()
    ->link('https://filamentphp.com')
    ->linkBlank(),

Example

use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;

SimpleAlert::make()
    ->success()
    ->title(new HtmlString('<strong>Hoorraayy! Your request has been approved! 🎉</strong>'))
    ->description('Lorem ipsum dolor sit amet consectetur adipisicing elit.')
    ->link('https://filamentphp.com')
    ->linkLabel('Read more!')
    ->linkBlank(),

Screenshots

light dark

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

This package offers a straightforward and easy-to-use alert component for your Filament application. It allows you to quickly implement customizable alert messages, enhancing the user experience by providing clear and concise notifications.

Topics

Resources

License

Stars

Watchers

Forks