Mojolicious::Plugin::Notifications::Alertify - Event notifications using Alertify.js
# Register the engine plugin Notifications => { Alertify => { base_class => 'bootstrap' } }; # In the template %= notifications 'Alertify'
This plugin is a notification engine using Alertify.js.
If this does not suit your needs, you can easily write your own engine.
Mojolicious::Plugin::Notifications::Alertify inherits all methods from Mojolicious::Plugin::Notifications::Engine and implements or overrides the following.
plugin Notifications => { Alertify => { base_class => 'bootstrap' } };
Called when registering the main plugin. All parameters under the key Alertify are passed to the registration.
Alertify
Accepts the following parameters:
The theme for all alertify notifications. Defaults to bootstrap. See the Alertify.js documentation for more information on themes.
bootstrap
The base timeout for all alertify notifications. Defaults to 5000 ms. Set to 0 for no timeout.
5000 ms
0
# In controllers $c->notify(warn => 'Something went wrong'); $c->notify(success => { timeout => 2000 } => 'Everything went fine');
Notify the user on certain events.
See the documentation for your chosen theme at Alertify.js to see, which notification types are presupported.
In addition to types and messages, the timeout can be defined in a hash reference.
# In templates %= notifications 'alertify'; %= notifications 'alertify', 'bootstrap', -no_include, -no_css
Include alertify notifications in your template.
If you want to use a class different to the defined base class, you can pass this as a string attribute.
If you don't want to include the javascript and css assets for Alertify.js, append -no_include. If you just don't want to render the stylesheet tag for the inclusion of the CSS, append -no_css.
Alertify.js
-no_include
-no_css
All notifications are also rendered in a <noscript /> tag, following the notation described in the HTML engine.
<noscript />
Alertify.js.
https://github.com/Akron/Mojolicious-Plugin-Notifications
Copyright (C) 2014-2015, Nils Diewald.
This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.
Copyright (c) Fabien Doiron
See https://github.com/fabien-d/alertify.js for further information.
Licensed under the terms of the MIT License.
To install Mojolicious::Plugin::Notifications, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mojolicious::Plugin::Notifications
CPAN shell
perl -MCPAN -e shell install Mojolicious::Plugin::Notifications
For more information on module installation, please visit the detailed CPAN module installation guide.