ghost-portal/packages/react-hooks/src/useScroll.ts
2022-01-01 09:30:15 +02:00

28 lines
726 B
TypeScript

// Copyright 2017-2022 @polkadot/react-hooks authors & contributors
// SPDX-License-Identifier: Apache-2.0
import { useCallback, useEffect, useState } from 'react';
import { createNamedHook } from './createNamedHook';
function useScrollImpl (): number {
const [scrollY, setScrollY] = useState(window.pageYOffset);
const setYOffset = useCallback((): void => setScrollY(window.pageYOffset), []);
useEffect(() => {
function watchScroll () {
window.addEventListener('scroll', setYOffset);
}
watchScroll();
return () => {
window.removeEventListener('scroll', setYOffset);
};
}, [setYOffset]);
return scrollY;
}
export const useScroll = createNamedHook('useScroll', useScrollImpl);