django-ajax-loading-overlay 0.1.0

Dependencies

• jQuery library (http://jquery.com/)

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'
});