Skip to content
jQuery Loading Overlay Plugin
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Layout demo code samples vertically. Apr 21, 2014
dist
libs Update libs and grunt plugins. Feb 19, 2014
src Update js code styleguide. Feb 19, 2014
test
.gitignore
.jshintrc
.travis.yml
CONTRIBUTING.md initial 1.0.0 release Oct 11, 2013
Gruntfile.js initial 1.0.0 release Oct 11, 2013
LICENSE-MIT initial 1.0.0 release Oct 11, 2013
README.md Add .travis.yml. Apr 14, 2014
bower.json Bump version to 1.0.2 Feb 19, 2014
loading-overlay.jquery.json
package.json expand package.json Jun 29, 2015

README.md

Loading Overlay

Build Status Built with Grunt

jQuery Loading Overlay Plugin

Uses Javascript to add/remove a loading overlay to a target element. It can be called on any element that should receive the loading overlay, and accepts options for class selectors and loading overlay text. The overlay itself must be styled via CSS.

Getting Started

Download the production version or the development version.

In your web page:

<script src="jquery.js"></script>
<script src="dist/loading-overlay.min.js"></script>
<script>
jQuery(function($) {
  // Calling the plugin
  // (prepends a div.loading to the target element)
  $('#target').loadingOverlay();

  // Removing the loading overlay
  $('#target').loadingOverlay('remove');
});
</script>

Demo

See a working example of the loading-overlay in action, both with and without CSS styling.

Documentation

Available options, explictly set to their defaults:

$('#target').loadingOverlay({
  loadingClass: 'loading',          // Class added to target while loading
  overlayClass: 'loading-overlay',  // Class added to overlay (style with CSS)
  spinnerClass: 'loading-spinner',  // Class added to loading overlay spinner
  iconClass: 'loading-icon',        // Class added to loading overlay spinner
  textClass: 'loading-text',        // Class added to loading overlay spinner
  loadingText: 'loading'            // Text within loading overlay
});

NOTE: 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: 'loading',
  overlayClass: 'loading-overlay'
});

Release History

  • 1.0.2 - (02/19/2014) Add bower.json
  • 1.0.1 - (10/13/2013) Don't allow duplicate loading-overlays
  • 1.0.0 - (10/11/2013) Initial release
You can’t perform that action at this time.