Downloads
Stars
Version
This is where your description should go. Take a look at contributing.md to see a to do list.
1. Via Composer
composer require manuelgeek/laravel-btoast
2. Optional, below Laravel 5.5: Add 'Manuelgeek\LaravelBtoast\BToastServiceProvider'
to providers
in config/app.php
, and add 'BToast' => 'Manuelgeek\LaravelBtoast\Facades\BToast'
to aliases
in config/app.php
.
// config/app.php
'providers' => array(
// ...
'Manuelgeek\LaravelBtoast\BToastServiceProvider',
),
// ...
'aliases' => array(
// ...
'BToast' => 'Manuelgeek\LaravelBtoast\Facades\BToast',
),
3. Include @include('btoast::messages')
in your layout template.
4. Optional: Run php artisan vendor:publish --provider="Manuelgeek\LaravelBtoast\BToastServiceProvider" --tag="config"
to publish the config file.
5. Optional: Modify the published configuration file located at config/laravel-btoast.php
to your preference.
6. Optional: Run php artisan vendor:publish --provider="Manuelgeek\LaravelBtoast\BToastServiceProvider" --tag="views"
to publish the views.
7. Optional: Modify the published views located at resources/views/vendor/btoast
to your preference.
Open config/laravel-btoast.php
to adjust package configuration. If this file doesn't exist, run php artisan vendor:publish --provider="Manuelgeek\LaravelBtoast\BToastServiceProvider" --tag="config"
to create the default configuration file.
return [
'animation' => false,
'autohide' => true,
'delay' => 4000,
'position' => 'top-right', // top-left, bottom-right, bottom-left, center,bottom-center, top-center
];
Use the BToast facade (BToast::
) or the helper function (btoast()->
) to access the methods in this package. You can also chain multiple messages together using method chaining: btoast()->success('test')->info('user')
. The title
and subtitle
arguments is optional.
BToast::message('message', 'level', 'title');
toast()->message('message', 'level', 'title');
toast('message', 'title');
Add a toast to the session. Using btoast('message')
will use the default level.
Levels include info
, success
, error
, warning
, dark
, light
, secondary
BToast::info('message', 'title', 'subtitle');
btoast()->info('message', 'title', 'subtitle');
BToast::success('message', 'title', 'subtitle');
btoast()->success('message', 'title', 'subtitle');
BToast::error('message', 'title', 'subtitle');
btoast()->error('message', 'title', 'subtitle');
BToast::warning('message', 'title', 'subtitle');
btoast()->warning('message', 'title', 'subtitle');
BToast::light('message', 'title', 'subtitle');
btoast()->light('message', 'title', 'subtitle');
BToast::dark('message', 'title', 'subtitle');
btoast()->dark('message', 'title', 'subtitle');
BToast::secondary('message', 'title', 'subtitle');
btoast()->secondary('message', 'title', 'subtitle');
BToast::clear();
btoast()->clear();
Please see the changelog for more information on what has changed recently.
Please see contributing.md for details and a todolist.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
MIT. Please see the license file for more information.