@futurejj/react-native-visibility-sensor
Version:
A React Native wrapper to check whether a component is in the view port to track impressions and clicks
100 lines (98 loc) • 3.3 kB
JavaScript
;
import React, { useCallback, useEffect, useRef, useState, forwardRef, useImperativeHandle } from 'react';
import { Dimensions, View } from 'react-native';
import { jsx as _jsx } from "react/jsx-runtime";
function useInterval(callback, delay) {
const savedCallback = useRef(callback);
useEffect(() => {
savedCallback.current = callback;
}, [callback]);
useEffect(() => {
if (delay === null || delay === undefined) {
return;
}
const id = setInterval(() => savedCallback.current(), delay);
return () => clearInterval(id);
}, [delay]);
}
const VisibilitySensor = /*#__PURE__*/forwardRef((props, ref) => {
const {
onChange,
disabled = false,
triggerOnce = false,
delay,
threshold = {},
children,
...rest
} = props;
const localRef = useRef(null);
useImperativeHandle(ref, () => ({
getInnerRef: () => localRef.current
}));
const [rectDimensions, setRectDimensions] = useState({
rectTop: 0,
rectBottom: 0,
rectLeft: 0,
rectRight: 0,
rectWidth: 0,
rectHeight: 0
});
const [lastValue, setLastValue] = useState(undefined);
const [active, setActive] = useState(false);
const measureInnerView = () => {
if (!active) return;
localRef.current?.measure((_x, _y, width, height, pageX, pageY) => {
const dimensions = {
rectTop: pageY,
rectBottom: pageY + height,
rectLeft: pageX,
rectRight: pageX + width,
rectWidth: width,
rectHeight: height
};
if (rectDimensions.rectTop !== dimensions.rectTop || rectDimensions.rectBottom !== dimensions.rectBottom || rectDimensions.rectLeft !== dimensions.rectLeft || rectDimensions.rectRight !== dimensions.rectRight || rectDimensions.rectWidth !== dimensions.rectWidth || rectDimensions.rectHeight !== dimensions.rectHeight) {
setRectDimensions(dimensions);
}
});
};
useInterval(measureInnerView, delay || 100);
const startWatching = useCallback(() => {
if (!active) setActive(true);
}, [active]);
const stopWatching = useCallback(() => {
if (active) setActive(false);
}, [active]);
useEffect(() => {
if (!disabled) {
startWatching();
}
return () => {
stopWatching();
};
}, [disabled, startWatching, stopWatching]);
useEffect(() => {
const window = Dimensions.get('window');
const isVisible = rectDimensions.rectTop + (threshold.top || 0) <= window.height &&
// Top edge is within the bottom of the window
rectDimensions.rectBottom - (threshold.bottom || 0) >= 0 &&
// Bottom edge is within the top of the window
rectDimensions.rectLeft + (threshold.left || 0) <= window.width &&
// Left edge is within the right of the window
rectDimensions.rectRight - (threshold.right || 0) >= 0; // Right edge is within the left of the window
if (lastValue !== isVisible) {
setLastValue(isVisible);
onChange(isVisible);
if (isVisible && triggerOnce) {
stopWatching();
}
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [rectDimensions, lastValue]);
return /*#__PURE__*/_jsx(View, {
ref: localRef,
...rest,
children: children
});
});
export default VisibilitySensor;
//# sourceMappingURL=VisibilitySensor.js.map