Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuupola/jquery_lazyload
Vanilla JavaScript plugin for lazyloading images
https://github.com/tuupola/jquery_lazyload
Last synced: 14 days ago
JSON representation
Vanilla JavaScript plugin for lazyloading images
- Host: GitHub
- URL: https://github.com/tuupola/jquery_lazyload
- Owner: tuupola
- License: mit
- Created: 2008-11-05T16:55:49.000Z (about 16 years ago)
- Default Branch: 2.x
- Last Pushed: 2023-12-05T01:36:15.000Z (about 1 year ago)
- Last Synced: 2024-11-30T16:43:57.195Z (22 days ago)
- Language: JavaScript
- Homepage: https://appelsiini.net/projects/lazyload/
- Size: 4.82 MB
- Stars: 8,759
- Watchers: 306
- Forks: 2,232
- Open Issues: 110
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-jquery - jquery_lazyload - jQuery plugin for lazy loading images (Images / Data Table)
README
# Lazy Load Remastered
Lazy Load delays loading of images in long web pages. Images outside of viewport will not be loaded before user scrolls to them. This is opposite of image preloading.
This is a modern vanilla JavaScript version of the original [Lazy Load](https://github.com/tuupola/jquery_lazyload) plugin. It uses [Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) to observe when the image enters the browsers viewport. Original code was inspired by [YUI ImageLoader](https://yuilibrary.com/yui/docs/imageloader/) utility by Matt Mlinac. New version loans heavily from a [blog post](https://deanhume.com/Home/BlogPost/lazy-loading-images-using-intersection-observer/10163) by Dean Hume.
## Basic Usage
By default Lazy Load assumes the URL of the original high resolution image can be found in `data-src` attribute. You can also include an optional low resolution placeholder in the `src` attribute.
```html
![]()
```
With the HTML in place you can then initialize the plugin using the factory method. If you do not pass any settings or image elements it will lazyload all images with class `lazyload`.
```js
lazyload();
```
If you prefer you can explicitly pass the image elements to the factory. Use this for example if you use different class name.
```js
let images = document.querySelectorAll(".branwdo");
lazyload(images);
```
If you prefer you can also use the plain old constructor.
```js
let images = document.querySelectorAll(".branwdo");
new LazyLoad(images);
```
The core IntersectionObserver can be configured by passing an additional argument
```js
new LazyLoad(images, {
root: null,
rootMargin: "0px",
threshold: 0
});
```
## Additional API
To use the additional API you need to assign the plugin instance to a variable.
```js
let lazy = lazyload();
```
To force loading of all images use `loadimages()`.
```js
lazy->loadImages();
```
To destroy the plugin and stop lazyloading use `destroy()`.
```js
lazy->destroy();
```
Note that `destroy()` does not load the out of viewport images. If you also
want to load the images use `loadAndDestroy()`.
```js
lazy->loadAndDestroy();
```
Additional API is not avalaible with the jQuery wrapper.
## jQuery Wrapper
If you use jQuery there is a wrapper which you can use with the familiar old syntax. Note that to provide BC it uses `data-original` by default. This should be a drop in replacement for the previous version of the plugin.
```html
![]()
```
```js
$("img.lazyload").lazyload();
```
## Cookbook
### Blur Up Images
Low resolution placeholder ie. the "blur up" technique. You can see this in action [in this blog entry](https://appelsiini.net/2017/trilateration-with-n-points/). Scroll down to see blur up images.
```html
```
```html
```
### Responsive Images
Lazyloaded [Responsive images](https://www.smashingmagazine.com/2014/05/responsive-images-done-right-guide-picture-srcset/) are supported via `data-srcset`. If browser does not support `srcset` and there is no polyfill the image from `data-src` will be shown.
```html
```
```html
```
### Inlined Placeholder Image
To reduce the amount of request you can use data uri images as the placeholder.
```html
```
## Install
This is still work in progress. You can install beta version with yarn or npm.
```
$ yarn add lazyload
$ npm install lazyload
```
# License
All code licensed under the [MIT License](http://www.opensource.org/licenses/mit-license.php). All images licensed under [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/deed.en_US). In other words you are basically free to do whatever you want. Just don't remove my name from the source.