README

This is a simple Bootstrap Toast Package for Laravel.

Installation

composer require felixl7/laravel-bootstrap-toast

You can optionally publish the config file, public resources and blade templates of this package:

php artisan vendor:publish --provider="FelixL7\Toast\ToastServiceProvider"

Setup

Just @include('bootstrap-toast::toaster') into your layout template and make sure to include jQuery and Bootstrap.

<link href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" rel="stylesheet">

<script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js"></script>

This package also uses FontAwesome, but you're free to remove it or add your favourite icon package. Just publish the views of this package and replace the icons from the toast type templates.

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.0/css/all.min.css">

Usage

It's really simple to create Toasts. Just

use FelixL7\Toast\Models\Toast;
...
Toast::default('Toast Title', 'Your Message');
Toast::success('Toast Title', 'Your Message');
Toast::info('Toast Title', 'Your Message');
Toast::warning('Toast Title', 'Your Message');
Toast::error('Toast Title', 'Your Message');

wherever you want. Or if you return a redirect in your controller:

return redirect()->with('toasts', [Toast::success('Toast Title', 'Your Message')]);

Config

You can customize the toast via the config file. Just publish the packages configuration und edit the bootstrap-toast.php file in your config folder.

php artisan vendor:publish --provider="FelixL7\Toast\ToastServiceProvider" --tag=config

Custom Toasts

If you want to create some custom toasts, you just have to publish the views of this package. There you have a toasts folder. Here you can create your own toast types. You can call them by

Toast::custom('Toast Title', 'Your Message', 'your-type');

'your-type' must be identical with your custom toast template name.

You can customize the design of the toasts by adding css. If you want to use the default styles, you just have to publish the css by

php artisan vendor:publish --provider="FelixL7\Toast\ToastServiceProvider" --tag=public

Validation Error Toast

If you want to use Toasts in your custom FormRequest you just need to ad this method:

/**
    * Handle a failed validation attempt.
    *
    * @param  \Illuminate\Contracts\Validation\Validator  $validator
    * @return void
    *
    * @throws \Illuminate\Http\Exceptions\HttpResponseException
    */
protected function failedValidation(Validator $validator)
{
    throw new HttpResponseException(
        redirect()->back()
        ->withInput($this->except($this->dontFlash))
        ->withErrors($validator)
        ->with('bootstrap-toasts', [Toast::error('Validation Error', 'The validation of your input failed. Please checkout the validation messages.')])
    );
}

Contact

Any Questions or improvement suggestions? Contact me! info@felixlipinski.de

felixl7 / laravel-bootstrap-toast

Maintainers

Details