README

This package provides an easy interface for using Toastr.js messages in your 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

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

For example, in your app.js file:

import * as toastr from 'toastr'
window.toastr = toastr

@import '~toastr/build/toastr.scss';

Include the component in your blade base template, after all the scripts.

<x-toastr/>

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

public function update()
{
    //do stuff
    toastr('Post edited!');
    return redirect(route('posts.index'));
}

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

toastr('message','level','title')

There are a few quick methods to modify the toast:

toastr()->success('Message'): Set the toast level as "success".
toastr()->info('Message'): Set the toast level as "info".
toastr()->error('Message'): Set the toast level as "danger".
toastr()->warning('Message'): Set the toast level as "warning".
toastr()->title('Message',"Toast title"): Set the toast title.

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-toastr

Maintainers

Details