Skip to content

Lazy-loading based web component for image delivery and UX improvement

License

Notifications You must be signed in to change notification settings

Antoine-Bergerault/Dynamic-image-loader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 

Repository files navigation

Dynamic-image-loader

Lazy-loading based web component for image delivery and UX improvement

This code provides a web component to help you deliver images faster on your webpage. By distributing images only when the user needs it, page performance is improved.

Setup

You must include the script that creates a new custom element on each page where you want to use it

Like this :

<script src="path/to/ImageElement.js"></script>

Or via a cdn :

<script src="https://cdn.jsdelivr.net/gh/Antoine-Bergerault/Dynamic-image-loader/ImageElement.js"></script>

The custom element

Use this simple custom element to make your images loading magically

<image-element data-src="path/to/image.png" />

Attributes available

  • data-src (required)

The source of the image file

  • data-srcset

The srcset attribute of the traditionnal <img /> tag

  • data-alt

The alt attribute of the traditionnal <img /> tag

<image-element data-src="path/to/image.png" data-alt="image" />

When the image is loaded "image" will be used as the alt tag and will be shown to the screen if an error occurs while trying to fetch the image.

  • data-loader

The text written when the image is loading. By default, it is set to "Loading..."

<image-element data-src="path/to/image.png" data-loader="..." />

Will print ... to the screen while waiting the image to load completely.

About

Lazy-loading based web component for image delivery and UX improvement

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published