Unveil .js A very lightweight plugin to lazy load images for jQuery or Zepto.js Tweet

Most of us are familiar with the Lazy Load plugin by Mika Tuupola.

This plugin is very useful and it boosts performance delaying loading of images in long web pages because images outside of viewport (visible part of web page) won't be loaded until the user scrolls to them.

Lazy Load has some cool options such as custom effects, container, events or data attribute. If you're not gonna use any of them you can reduce the file size by leaving just the essential code to show the images.

That's what I did and this is my lightweight version of Lazy Load with support for serving high-resolution images to devices with retina displays - less than 1k.

Usage

Use a placeholder image in the src attribute - something to be displayed while the original image loads - and include the actual image source in a "data-src" attribute.

If you want to serve high-resolution images to devices with retina displays, you just have to include the source for those images in a "data-src-retina" attribute.

You don't need to include a "data-src-retina" attribute in all the image tags, unveil is smart enough to fallback to "data-src" or even do nothing in case there isn't any "data-src" specified.

<img src= "bg.png" data-src= "img1.jpg" />

<img src= "bg.png" data-src= "img2.jpg" data-src-retina= "img2-retina.jpg" />

If you care about users without javascript enabled, you can include the original image inside a <noscript> tag:

<noscript>

<img src= "img1.jpg" />

</noscript>

Run the script on document ready:

$( document ).ready( function () {

$( "img" ).unveil();

});

Threshold

By default, images are only loaded and "unveiled" when the user scrolls to them and they became visible on the screen.

If you want your images to load earlier than that, lets say 200px before they appear on the screen, you just have to:

$( "img" ).unveil( 200 );

Callback

As a second parameter you can also specify a callback function that will fire after an image has been "unveiled".

Inside the callback function this refers to the image's DOM node, so with the help of CSS3 (or jQuery animations) and by attaching a simple load event you can easily add some fancy entrance animation to your images:

img {

opacity: 0;

transition: opacity .3s ease-in;

}

$( "img" ).unveil( 200 , function () {

$(this).load( function () {

this.style.opacity = 1;

});

});

Trigger

You can still trigger image loading whenever you need.

All you have to do is select the images you want to "unveil" and trigger the event:

$( "img" ).trigger( "unveil" );

Lookup

It is also possible to lookup for images in the viewport that haven't been "unveiled" yet.

This can be useful, for instance, in case of a tabbed layout.

$( window ).trigger( "lookup" );

Cancel

You can remove all the "unveil" event handlers from "window":

$( window ).off( "unveil" );

Demo

If you're on a "normal" display, unveil will load the low resolution version (800x500). In case you're on a device with a retina display, the high resolution version (1280x800 in this case) will be loaded instead.

Scroll down to see it working - placeholder images from lorempixel.





















Browser support

Compatible with All Browsers and IE7+.

Download

Download the script from the project page on GitHub.

If you have any suggestion or bug to report please use github issues or get it touch with me on twitter - @lmgalmeida.

License

Unveil is licensed under the MIT license.