Skip to content

react-visibility-sensor with IntersectionObserver #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 78 additions & 1 deletion visibility-sensor.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,31 @@ function normalizeRect(rect) {
return rect;
}

function isIntersectionObserverSupported() {
if (
"IntersectionObserver" in window &&
"IntersectionObserverEntry" in window &&
"intersectionRatio" in window.IntersectionObserverEntry.prototype
) {
// Minimal polyfill for Edge 15's lack of `isIntersecting`
// See: https://github.com/w3c/IntersectionObserver/issues/211
if (!("isIntersecting" in window.IntersectionObserverEntry.prototype)) {
Object.defineProperty(
window.IntersectionObserverEntry.prototype,
"isIntersecting",
{
get: function() {
return this.intersectionRatio > 0;
}
}
);
}
return true;
} else {
return false;
}
}

export default class VisibilitySensor extends React.Component {
static defaultProps = {
active: true,
Expand Down Expand Up @@ -75,7 +100,6 @@ export default class VisibilitySensor extends React.Component {

constructor(props) {
super(props);

this.state = {
isVisible: null,
visibilityRect: {}
Expand Down Expand Up @@ -152,6 +176,17 @@ export default class VisibilitySensor extends React.Component {
};

startWatching = () => {
if (isIntersectionObserverSupported()) {
this.observer = this.createIntersectionObserver(
this.props.onChange,
this.props.partialVisibility,
this.props.offset,
this.props.containment
);
this.observer.observe(this.node);
return;
}

if (this.debounceCheck || this.interval) {
return;
}
Expand Down Expand Up @@ -183,6 +218,11 @@ export default class VisibilitySensor extends React.Component {
};

stopWatching = () => {
if (this.observer) {
this.observer.unobserve(this.node);
this.observer.disconnect();
return;
}
if (this.debounceCheck) {
// clean up event listeners and their debounce callers
for (let debounceEvent in this.debounceCheck) {
Expand Down Expand Up @@ -215,6 +255,43 @@ export default class VisibilitySensor extends React.Component {
};
}

createIntersectionObserver = (
onChange,
partialVisibility,
offset,
containment
) => {
if (isIntersectionObserverSupported()) {
var callback = function(entries) {
entries.forEach(entry => {
var shape = entry.isIntersecting
? {
top: entry.intersectionRect.top,
bottom: entry.intersectionRect.bottom,
left: entry.intersectionRect.left,
right: entry.intersectionRect.right
}
: undefined;

typeof onChange === "function" &&
onChange(entry.isIntersecting, shape);
});
};

var options = {
threshold: partialVisibility ? 0 : 1,
root: containment,
rootMargin:
partialVisibility && typeof offset === "object"
? `${offset.top}px ${offset.right}px ${offset.bottom}px ${
offset.left
}px`
: "0px"
};
return new IntersectionObserver(callback, options);
}
};

/**
* Check if the element is within the visible viewport
*/
Expand Down