yii2-pnotify-widget

Wrapper around PNotify, a JavaScript notifications plugin for Bootstrap and jQuery UI., _(*1)

Check out the PNotify Website for a demo of the Plugin., _(*2)

important : please note that this widget only includes the basic PNotify modules : desktop and buttons, _(*3)

Installation

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

Either run, _(*5)

php composer.phar require --prefer-dist raoul2000/yii2-pnotify-widget "*"

or add, _(*6)

"raoul2000/yii2-pnotify-widget": "*"

to the require section of your composer.json file., _(*7)

Usage

Once the extension is installed, simply use it in your code like this :, _(*8)

<?php 
    \raoul2000\widget\pnotify\PNotify::widget([
        'pluginOptions' => [
            'title' => 'My Notification',
            'text' => 'this is my \'first\' Notification using <b>PNotify</b>.',
        ]
    ]);
?>

Stacks

This widget includes an easy way of creating and using custom stacks that will drive the way PNotify displays notification messages., _(*9)

To know more about PNotify Stacks, please refer to the documentation., _(*10)

Defining a stack with the widget is easy. The example below defines a stack that will display notification vertically in the top-left corner. Then, use this stack (called "stack_top_left") to display a notification. The CSS class stack-topleft is part of the built-in CSS classes provided by PNotify., _(*11)

<?php 

    // define "stack_top_left' stack

    \raoul2000\widget\pnotify\PNotify::registerStack( 
        [
            'stack_top_left' => [
                'dir1' => 'right',
                'dir2' => 'right',
                'push' => 'top'
            ]
        ],
        $this
    );

    // display a notification using the "stack_top_left" stack.
    // Note that you must use yii\web\JsExpression for the "stack" plugin option value. 

    \raoul2000\widget\pnotify\PNotify::widget([
        'pluginOptions' => [
            'title' => 'Information',
            'text' => 'This is a very intresting information message : read it !',
            'type' => 'info',
            'stack' => new yii\web\JsExpression('stack_top_left'),
            'addclass' => 'stack-topleft',
            'desktop' => [
                'desktop' => true
            ],
            'buttons' => [
                'closer_hover' => false
            ]
        ]
    ]); 

?>

As you may have noted, the widget above defines specific settings for the desktop and buttons modules., _(*12)

For more information on the plugin options, please refer to PNotify@github., _(*13)