Submit your widget

jquery-plainoverlay - The simple jQuery Plugin for customizable overlay which covers a page, elements or iframe-windows that is specified.

Created 5 years ago   Views 2231   downloads 905    Author anseki
View DemoDownload
Share |


The simple jQuery Plugin for customizable overlay which covers a page, elements or iframe-windows that is specified. plainOverlay has basic functions only, and it has no image files and no CSS files. Just one small file (9KB minified).


This is used for making users wait until the your application is ready.
The elements under the overlay don't accept access via mouse or keyboard. And scrollable element (e.g. <body>, <div style="overflow:scroll"> or <iframe>) which is specified can't scroll.
Your progress-element (messages or images that means "Please wait...") can be shown to users on the overlay. You can free style it to perfect match for your web site. Or plainOverlay has a simple builtin progress-element.

plainOverlay do:

  • Covering a page, elements or iframe-windows that is specified with the overlay.
  • Avoiding focusing elements under the overlay. (by pressing Tab key)
  • Avoiding scrolling a page, elements or iframe-windows that is specified.
// Cover an element with overlay. 
// Hide overlay. 
// Cover all of a page. 
$('body').plainOverlay('show'); // Or, $(document), $(window) 

Load after jQuery.

<script src="jquery-1.11.0.min.js"></script>
<script src="jquery.plainoverlay.min.js"></script>


element.plainOverlay('show'[, options])

Cover specified element with the overlay. This element may be <body>, <iframe> or box-element like <div>. $(document) and $(window) are same as $('body').
If options (see Options) is specified, element is initialized with specified options before the overlay is shown. If element is not initialized yet, element is initialized even if options is not specified.
An element can be initialized by new options any number of times.



Hide the overlay.



Initialize specified element. (preparation the overlay)
The Show method can initialize too. This is used to initialize without showing the overlay at voluntary time.
You can specify options to every Show method. But, if options of an element isn't changed, re-initializing it isn't needed. Then, you specify options to only first Show method, or use this method for initializing it only once.
If you don't customize Options (using default all), this method isn't needed because options isn't specified to Show method, and element is initialized at only first time.

In this code, unneeded initializing is done again, again, and again.

$('#show-button').click(function() {
  // Same initializing per every showing 
  $('#list').plainOverlay('show', {duration: 500});

In this code, initializing is done at once.

// Initialize without showing 
var list = $('#list').plainOverlay({duration: 500});
$('#show-button').click(function() {
  // Show without initializing 

In this code, initializing is done at once.

$('#show-button').click(function() {
  // Initializing is done at only first time 


An options Object can be specified to Show method or Initialize method. This Object can have following properties.

Type: Number
Default: 200

A number determining how long (milliseconds) the effect animation for showing and hiding the overlay will run.

Type: String
Default: '#888'

A fill-color of the overlay.

$('#list').plainOverlay({fillColor: 'red'});

color is an alias for fillColor.

Type: Number
Default: 0.6

A number in the range 0.0 (invisible) to 1.0 (solid).

$('#list').plainOverlay({opacity: 0.3});

If you want to style the overlay more, add style to plainoverlay class.

.plainoverlay {
  background-image: url('bg.png');

Type: Function or Boolean
Default: Builtin Element

The jQuery-Element that is returned by specified Function is shown to user as progress-element on the overlay. This is usually messages or images that means "Please wait...".
If false is specified, nothing is shown on the overlay.
The builtin element (default) is shown via CSS Animations in modern browsers (e.g. Firefox, Chrome, etc.), and it is shown via simple effect in legacy browsers (IE9, IE8, etc.). This choice is automatic.

  progressfunction() { return $('<div>I am busy...</div>'); }

Of course your image files, some CSS codes which are distributed free in the internet, or any elements can be used. (e.g. SVG Animations jxnblk/loading)

If you want to change the color of shapes in builtin progress-element, use CSS below.

/* Change to red */
.jQuery-plainOverlay-progress {
  border-color: red !important;
.jQuery-plainOverlay-progress-legacy div {
  background-color: red !important;

Type: Number
Default: 9000

A z-index CSS property of the overlay.

Type: Function

A plainoverlayshow event handler. This is convenient way to do on('plainoverlayshow', handler) method. (see Events)

$('#form1').plainOverlay({showfunction(event) { console.log(event); } });

NOTE: If this option is specified in the Show method, declared Function or the variable the Function is assigned should be specified (Don't specify the function expression). Because the Show method may be called again, and the function expression generates the new Function every time.
The "function statement" and the "function operator" are different.
For example: this code is OK.

function handler(event) { console.log(event); }
$('#show-button').click(function() {
  $('#form1').plainOverlay('show', {show: handler});

This code registers event handler repeatedly when the Show method is called.

$('#show-button').click(function() {
  $('#form1').plainOverlay('show', {showfunction(event) { console.log(event); } });

Type: Function

A plainoverlayhide event handler. This is convenient way to do on('plainoverlayhide', handler) method. (see Events)

$('#form1').plainOverlay({hidefunction(event) { console.log(event); } });

NOTE: See "NOTE" in show option.


Triggered when the overlay is shown. (after the fading effect took duration to complete.)
An event handler can be attached when initializing too via (see Options)

$('#form1').on('plainoverlayshow', function(event) {
  $('#loading', + '%');

Triggered when the overlay is hidden. (after the fading effect took duration to complete.)
An event handler can be attached when initializing too via options.hide. (see Options)

$('#form1').on('plainoverlayhide', function(event) {
  • If target is <iframe> element, jQuery 1.10.3+ or 2.0.4+ must be used. (see #14180: focusin/out special events don't work cross-window)
  • As everyone knows, IE8- has many problems. CSS position:fixed in HTML without <!DOCTYPE> is ignored.
    If your web site supports IE8- and it use position:fixed, HTML must include <!DOCTYPE> even if plainOverlay is not used. And plainOverlay uses position:fixed.
  • plainoverlayshow and plainoverlayhide events bubble up the DOM hierarchy.

plainModal may be better, if you want the overlay and dialog box (i.e. modal windows).

  • 2014-11-02 v0.5.6 Fix: touch devices scroll the window.
  • 2014-09-15 v0.5.4 Fix: The event handler by initialize is registered repeatedly.
  • 2014-07-18 v0.5.0 Rename options.color to options.fillColor.
  • 2014-06-30 v0.4.0 Add plainoverlay class.
  • 2014-04-23 v0.3.0 Add custom events plainoverlayshow and plainoverlayhide
  • 2014-04-08 v0.2.1 Thicken overlay as default. (color, opacity)
  • 2014-03-10 v0.2.0 Add options.zIndex
  • 2014-02-14 v0.1.0 Initial release.