Using IntersectionObserver API
The IntersectionObserver API provides a way to asynchronously observe changes in the intersection of a target element with an ancestor element or with a top-level document’s viewport.
Here’s an example that triggers a classList toggle when an Element is in viewport:
const inViewport = (entries, observer) => {
entries.forEach(entry => {
entry.target.classList.toggle("is-inViewport", entry.isIntersecting);
});
};
const Obs = new IntersectionObserver(inViewport);
const obsOptions = {}; //See: https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#Intersection_observer_options
// Attach observer to every [data-inviewport] element:
const ELs_inViewport = document.querySelectorAll('[data-inviewport]');
ELs_inViewport.forEach(EL => {
Obs.observe(EL, obsOptions);
});
[data-inviewport] { /* THIS DEMO ONLY */
width:100px; height:100px; background:#0bf; margin: 150vh 0;
}
/* inViewport */
[data-inviewport="scale-in"] {
transition: 2s;
transform: scale(0.1);
}
[data-inviewport="scale-in"].is-inViewport {
transform: scale(1);
}
[data-inviewport="fade-rotate"] {
transition: 2s;
opacity: 0;
}
[data-inviewport="fade-rotate"].is-inViewport {
transform: rotate(180deg);
opacity: 1;
}
Scroll down...
<div data-inviewport="scale-in"></div>
<div data-inviewport="fade-rotate"></div>
Observer Options
To define another parent reference element use the root
option inside the Observable options Object. At your disposition there’s also rootMargin
and the super useful threshold
option
const obsOptions = {
// Default is null (Browser viewport). Set a specific parent element:
root: document.querySelector('#someSpecificParent'),
// add 40px inner "margin" area at which the observer starts to calculate:
rootMargin: '40px',
// Default is 0.0 meaning the callback is called as soon 1 pixel is inside the viewport.
// Set to 1.0 to trigger a callback when 100% of the target element is inside the viewport,
// or i.e: 0.5 when half of the target element is visible:
threshold: 0.5,
};
See another interesting use case that uses the IntersectionObserver API’s threshold
option.
Additional read:
- w3.org
- developer.mozilla.org
- caniuse.com
IE browser
Using the native IntersectionObserver API is the most performant way to tackle this problem.
If you want an idea on how we tackled similar needs in the past see this answer with a small custom plugin as an example.