django-ajax-loading-overlay

django-ajax-loading-overy uses JavaScript to add/remove a loading overlay to a target element during Ajax calls. It can be called on any element that should receive the loading overlay, and accepts options for class selectors and loading overlay text.

Installation

In your Django project settings, add "ajax_loading_overlay" to your INSTALLED_APPS.

Usage

Linking the JS:

< script src="{{ STATIC_URL }}ajax_loading_overlay/jquery.ajax-loading-overlay.js" >< /script >

Calling the plugin:

$('#target').loadingOverlay();

Removing the loading overlay (usually upon success of the Ajax call):

$('#target').loadingOverlay('remove');

Options can be passed to override the default loading class ('loading'), overlay class ('overlay'), and/or loading text('loading...'):

$('#target').loadingOverlay({
 loadingClass: 'myLoadingClass',
 overlayClass: 'myOverlayClass',
 loadingText: 'Loading. Please Wait.'
});

If options are passed when initializing the loading overlay, the same options must be passed when removing that overlay (though loadingText is not used by the remove method):

$('#target').loadingOverlay('remove', {
 loadingClass: 'myLoadingClass',
 overlayClass: 'myOverlayClass'
});

What is new in this release:

• Added paddingTop option for overlay text.

What is new in version 0.1.1:

• JS cleanup; added JSLint options.

Requirements:

• Python
• jQuery
• Django