Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mfranzke/loading-attribute-polyfill
Fast and lightweight dependency-free vanilla JavaScript polyfill for native lazy loading / the awesome loading='lazy'-attribute.
https://github.com/mfranzke/loading-attribute-polyfill
html5 javascript lazy-loading native-lazy-loading polyfill vanilla-js web-development
Last synced: 14 days ago
JSON representation
Fast and lightweight dependency-free vanilla JavaScript polyfill for native lazy loading / the awesome loading='lazy'-attribute.
- Host: GitHub
- URL: https://github.com/mfranzke/loading-attribute-polyfill
- Owner: mfranzke
- License: mit
- Created: 2019-04-09T07:00:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T20:04:46.000Z (8 months ago)
- Last Synced: 2024-04-14T03:04:34.171Z (7 months ago)
- Topics: html5, javascript, lazy-loading, native-lazy-loading, polyfill, vanilla-js, web-development
- Language: JavaScript
- Homepage: https://mfranzke.github.io/loading-attribute-polyfill/demo/
- Size: 7.97 MB
- Stars: 614
- Watchers: 8
- Forks: 53
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# loading="lazy" attribute polyfill
[](https://opencollective.com/loading-attribute-polyfill) [](https://opensource.org/licenses/mit-license.php)
[](https://bundlephobia.com/result?p=loading-attribute-polyfill)
[](https://npmjs.com/package/loading-attribute-polyfill 'loading="lazy"-attribute polyfill – on NPM')
[](https://www.jsdelivr.com/package/npm/loading-attribute-polyfill "loading-attribute polyfill – on jsDelivr")
[](https://www.codacy.com/gh/mfranzke/loading-attribute-polyfill/dashboard)
[](https://snyk.io/test/github/mfranzke/loading-attribute-polyfill?targetFile=package.json)
[](https://github.com/mfranzke/loading-attribute-polyfill/actions/workflows/codeql-analysis.yml)
[](https://github.com/mfranzke/loading-attribute-polyfill/actions/workflows/linter.yml)
[](https://npmjs.com/package/loading-attribute-polyfill 'loading="lazy"-attribute polyfill – on NPM')
[](https://github.com/prettier/prettier)
[](https://github.com/xojs/xo)
[](https://conventionalcommits.org)
[](https://gitter.im/loading-attribute-polyfill/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](http://makeapullrequest.com)
[](https://github.com/ellerbrock/open-source-badges/)
[](CODE-OF-CONDUCT.md)
Fast and lightweight vanilla JavaScript polyfill for native lazy loading, meaning the behaviour to load elements right before they enter the viewport. Provides graceful degradation, and is - not just thatfor - SEO friendly. Handles images with `srcset` and within `picture`, as well as `iframe` elements. `loading="lazy"` will be a huge improvement for todays web performance challenges, so use and polyfill it today!
- Released under the MIT license
- Made in Germany. And supported by so many great people from all over this planet - see "Credits" accordingly.
- Compatible down to Microsoft Internet Explorer 9
## Features
- Lightweight (see the badge above)
- Web standards: supports the standard `loading="lazy"` attribute on `img` and `iframe` elements
- Performance: it's based on highly efficient, best practice code.
- SEO & crawlers: the image and iframe contents aren't being hidden from crawlers that aren't capable of scrolling.
- Supporting HTML generating JavaScript frameworks through a method provided to reinit its functionality (see "Another solution, especially in combination with JavaScript framework usage" as well)
## Core concepts
The polyfill was designed with the following concepts kept in mind:
- dependency-free
- using JavaScript with graceful degradation
## Another solution, especially in combination with JavaScript framework usage
We're even also providing [another solution](https://github.com/mfranzke/loading-attribute-polyfill-with-serviceworker), which main architectural decision is that we're using Service Worker to intercept the image and iframe contents network requests there. This comes with some aspects that are important to mention, that might be either acceptable (have a look at the [other solution](https://github.com/mfranzke/loading-attribute-polyfill-with-serviceworker)) or not (stay with this one) on your requirements and technical context.
- Service Workers only run over **HTTPS**, for security reasons
- Service Worker need to get **registered on first page visit**
- Only works on **same domain** network requests
Whereas the first topic might not be a problem (anymore) on most websites – as this should be the de-facto standard nowadays – the second and third might be acceptable in your context, as this polyfill behaves as a progressive enhancement to provide the expected functionality even for non-supporting browsers both only on seconds pages request and any revisits and for same origin image and contents (iframe) requests even only.
## Installation
First you'll need to integrate the JavaScript file into your code.
You may optionally load via NPM or Bower:
$ npm install loading-attribute-polyfill
$ bower install loading-attribute-polyfill
You could load the polyfill asynchronously as well:
## Integration
Include one of the provided JavaScript files depending on your setup plus the CSS file:
```html
```
or e.g. within JS
```js
import loadingAttributePolyfill from "node_modules/loading-attribute-polyfill/dist/loading-attribute-polyfill.module.js";
```
Afterwards, you need to wrap all of your `![]()
` and `` HTML tags (in the case of `` use the complementary `` HTML tags) that you'd like to lazy load with a `` HTML tag (with the attribute `class="loading-lazy"`.)
Please keep in mind that it's important to even also include `width` and `height` attributes on `![]()
` HTML tags, as the browser could determine the aspect ratio via those two attributes values being set (even if you overwrite them via CSS), compare to the great work by Jen Simmons on this topic, e.g. within these articles (with video) or
And please "Avoid lazy-loading images that are in the first visible viewport", compare to [the article "Browser-level image lazy-loading for the web"](https://web.dev/browser-level-image-lazy-loading/#avoid-lazy-loading-images-that-are-in-the-first-visible-viewport) published on web.dev:
> You should avoid setting `loading=lazy` for any images that are in the first visible viewport. It is recommended to only add `loading=lazy` to images which are positioned below the fold, if possible.
### Simple image
```html
```
### Image wrapped in a picture tag
```html
```
### Image with `srcset`
```html
```
### Iframe
```html
```
## Optional additional dependencies
In case you'd like to support [older versions of Microsoft Edge, Microsoft Internet Explorer 11 or Apple Safari up to 12.0](https://caniuse.com/#feat=intersectionobserver), you could (conditionally) load an IntersectionObserver polyfill:
Nevertheless this polyfill would still work in those browsers without that other polyfill included, but [this small amount of users](<(https://caniuse.com/#feat=intersectionobserver)>) wouldn't totally benefit from the lazy loading functionality - we've at least got you partly covered by using the [Microsoft proprietary lazy loading resource hints](https://caniuse.com/#feat=lazyload).
### Internet Explorer 9 & Internet Explorer 10
> Internet Explorer 9 and 10 have bugs where the 'interactive' state can be fired too early before the document has finished parsing.
Source: https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState
That for you would need to include the polyfill the latest within the HTML code, like the nearest to the closing `body` HTML tag, as including it e.g. within the `head` section might lead to an unexpected state, so that in worst case the images might not get loaded.
### Internet Explorer 9
The polyfill has been enhanced to even also provide it's functionality on IE9. But please keep in mind to even also include a `matchMedia` polyfill.
And the images are still displaying an error in the demo on IE9, as most likely (from my understanding) this browser doesn't work with the HTTPS protocol by GitHub pages any more, but the src-attributes values are correctly rewritten after all.
## API
In case that you're dynamically adding HTML elements within the browser, you could call the following method with an included [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) object, like e.g.:
```JavaScript
loadingAttributePolyfill.prepareElement(document.querySelector('main noscript.loading-lazy'));
```
## Demo
See the polyfill in action either by downloading / forking this repository and have a look at `demo/index.html`, or at the hosted demo:
## Further implementations - Kudos for that
### WordPress
Nico23 has developed a WordPress plugin: (which is much better than the one by Google !)
### PHP Twig Extension
@tim-thaler has developed a PHP Twig Extension:
### Craft Twig Loading Lazy plugin
@tim-thaler has even also developed a Craft Twig Loading Lazy plugin:
## Credits
Credits for the initial kickstarter / script to @Sora2455 for better expressing my ideas & concepts and support by @cbirdsong, @eklingen, @DaPo, @nextgenthemes, @diogoterremoto, @dracos, @Flimm, @TomS-, @vinyfc93, @JordanDysart and @denyshutsal. Thank you very much for that, highly appreciated !
## Tested with
- Mac
- Safari 14, macOS 11 (via CrossBrowserTesting)
- Mozilla Firefox _latest_, macOS 10.14 (manually, localhost)
- iOS
- Mobile Safari 12.0, iPad 6th Generation Simulator (manually)
- Windows
- Google Chrome _latest_, Windows 10 (via CrossBrowserTesting)
- Mozilla Firefox _latest_, Windows 10 (via CrossBrowserTesting)
- Microsoft Edge version 18, Windows 10 (manually, localhost)
- Microsoft Internet Explorer version 11, Windows 10 (via CrossBrowserTesting)
- Internet Explorer 9.0.8112.16421, Windows 7 SP1 (manually, localhost)
### Big Thanks
Cross-browser testing platform provided by [CrossBrowserTesting](https://crossbrowsertesting.com)
[](https://crossbrowsertesting.com)
## Things to keep in mind
- The HTML demo code is meant to be simple
- This polyfill doesn't (so far) provide any functionality for the `loading="eager"` value, as this was released even already, but still seems to be in the measure, learn and improvements phase.
## More information on the standard
- [Specification](https://github.com/whatwg/html/pull/3752)
- [LazyLoad Explainer](https://github.com/scott-little/lazyload)
## Outro
If you're trying out and using my work, feel free to contact me and give me any feedback. I'm curious about how it's gonna be used.
And if you do like this polyfill, please consider even also having a look at the other polyfill we've developed:
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/loading-attribute-polyfill/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/loading-attribute-polyfill/contribute)]
