Messenger for Laravel
Goal
To provide a drop-in, application-wide alerting functionality to display various types of alerts and notifications to the user in response to their actions.
Prerequisites
- Bootstrap 3 or 4
- Laravel 5.5 or 5.6
- PHP >= 7.1.3
Features
- Feedback notifications in form of bootstrap alerts or modals.
- Send notifications from facade, app IoC reference, or blade directive.
- Display notification easily via a blade command.
Installation
composer require genealabs/laravel-messenger
Nothing else needs to be done, as the service provider and facades will be auto-loaded.
Configuration
If you need to make changes to the default configuration, run the following command to publish the configuration file config\genealabs-laravel-messenger.php:
php artisan messenger:publish --config
After that you can configure the configuration according to your needs:
/*
|--------------------------------------------------------------------------
| CSS Framework Configuration
|--------------------------------------------------------------------------
|
| Here you may configure the CSS framework to be used by Messenger for
| Laravel. This allows you to switch or upgrade frameworks without
| having to recreate all your alerts.
|
| Available Settings: "bootstrap3", "bootstrap4"
|
*/
'framework' => 'bootstrap4',
/*
|--------------------------------------------------------------------------
| JavaScript Blade Section
|--------------------------------------------------------------------------
|
| Your layout blade template will need to have a section dedicated to
| inline JavaScript methods and commands that are injected by this
| package. This will eliminate conflicts with Vue, as well as
| making sure that JS is run after all deps are loaded.
|
*/
'javascript-blade-section' => 'js',
Usage
- Trigger an alert using either the facade/IoC helper, or a blade directive in another view:
// IoC helper:
app('messenger')->send('message', 'title', 'level', autoHide, 'framework');
// Facade:
Messenger::send('message', 'title', 'level', autoHide, 'framework');
// Blade directive:
@send ('message', 'title', 'level', autoHide, 'framework')
- Add the placeholder to your layout blade file:
<div class="container">
@deliver
</div>
Parameters
message
string|required
The body of the message you want to deliver to your user. This may contain HTML. If you add links, be sure to add the appropriate classes for the framework you are using.
title
string | optional | default: ''
Title of the notification, will be inserted as an <h4> tag, can also include HTML. Again, keep in mind to add any framework-specific formatting yourself.
level
string | optional | default: 'info'
If provided, must be one of the following: 'info', 'success', 'warning', 'danger'.
autoHide
boolean | optional | default: false
Allows you to let the notification disappear automatically after 15 seconds. If autoHide is false, the user will be provided a close button in the alert.
framework
string | optional | default: 'bootstrap3'
Specify the framework you are using. Right now it only supports 'bootstrap3' or 'bootstrap4'.
type
string | optional | default: 'alert'
Invoke any of the available alert modes. Currently only supports 'alert' or 'modal'.
1.2k Dec 29, 2022
223 Sep 28, 2022
24 Oct 3, 2019
3 May 7, 2022
8 Oct 19, 2022
26 Dec 6, 2022
138 Jul 22, 2022
3 Nov 23, 2022
3 Nov 27, 2022
2 Dec 30, 2022
1.2k Dec 29, 2022
2 Mar 8, 2022
2 Aug 22, 2022
28 Dec 19, 2022
3 Apr 11, 2022
1 Oct 16, 2021
94 Nov 22, 2022
16 Sep 9, 2022
4 Nov 29, 2022