README

This package provides an easy interface for using Bootstrap 5.2+ toast messages in a Laravel app.

Installation

You can install the package via composer:

composer require retinens/laravel-toastr

You can publish the config file with:

php artisan vendor:publish --tag="laravel-toastr-config"

This is the contents of the published config file:

return [
    /*
     * Defines the default auto_hide parameter
     */
    'auto_hide' => false,

    /*
     * Defines the position of the toast on the window
     */

    // "top" or "bottom"
    "position_y" => 'bottom',
    // "start" or "end"
    "position_x" => 'end',
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-toastr-views"

Usage

Bootstrap should be imported in your assets and available in the window variable.

window.bootstrap = require("bootstrap");

First, include this snippet in your Blade template

<x-boostrap-toastr/>

Then, in your controller, call the toast() method to create a toast message.

public function edit()
{
    toast('Post edited!');
    return redirect(route('posts.list'));
}

The toast method accepts the title and level as optional arguments :

toast('message','level','title')

There are a few quick methods to modify the toast:

toast('Message')->success(): Set the toast level as "success".
toast('Message')->info(): Set the toast level as "info".
toast('Message')->error(): Set the toast level as "danger".
toast('Message')->warning(): Set the toast level as "warning".
toast('Message')->title("Toast title"): Set the toast title.
toast('Message')->important(): Add a close button to the toast.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

retinens / laravel-bootstrap-toasts

Maintainers

Details