rooks/dist/esm/hooks/useWindowScrollPosition.d.ts

Collection of awesome react hooks

type ScrollPosition = {
    scrollX: Window["scrollX"];
    scrollY: Window["scrollY"];
};
/**
 *
 * useWindowScrollPosition hook
 * A React hook to get the scroll position of the window
 *
 * @returns an object containing scrollX and scrollY values
 * @see https://rooks.vercel.app/docs/hooks/useWindowScrollPosition
 */
declare function useWindowScrollPosition(): ScrollPosition;
export { useWindowScrollPosition };