gertjanroke/notification

notifications

Notification

Flash notification that accepts a array and string. You can use it from your controller and also in the views., _(*1)

Install

composer require gertjanroke/notification

After install

ServiceProvider

Add the following line to config/app.php., _(*2)

at providers:, _(*3)

Gertjanroke\Notification\NotificationServiceProvider::class,

And at aliases:, _(*4)

'Notification' => Gertjanroke\Notification\Facade\Notification::class,

Publish files

Run the following command:, _(*5)

php artisan vendor:publish

Usage

Including the flash message in your view

To see the flash notification(s), you need to add the following @include()., _(*6)

@include('notification::message')

And if you want the basic styling that comes with the package, also inlcude the following lines:, _(*7)

<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="{{ asset('assets/css/notification-style.css') }}">

And the javascript:, _(*8)

<script src="{{ asset('assets/js/notification.js') }}"></script>

NOTE: You also need the jQuery library.

Usage from the Controller

available functions

Creating a notification can be done with the next commands:, _(*9)

Notification::
    - success()
    - error()
    - warning()
    - info()
    - overlay() // Bootstrap modal

You can also add the class "Important" to the alert message, with the following command:, _(*10)

Notification::error('message', 'title')->important();

Message variables

You can send a message as a string or as a array., _(*11)

Syntax:, _(*12)

Notification::success([
                    'First success',
                    'Second success title' => [
                        'First success',
                        'Second success'
                    ],
                    'Third success'
                ]);

Notification::success('First success');

Title

The last string is the title. You have two options: give a string or leave it blank., _(*13)

With title:, _(*14)

Notification::success('First success', 'Title success block');

Without title:, _(*15)

Notification::success('First success');

Overlay function

When you want to use a Modal from bootstrap you can do so with the following function and syntax:, _(*16)

Notification::overlay( 'Message', 'Title' );

NOTE: All the given variables need to be a string.

Usage from the view

You can also create a notification from the view file, this is usefull when your using a ajax form., _(*17)

available functions

Creating a notification can be done with the next commands:, _(*18)

Notification.
    - success()
    - error()
    - warning()
    - info()
    - overlay() // Bootstrap modal

Messages, Title and Important

You can send a message as a string or as a array., _(*19)

NOTE: The overlay function only accepts strings.

Messages

The following syntax is used at all functions but NOT FOR: .overlay():, _(*20)

Single message:, _(*21)

Notification.success( 'First message' );

Multiple single messages:, _(*22)

Notification.success( ['First message', 'Second message', 'Third message'] );

Grouping messages:, _(*23)

Notification.success( {'Third message with array': ['First message', 'Second message']} );

Grouping messages inside a Array of messages:, _(*24)

Notification.success( ['First message', 'Second message', {'Third message with array': ['First message', 'Second message']}] );

Title

Adding a title to a notification:, _(*25)

Notification.success( 'message', 'The Title goes after the message' );

Important

Adding the class important to your notification is easly done with adding a boolean as last variable:, _(*26)

Notification.success( 'message', 'Title', TRUE );

Overlay function

When you want to use a Modal from bootstrap you can do so with the following function and syntax:, _(*27)

Notification.overlay( 'Message', 'Title', 'Button text' );

NOTE: All the given variables need to be a string.