File size: 1,285 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
import { useCallback, useEffect, useState } from 'react';
interface UseScrollToTopOptions< T > {
scrollTargetRef: React.MutableRefObject< T | null >;
smoothScrolling: boolean;
isBelowThreshold: ( scrollTarget: T ) => boolean;
}
type ScrollTarget = HTMLElement | Window;
export const useScrollToTop = < T extends ScrollTarget >( {
scrollTargetRef,
smoothScrolling,
isBelowThreshold,
}: UseScrollToTopOptions< T > ) => {
const [ isButtonVisible, setVisible ] = useState( false );
const scrollCallback = useCallback( () => {
if ( scrollTargetRef.current ) {
setVisible( isBelowThreshold( scrollTargetRef.current ) );
}
}, [ scrollTargetRef, isBelowThreshold ] );
useEffect( () => {
if ( scrollTargetRef.current ) {
const scrollElement = scrollTargetRef.current;
scrollElement.addEventListener( 'scroll', scrollCallback );
return () => {
scrollElement.removeEventListener( 'scroll', scrollCallback );
};
}
}, [ scrollTargetRef, scrollCallback ] );
const scrollToTop = useCallback( () => {
if ( ! scrollTargetRef.current ) {
return;
}
scrollTargetRef.current.scrollTo( {
top: 0,
behavior: smoothScrolling ? 'smooth' : 'auto',
} );
}, [ scrollTargetRef, smoothScrolling ] );
return {
scrollToTop,
isButtonVisible,
};
};
|