attla/flash-messages

Intuitive package to flash notifications on laravel.

dev-main 2022-09-25 01:07 UTC

Requires

• php: >=7.2.5
• attla/support: dev-main
• illuminate/session: ^6.0|^7.0|^8.0|^9.0

Conflicts

• laracasts/flash: >=0.0.1
• spatie/laravel-flash: >=0.0.1

MIT

• Lucas Nicolau

• flash
• flash-message
• laravel-flash
• laravel-flash-message
• attla
• flash-notification
• laravel-flash-notification

README

✨ Intuitive package to flash notifications on laravel.

Installation

composer require attla/flash-messages

Configuration

To publish the configuration file, run the following command:

php artisan vendor:publish --tag=attla/flash-messages/config

The types array on configuration is usaded to indicate the class to the message.

The icons are default icons for each message type.

Usage

For create a new message you call the facade method as the type name from the configuration

use Attla\Flash\Facade as Flash;

// Create a flash message with the helper function
$flash = flash('Example of message', 'info');
// Create with facade
$flash = Flash::info('Example of message');

// Set the message as dismissible
$flash->dismissible();

// Set a custom class for the message
$flash->class('custom-message-class');

// Set a icon for the message
$flash->icon('far fa-circle-info');
$flash->icon('<i class="far fa-circle-info"></i>');

// Set a timeout for the message
$flash->timeout(6); // will be removed after 6 seconds

// If needed, you can unqueue the message
$flash->destory();

List of message methods

Method	Parameters	Description
dismissible()	-	Make the message disposable
timeout(seconds)	Integer	The message will be removed after the time
class(class)	String	Set a custom class for the message
destory()	-	Unqueue the message
delete()	-	Alias for destory()
forget()	-	Alias for destory()
unset()	-	Alias for destory()
unqueue()	-	Alias for destory()

License

This package is licensed under the MIT license © Octha.