Skip to main content

Uses JS to add/remove a loading overlay during Ajax calls

Project description

jQuery Ajax Loading Overlay plugin package for Django

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.

Dependencies

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’), loading text(‘loading…’), and/or function to return loading text padding-top:

$('#target').loadingOverlay({
    loadingClass: 'myLoadingClass',
    overlayClass: 'myOverlayClass',
    loadingText: 'Loading. Please Wait.',
    paddingTop: function (target) {
        return ((target.outerHeight() - parseInt(target.css('line-height'), 10)) / 2).toString() + 'px';
    }
});

If loadingClass or overlayClass options are passed when initializing the loading overlay, the same options must be passed when removing that overlay:

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

CHANGES

0.1.2 (2012.07.24)

  • Added paddingTop option for overlay text.

0.1.1 (2011.07.14)

  • JS cleanup; added JSLint options.

0.1.0 (2011.06.26)

  • Initial release.

TODO

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-ajax-loading-overlay, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size django-ajax-loading-overlay-0.1.2.tar.gz (4.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page