django-messages-ui 0.2.6

JS and HTML to support the Django contrib.messages app

jQuery messages-UI plugin package for Django

django-messages-ui adds JS and HTML to support the Django contrib.messages app. It should be called on the message list element, and accepts options for message selectors, transient messages (that disappear on click or key-press), and close-links.

Messages can be dynamically added via Handlebars.js or ICanHaz.js, and there’s a Python middleware to automatically add messages from the request into Ajax JSON responses.

Dependencies

• jQuery library

• jQuery doTimeout plugin

• (optionally) handlebars.runtime.js 1.0.0

• (optionally) ICanHaz.js

• (optionally) django-icanhaz 0.2.0+

Installation

In your Django project settings, add “messages_ui” to your INSTALLED_APPS.

Usage

Linking the JS:

<script src="{{ STATIC_URL }}messages_ui/jquery.messages-ui.js"></script>

If using handlebars.runtime.js, also include the compiled JS template:

<script src="{{ STATIC_URL }}messages_ui/message.js"></script>

Including the default HTML Template:

{% include "messages_ui/_messages.html" %}

If using ICanHaz.js, use this template instead:

{% include "messages_ui/_messages_ich.html" %}

Calling the plugin:

$('#messages').messages();

Calling the plugin with a variety of options explicitly configured to their default values:

$('#messages').messages({
    message: '.message',          // Selector for individual messages
    closeLink: '.close',          // Selector for link to close message
                                  //  ...set to ``false`` to disable
    closeCallback:                // Fn called when closeLink is clicked
        function (el) {
            el.stop().fadeOut('fast', function () {
                el.remove();
            });
        },
    transientMessage: '.success', // Selector for transient messages
    transientDelay: 500,          // Transient message callback delay (ms)
    transientCallback:            // Fn called after transientDelay
        function (el) {
            el.fadeOut(2000, function () { el.remove(); });
        },
    handleAjax: false,            // Enable automatic AJAX handling
    templating: 'handlebars',     // JS templating engine
                                  //  ...set to ``ich`` for ICanHaz.js
                                  //  ...only used if ``handleAjax: true``
    escapeHTML: true              // Set ``false`` to display unescaped
                                  // HTML in message content
});

Note: After the plugin is called once, subsequent calls on the same element will default to the options passed the first time, unless new options are explicitly provided.

Adding a message in JS:

$('#messages').messages('add', {message: "Sample Message", tags: "info"});

Adding a message with unescaped HTML in JS:

$('#messages').messages('add', {message: "<a href='/'>Sample Message</a>", tags: "info"}, {escapeHTML: false});

To override the default JS template with handlebars.runtime.js, link to your own message.html template in a precompiled JS file.

To override the default JS template with ICanHaz.js, add a message.html file to a directory listed in your ICANHAZ_DIRS setting (a django-icanhaz setting).

Ajax

To enable automatic handling of messages from Ajax requests, add "messages_ui.middleware.AjaxMessagesMiddleware" to your MIDDLEWARE_CLASSES setting (directly after django.contrib.messages.middleware.MessageMiddleware), and pass handleAjax: true to the plugin initialization.

Warning

AjaxMessagesMiddleware converts all HTML AJAX responses into JSON responses with a messages key, and the HTML embedded in an html key. If your site uses HTML AJAX responses, this will likely require updates to other Ajax-handling code in your site. To avoid this for a particular response, set the attribute no_messages on that response to True before it passes through AjaxMessagesMiddleware.

Similarly, handleAjax: true globally sets the default expected dataType for AJAX requests to "json".

CHANGES

0.2.6 (2013.06.05)

• Fix AjaxMessagesMiddleware encoding issue with Python 3 and JSON response.

• Precompile Handlebars template with 1.0.0.

0.2.5 (2013.05.23)

• Precompile Handlebars template with 1.0.0-rc.4.

• Make AjaxMessagesMiddleware Py3-compatible.

0.2.4 (2013.01.28)

• Add option for function called after closeLink is clicked.

0.2.3 (2013.01.24)

• Add option for function called on transient messages after transientDelay.

0.2.2 (2013.01.21)

• Add response.no_messages option for disabling middleware.

0.2.1 (2013.01.14)

• Rewrite using method plugin architecture; simpler ‘add’ method to add msg.

• Add option to display unescaped HTML in message content.

0.2.0 (2013.01.11)

• Add option to use Handlebars.js (new default) instead of ICanHaz.js.

0.1.8 (2013.01.03)

• Make close-link selector specific to within a message; use preventDefault.

0.1.7 (2012.11.06)

• JS stop transient-message fade on close-link click.

0.1.6 (2012.10.05)

• JS don’t parse non-json.

0.1.5 (2012.07.23)

• Don’t touch non-200 responses.

0.1.4 (2011.07.14)

• JS cleanup; added JSLint options.

0.1.3 (2011.06.28)

• Added closeLink: false plugin option.

• Subsequent plugin calls on the same element default to previous options unless explicitly overridden.

0.1.2 (2011.06.27)

• Added AjaxMessagesMiddleware and handleAjax plugin option.

0.1.1 (2011.06.27)

• Updated HTML template (removed <aside> and moved #messages to <ul>).

0.1.0 (2011.06.25)

• Initial release.

TODO