manuelgeek/laravel-btoast

A bootstrap 4 toast wrapper for Laravel

v1.3 2019-12-03 13:19 UTC

Requires

• illuminate/support: >=5

Requires (Dev)

• mockery/mockery: ^1.1
• orchestra/testbench: ~3.0
• phpunit/phpunit: >=7.0
• sempro/phpunit-pretty-print: ^1.0

MIT

• Manuel Geek

• bootstrap
• notification
• laravel
• toast
• laravel-btoast

README

This is where your description should go. Take a look at contributing.md to see a to do list.

Installation

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.

Configuration

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

];

Usage

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.

Message

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

Info

BToast::info('message', 'title', 'subtitle');
btoast()->info('message', 'title', 'subtitle');

Success

BToast::success('message', 'title', 'subtitle');
btoast()->success('message', 'title', 'subtitle');

Error

BToast::error('message', 'title', 'subtitle');
btoast()->error('message', 'title', 'subtitle');

Warning

BToast::warning('message', 'title', 'subtitle');
btoast()->warning('message', 'title', 'subtitle');

Light

BToast::light('message', 'title', 'subtitle');
btoast()->light('message', 'title', 'subtitle');

Dark

BToast::dark('message', 'title', 'subtitle');
btoast()->dark('message', 'title', 'subtitle');

Secondary

BToast::secondary('message', 'title', 'subtitle');
btoast()->secondary('message', 'title', 'subtitle');

Clear

BToast::clear();
btoast()->clear();

Change log

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• ManuEl Geek

License

MIT. Please see the license file for more information.