A render prop component pattern which provides an interface for the `IntersectionObserver` API.
npm install @stellar-apps/intersectionIntersectionObserver API.The IntersectionObserver interface of the Intersection Observer 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. The ancestor
element or viewport is referred to as the root.
When an IntersectionObserver is created, it's configured to watch for given ratios of visibility within the root. The
configuration cannot be changed once the IntersectionObserver is created, so a given observer object is only useful for
watching for specific changes in degree of visibility.
yarn add @stellar-apps/intersectionjs
import Intersection from '@stellar-apps/intersection'function IntersectionBox (props) {
return (
{({intersectionRef, isIntersecting}) => (
Is intersecting? {String(isIntersecting)}
Intersection ratio: {String(intersectionRatio)}
)}
)
}
`$3
$3
-
- default
- A specific ancestor of the target element being observed. If no value was passed to the constructor or this is
, the top-level document's viewport is used
- rootMargin {string}
- default
- Margin around the root. Can have values similar to the CSS margin property, e.g.
"10px 20px 30px 40px" (top, right, bottom, left). The values can be percentages.
This set of values serves to grow or shrink each side of the root element's bounding
box before computing intersections.
-
- default
- Either a single number or an array of numbers which indicate at what percentage of the
target's visibility the observer's callback should be executed. If you only want to
detect when visibility passes the 50% mark, you can use a value of . If you want the
callback to run every time visibility passes another 25%, you would specify the array
[0, 0.25, 0.5, 0.75, 1]. The default is 0 (meaning as soon as even one pixel is visible,
the callback will be run). A value of 1.0 means that the threshold isn't considered passed until
every pixel is visible.
- pollInterval {number}
- default
- The frequency in which the polyfill polls for intersection changes
- Only relevant if you'd like to detect changes for any of the following:
- CSS changes on :hover, :active, or :focus states
- CSS changes due to transitions or animations with a long initial delay
- Resizable