easy-lazyload-image
v0.0.3
Published
Structure for images where you can easily apply Lazy load to your images.
Downloads
8
Maintainers
oguzhancartReadme
Easy Lazy Load Image
LazyLoad is a lightweight JavaScript library for lazy loading images with various customization options. It improves performance by loading images only when they are about to enter the viewport.
Installation
You can install LazyLoad using npm:
npm install easy-lazy-load-imageor
<script src="https://cdn.jsdelivr.net/npm//[email protected]/index.js"></script>Usage
To use LazyLoad, create a new instance of the class and pass the CSS selector of the container holding the images along with any desired options.
Basic Example
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>LazyLoad Example</title>
<style>
#image {
display: flex;
flex-direction: column;
align-items: center;
}
ul {
list-style-type: none;
}
li {
width: 550px;
height: 310px;
margin: 10px;
align-items: center;
background-color: gray;
border: 1px solid black;
}
img {
width: 100%;
}
</style>
</head>
<body>
<div id="image-container">
<img data-src="image1.jpg" alt="Image 1">
<img data-src="image2.jpg" alt="Image 2">
</div>
<script src="https://cdn.jsdelivr.net/npm//[email protected]/index.js"></script>
<script>
document.addEventListener('DOMContentLoaded', function () {
new LazyLoad('#image-container', {
threshold: 200,
animation: 'fade',
callback: (element) => console.log(`Loaded: ${element.src}`),
delay: 300,
placeholder: 'placeholder.jpg',
errorImage: 'error.jpg',
useIntersectionObserver: true,
responsive: true
});
});
</script>
</body>
</html>Options
selector: The CSS selector to target elements for lazy loading. This is a required parameter.threshold: The distance in pixels from the viewport that triggers the loading of an image. The default value is 300.root: The element that is used as the viewport for checking visibility of the target elements. The default value is the browser viewport.callback: A callback function to execute after each image is loaded. Default isnull.animation: The type of animation to use when loading images. Default isfade.animationDuration: The duration of the animation in milliseconds. Default is500.delay: The delay in milliseconds before loading an image. Default is500.placeholder: The URL of the placeholder image to use while the target image is loading. Default isnull.errorPlaceholder: The URL of the placeholder image to use if the target image fails to load. Default isnull.useIntersectionObserver: A boolean value indicating whether to use the Intersection Observer API. Default isfalse.responsive: Whether to support responsive images usingsrcsetand sizes attributes. Default isfalse.
Methods
Constructor
Creates an instance of LazyLoad.
new LazyLoad(selector, options);selector(string): The CSS selector to target elements for lazy loading.options(object): An object containing customization options.
Example
new LazyLoad('#image-container', {
threshold: 200,
animation: 'fade',
callback: (element) => console.log(`Loaded: ${element.src}`),
delay: 300,
placeholder: 'placeholder.jpg',
errorImage: 'error.jpg',
useIntersectionObserver: true,
responsive: true
});