$lazy - IntersectionObserver

​@style.tools/lazy is a lightweight lazy loader based on Intersection Observer V2 with a tiny fallback for old browsers.
// simple: lazy load images
$lazy('[data-src]');
​
// simple: in-view callback
$lazy('#element', function() {
  // inview callback
});
Lazy loading of background-image in stylesheets.
$lazybg(
  sheets, /* stylesheet element(s), default: document.styleSheets (all) */
  lazy_config, /* optional: config to pass to $lazy() */
  resolver, /* optional: JSON or javascript image resolver */
  webp /* disable WebP rewrite (when using lazybg+webp.js) */
);
$lazy can be configured using an async script element.
<script async src="dist/lazy+data-attr.js" data-z='selector' data-b='/base/path/'></script>
The script element accepts the following parameters:
Parameter
Description
Type
​
data-z
​
String
Selector or config object.
data-zz
​
Array
Multiple selector or config objects.
data-b
​
String
Base path (URL rebasing).
When using $async, $lazy can be used as timing method with automated polyfill loading.
<script async src="dist/async.js" data-c='[{
   "src": "dist/intersectionobserver-polyfill.js",
   "load_timing": {
      "type": "method",
      "method": "$lazypoly"
    },
    "cache": "localstorage"
},{
  "ref": "$z",
  "src": "dist/lazy.js",
  "attributes": {
    "data-z": "[\".selector\", 0.006, \"0px\"]"
  },
  "load_timing": {
    "type": "requestAnimationFrame",
    "frame": -1
  },
  "cache": "localstorage"
}]'></script>
<!-- timing: requestAnimationFrame @ frame -1 = faster than domready event
Install via npm
npm install @style.tools/lazy --save
Install via PHP Composer
composer require styletools/lazy
Config
The selector entry accepts multiple configuration formats including a string, an Array, a Node, NodeList or a JSON object with observer configuration.
Simple config
$lazy({
   "selector": "[data-src]",
   "threshold": 0.006,
   "rootMargin": "0px"
});
Custom observer config
$lazy({
   "selector": "[data-src]",
   "observer": {
      "threshold": 0.006,
      "rootMargin": "0px",
      "trackVisibility": true,
      "delay": 100
   }
});
The array based index config is a compressed format to save size in the HTML document.
[0] = selector
[1] = threshold OR observer config when an object
[2] = rootMargin
Simple config
$lazy(["[data-src]", 0.006, "0px"]);
Custom observer config
$lazy(["[data-src]", {
   "threshold": 0.006,
   "rootMargin": "0px",
   "trackVisibility": true,
   "delay": 100
}]);
Inview & Out-of-view callback
The inview callback makes it possible to use $lazy as a simple inview script.
$lazy(".selector", function(target, observer, is_inview) {
​
  // element in view
  is_inview = boolean
​
  return false; // persist observer to enable out-of-view callback
});
By returning false from a custom inview callback, the observer will not be removed and will trigger the callback again when the element moves in or out of view.
The inview argument accepts an array with 3 index positions:
inview: a function to call when the element moves into view.
out-of-view a function to call when the element moves out of view
after_inview a function to call with the default inview-method after src and srcset have been rewritten.
When out-of-view is null, the inview method is used as out-of-view method.
$lazy(".selector", [
  function inview(target, observer) {
​
    // element in view
​
    return false; // persist observer
​
  },
  function out_of_view(target, observer) {
​
    // element out of view
​
    return false; // persist observer
​
  }]);
To easily extend the original data-src based lazy loading of images, you can use an after_inview callback.
$lazy(".selector", [,,function after_inview(target) {
​
  // target has been lazy-loaded
  target.classList.add('custom-class');
}]);
Custom observer callback
The third argument enables to manually define the IntersectionObserver callback.
$lazy('div#id', 0, function(entries) {
  // entries is a Array of `IntersectionObserverEntry` or HTML Nodes
  // you need to manually verify if the browser supports Intersection Observer
​
  if (window.IntersectionObserver) {
    // entries[0] = IntersectionObserverEntry
    // entries[0].target = element
  } else {
    // entries[0] = element
  }
})
Lazy loading of background-image in stylesheets
See $lazybg.
Automatic .webp rewrite
It is possible to automatically load .webp images for browsers that support Google's WebP format. It saves a server-side redirect and it adds WebP support to the <img> tag.
Simply use the dist/lazy+webp... files to enable it.
The solution uses <img onerror> to fallback to the original image when the .webp image is 404.
To manually disable webp rewrites for an image add the HTML attribute data-webp="no". To disable it for a specific $lazy configuration, set the 4th argument to false.
$lazybg supports WebP rewrites by using dist/lazybg+webp.js.
data-z JSON config
To enable usage in combination with a strict Content-Security-Policy the script can be configured using a data-z attribute on the script source element.
<script data-z='{
   "selector": "[data-src*=&apos;cdn.domain.com&apos;]", 
   "observer": { 
      "threshold": [1.0],
      "trackVisibility": true,
      "delay": 100
   }
}'>
// dist/lazy-data-attr.js (source)
</script>
Multiple configurations are supported via the attribute data-zz. The attributes accepts a JSON array with configurations.
<script async src="dist/lazy+data-attr.js" data-zz='["selector",{config...},{second config...}]'></script>
Polyfill
$lazy includes a polyfill for IntersectionObserver. It can be automatically loaded when using $async.
Example using $async with data-c based config
<script data-c='[
  {
    "ref": "lazy",
    "src": "dist/lazy-data-attr+polyfill.js",
    "attributes": {
     "data-z": "[\"selector\", 0.006, \"0px\"]"
    },
    "load_timing": "domReady",
    "cache": "localstorage"
  },
  {
    "ref": "lazy-polyfill",
    "src": "dist/intersectionobserver-polyfill.js",
    "load_timing": {
      "type": "method",
      "method": "$lazypoly"
    },
    "cache": "localstorage"
  }
]'>
/* $async IIFE with timing and API module */
</script>
In the example, the $async timing method method defines window.$lazypoly which will automatically load the polyfill for browsers that require the polyfill. It uses localStorage for instant loading.
Alternatively, when using $lazy without $async, you can manually define window.$lazypoly with a function that returns a Promise or a object containing a .then method.
window.$lazypoly = function() {
​
   // load polyfill
   // ...
​
   return {
      then: function(callback) {
​
         // wait until polyfill is loaded and resolve callback
​
         callback();
      }
   }
};
When using $async you can alternatively use window.$lazypoly with a string or a object to pass to $async which could load anything.
Alternatively, when including $lazy inline, the data-poly attribute enables to define a string to pass to $async.js.
<script data-z='... lazy config ...' data-poly='... config to pass to $async.js to load polyfill ...'>
// dist/lazy-data-attr+polyfill.js
</script>
Example Performance API timings
$lazy polyfill from localStorage
IIFE generator
$lazybg
Last updated 2 months ago
$lazy - IntersectionObserver

Install via npm

Install via PHP Composer

Config

Simple config

Custom observer config

Simple config

Custom observer config

Inview & Out-of-view callback

Custom observer callback

Lazy loading of `background-image` in stylesheets

Automatic `.webp` rewrite

`data-z` JSON config

Polyfill

Example using `$async` with `data-c` based config

Example Performance API timings

Parameter	Description	Type
`data-z`		`String`	Selector or config object.
`data-zz`		`Array`	Multiple selector or config objects.
`data-b`		`String`	Base path (URL rebasing).