web-api-hooks
Version:
Essential set of React Hooks for convenient Web API consumption.
21 lines (20 loc) • 670 B
JavaScript
import { useEffect, useState } from 'react';
import { canUseDOM, managedEventListener } from './utils';
/**
* Tracks window scroll position.
*
* @returns Coordinates `[x, y]`, falling back to `[0, 0]` when unavailable.
*
* @example
* function Component() {
* const [windowScrollX, windowScrollY] = useWindowScrollCoords();
* // ...
* }
*/
export default function useWindowScrollCoords() {
const [coords, setCoords] = useState(canUseDOM ? [window.pageXOffset, window.pageYOffset] : [0, 0]);
useEffect(() => managedEventListener(window, 'scroll', () => {
setCoords([window.pageXOffset, window.pageYOffset]);
}), []);
return coords;
}