yii2bs4/yii2-bootstrap4-notify

Alert widget based on Bootstrap Notify extension {@link http://bootstrap-notify.remabledesigns.com/)

dev-master 2019-10-08 19:39 UTC

This package is auto-updated.

Last update: 2024-05-09 05:45:37 UTC


README

993323

Yii2 Notify Widget


Notify widget based on Bootstrap Notify

Latest Stable Version Total Downloads License

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require yii2bs4/yii2-bootstrap4-notify "@dev"

or add

"yii2bs4/yii2-bootstrap4-notify": "@dev"

to the require section of your composer.json.

Usage

Alert widget renders a message from session flash. All flash messages are displayed in the sequence they were assigned using setFlash. You can set message as following:

  1. Set the message in your action, for example:
Yii::$app->session->setFlash('success', 'This is the message');
Yii::$app->session->setFlash('info', 'Your message');
Yii::$app->session->setFlash('warning', 'Your message');
Yii::$app->session->setFlash('error', 'Your message');

Also, you can set multiple messages as follows:

Yii::$app->session->setFlash('error', ['Error 1', 'Error 2']);
  1. Simply add widget to your layout as follows:
<?php echo \yii2bs4\notify\BootstrapNotify::widget(); ?>

You can render your own message without the session flash as following:

<?php echo \yii2bs4\notify\BootstrapNotify::widget([
    'useSessionFlash' => false,
    'options' => [
        'message' => 'Your message',
    ],
    'clientOptions' => [
        'type' => \yii2bs4\notify\BootstrapNotify::TYPE_SUCCESS,
        'showProgressbar' => true
    ]
]); ?>

Alert Options

You can find them on the options page