imagesready
v0.2.2
Published
ImagesReady is a lightweight utility for detecting when images have been loaded. It supports promises and can be used with or without jQuery.
Downloads
17
Maintainers
Readme
ImagesReady
ImagesReady is a lightweight utility for detecting when images have been loaded. It supports promises and can be used with or without jQuery.
Installation
bower
bower install imagesready
npm
npm install imagesready
Example
Add ImagesReady (non-jQuery)
<script src="imagesready.min.js"></script>
Add ImagesReady (jQuery – do not add imagesready.min.js
)
<script src="jquery.min.js"></script>
<script src="jquery-imagesready.min.js"></script>
Example HTML – ImagesReady will check all images within container
<div class="container">
<img src="foo.jpg">
<div>
<img src="bar.jpg">
<a href="baz.html"><img src="baz.jpg"></a>
</div>
</div>
<div class="container">
<img src="biz.jpg">
</div>
Setup promise handlers. Both fulfilled and rejected handlers will be passed the elements
that are provided to ImagesReady.
// handle fulfilled promise – triggered
// when all images have loaded
function ready(elements) {
console.log('Images are ready');
// do something with elements
}
// handle rejected promise – triggered
// when one or more images fail to load
function error(elements) {
console.log('Error');
// do something with elements
}
Invoke ImagesReady (non-jQuery)
var elements = document.querySelectorAll('.container');
imagesReady(elements).then(ready, error);
// `elements` will be passed to both `ready` and `error` handlers
Invoke ImagesReady (jQuery)
$('.container').imagesReady().then(ready, error);
// $('.container') will be passed to both `ready` and `error` handlers
Browser Support
- Chrome
- Firefox
- IE 9+
- Safari
Module Support
- AMD
- CommonJS
- Browser global
License
ImagesReady is free to use under the open-source MIT license.