NAME

Mojolicious::Plugin::Notifications::HTML - Event Notifications using HTML

SYNOPSIS

# Register the engine
plugin Notifications => {
  HTML => 1
};

# In the template
%= notifications 'html'

DESCRIPTION

This plugin is a simple notification engine for HTML.

If it does not suit your needs, you can easily write your own engine.

HELPERS

notify

See the base notify helper.

notifications

$c->notify(warn => 'wrong');
$c->notify(success => 'right');

%= notifications 'html';
# <div class="notify notify-warn">wrong</div>
# <div class="notify notify-success">right</div>

Will render each notification using notify_html.

EXPORTABLE FUNCTIONS

notify_html

use Mojolicious::Plugin::Notifications::HTML qw/notify_html/;

notify_html(warn => 'This is a warning')
# <div class="notify notify-warn">This is a warning</div>

notify_html(announce => {
  ok => 'http://example.com/ok',
  ok_label => 'Okay!'
# }, 'Confirm, please!')
# <div class="notify notify-announce">
#   Confirm, please!
#   <form action="http://example.com/ok" method="post">
#     <button>Okay!</button>
#   </form>
# </div>

Returns the formatted text in a <div /> element with the class notify and the class notify-$type, where $type is the notification type you passed. In case an ok parameter is passed, this will add a POST form for confirmation. In case an ok_label is passed, this will be the label for the confirmation button. In case a cancel parameter is passed, this will add a POST form for cancelation. In case a cancel_label is passed, this will be the label for the cancelation button.

If the first parameter is a Mojolicious::Controller object, the button will have a csrf_token parameter to validate.

This is meant to be used by other engines as a fallback.

Confirmation is EXPERIMENTAL!

AVAILABILITY

https://github.com/Akron/Mojolicious-Plugin-Notifications

COPYRIGHT AND LICENSE

Copyright (C) 2014-2018, 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.