rai/notify

Modified from Codecourse/notify

dev-main 2024-10-15 17:27 UTC

Requires

• php: >=7.0|^8.0|^8.3
• illuminate/support: ~6.0|^7.0|^8.0|^9.0|^10.0|^11.0

MIT

• Rizqi Mubarok

README

Install

Using Composer

composer require rai/notify

Add the service provider to config/app.php

Rai\Notify\NotifyServiceProvider::class,

Optionally include the Facade in config/app.php if you'd like.

'Notify' => Rai\Notify\Facades\Notify::class,

Note, there is a notify() function available, so unless you really want to use the Facade, there's no need to include it.

Usage

Basic

From your application, call the flash method with a message and type.

notify()->flash('Welcome back!', 'success');

Within a view, you can now check if a flash message exists and output it.

@if (notify()->ready())
    <div class="alert-box {{ notify()->type() }}">
        {{ notify()->message() }}
    </div>
@endif

Notify is front-end framework agnostic, so you're free to easily implement the output however you choose.

Options

You can pass additional options to the flash method, which are then easily accessible within your view.

notify()->flash('Welcome back!', 'success', [
    'timer' => 3000,
    'text' => 'It\'s really great to see you again',
]);

Then, in your view.

@if (notify()->ready())
    <script>
        swal({
            title: "{!! notify()->message() !!}",
            text: "{!! notify()->option('text') !!}",
            type: "{{ notify()->type() }}",
            @if (notify()->option('timer'))
                timer: {{ notify()->option('timer') }},
                showConfirmButton: false
            @endif
        });
    </script>
@endif

The above example uses SweetAlert, but the flexibily of Notify means you can easily use it with any JavaScript alert solution.

Issues and contribution

Just submit an issue or pull request through GitHub. Thanks!