Recliner.js
Recliner is a super lightweight (1KB) jQuery plugin for lazy loading images, iframes and other dynamic (AJAX) content. Being lazy never felt so good, just hook it up, and start sippin' those margaritas!
The script was born out of necessity when one of our clients came to us with massive scroll lag on one of their media heavy mobile news sites. It turned out that lazy-load-xt
was the culprit, so naturally we tested the other lazy load scripts out there but none of them met our simple criteria:
- Lightweight
- Sets stateful CSS classes on elements
- Ability to override event callbacks for custom behaviour
- Can load any dynamic content (images, iframes, AJAX)
- Mobile friendly
- Printer friendly
Recliner is currently used on some very high traffic sites, so it's well tested and production ready.
Demo
For more information and a live demo see the project page: http://sourcey.com/recliner
Installation
If you use bower
then type:
bower install recliner
Or if you like using npm
then go ahead and type:
npm install jquery-recliner
Otherwise, just download recliner.min.js
and stick it in your assets folder :)
Usage
Add jQuery (2.x or 1.x) and Recliner to your HTML source:
Bind Recliner on elements with the .lazy
class:
;
You can also progrmatically trigger an update to check for new elements to be loaded:
;
Recliner can be used to load a range of different dynamic content.
Images
Note: It's a good idea to specify image dimensions explicitly so your page height doesn't go berserk as lazy content is loaded into the DOM.
Iframes
AJAX
Loading, be patient damnit!
Callback API
Recliner exposes a simple event based API so you can implement your own custom behaviour using callbacks:
lazyload
The lazyload
event will be triggered on elements that are about to be loaded.
;
lazyshow
The lazyshow
event will be triggered on elements after they have been loaded.
;
Styling and Animations
Recliner will set the following stateful CSS classes on your elements:
lazy-loading
: Set while the element is being loadedlazy-loaded
: Set when the element has loaded
Using the stateful classes you can add some fancy transitions to your images:
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Issues
If you find any bugs please use the Github issue tracker.