search

serg472 / jquery-loadmask

jQuery plugin to mask DOM elements during loading
Other
3 stars 2 forks source link

readme

LoadMask jQuery plugin can mask DOM elements while their content is loading or changing to prevent user interactions and inform that some background task is still running. It is very light (~2Kb) and easy to use.

The behavior of this plugin is largely based on handy Element.mask() method from ExtJS Framework.

Demo

Usage

jQuery version required: 1.2.3 or later.

Please note that only elements that accept child nodes can be masked.

To start using the plugin you need to include jquery.loadmask.css and jquery.loadmask.js (or its minified version jquery.loadmask.min.js) to your html page:

<link href="https://github.com/serg472/jquery-loadmask/blob/master/jquery.loadmask.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="https://github.com/serg472/jquery-loadmask/raw/master/jquery.loadmask.min.js"></script>

Masking

To put a mask over an element (or multiple elements) simply call mask(label, delay) method with two optional label and delay parameters:

$("#mydiv").mask("Loading...");
$(".grids").mask("Loading...", 500);

If label parameter is provided, a little box with this label and a spinner will be placed on top of the mask, otherwise only a transparent gray mask is displayed.

delay parameter sets a delay in milliseconds before element(s) is masked. If unmask() is called before the delay times out, no mask is displayed. This can be used to prevent unnecessary mask display for quick processes.

Unmasking

To remove a previously displayed mask from an element (or multiple elements) call unmask() without any parameters:

$("#mydiv").unmask();

Calling unmask() on a delayed mask prevents it from showing up.

Checking if an element is masked

You can use isMasked() method on a single element to check if it is currently masked. Please note that this method will return false while mask is delayed.

if($("#mydiv").isMasked()) { ... }

Integration with ASP.net UpdatePanel

Please take a look at this code.

Integration with Jquery UI

Please take a look at this code.

Contributors