shifrin/yii2-noty

Yii widget for Noty jQuery notification plugin

yii2-noty

Yii2 widget for Noty jQuery notification plugin, Visit Noty, _(*1)

For Yii1: Please check yii-noty, _(*2)

Installation:

The preferred way to install this extension is through composer, _(*3)

Note: The instructions below refer to the global composer installation. You might need to replace composer with php composer.phar (or similar) for your setup., _(*4)

Direct install:, _(*5)

composer require shifrin/yii2-noty

or add it manually to the composer.json and update composer, _(*6)

"shifrin/yii2-noty": "1.0.*",

``` composer update, <sub>(*7)</sub>

## Usage Details:
Add the widget in your main layout file like below,
```php
<?php \shifrin\noty\NotyWidget::widget([
    'options' => [ // you can add js options here, see noty plugin page for available options
        'dismissQueue' => true,
        'layout' => 'topCenter',
        'theme' => 'relax',
        'animation' => [
            'open' => 'animated flipInX',
            'close' => 'animated flipOutX',
        ],
        'timeout' => false,
    ],
    'enableSessionFlash' => true,
    'enableIcon' => true,
    'registerAnimateCss' => true,
    'registerButtonsCss' => true,
    'registerFontAwesomeCss' => true,
]); ?>

This widget will create a JS function Noty(), so it will be available globally and you can call this function in your custom JS codes. See the following example below, <sub>(*8)</sub>

var n = Noty('id');
$.noty.setText(n.options.id, 'Welcome to our site!');
$.noty.setType(n.options.id, 'information');

You can set the flash messages like this in your controller or anywhere you need. However, if you set enableSessionFlash to false it won't be affected., <sub>(*9)</sub>

\Yii::$app->session->setFlash('type', 'Message here');

Replace type with available types, <sub>(*10)</sub>

Available Types:

• success
• error
• warning
• information
• alert