A "lazyload" feature images on your site.

This feature will only load the images that are in your viewport. This way you wont bother the user to load in images they may never see.

Getting started

Lets start by installing the package, like most of the other package we will make use of NPM

npm install @orange-games/lazyload --save-dev

Now lets call get the tool in our project.

import Lazyload from '@orange-games/lazyload';

At last let's call the feature!

new lazyload('container', {
    itemClass: 'lazyload',
    multiplier: 2,
    initMultiplier: 1
});

note: the only required parameter here is the container.

To make the feature actually work you might want to provide your elements with a url. Here is an example on how you could do this.

<img
class="lazyload"
src=""
srcset=""
data-src="example.png"
data-srcset="example.png, [email protected] 2x">

As you can see we pass the class name that we have used as a parameter in the JS bit. We can leave src and srcset empty, as they will be filled in with js when they appear in the viewport. We pass the needed urls with the data-src and data-srcset. The plugin will do the rest.