django-messages-ui 0.1.7

Dependencies

• jQuery library

• jQuery doTimeout plugin

• (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>

Including the default HTML Template:

{% include "messages_ui/_messages.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
    transientMessage: '.success', // Selector for transient messages
    transientDelay: 500,          // Transient message fade delay (ms)
    transientFadeSpeed: 3000,     // Transient message fade speed (ms)
    handleAjax: false             // Enable automatic AJAX handling
});

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 (requires ICanHaz.js):

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

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

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.