react-code-dataset
/
wp-calypso
/packages
/help-center
/src
/hooks
/use-help-center-article-scroll.tsx
| import { useEffect, useRef } from '@wordpress/element'; | |
| /** | |
| * Persist the value in memory so when the element is unmounted it doesn't get lost. | |
| */ | |
| const cachedScrollPositions: Record< string, number > = {}; | |
| export const useHelpCenterArticleScroll = ( | |
| postId: number | undefined, | |
| scrollParentRef: React.RefObject< HTMLElement > | |
| ) => { | |
| const timeoutRef = useRef< ReturnType< typeof setTimeout > | null >( null ); | |
| useEffect( () => { | |
| if ( ! postId || ! scrollParentRef?.current ) { | |
| return; | |
| } | |
| const scrollRef = scrollParentRef?.current; | |
| const scrollBehaviour = scrollRef.style.scrollBehavior; | |
| // temporary disable smooth scrolling | |
| scrollRef.style.scrollBehavior = 'auto'; | |
| if ( cachedScrollPositions[ postId ] ) { | |
| scrollRef.scrollTop = cachedScrollPositions[ postId ]; | |
| } else { | |
| scrollRef.scrollTop = 0; | |
| } | |
| // restore smooth scrolling | |
| scrollRef.style.scrollBehavior = scrollBehaviour; | |
| const handleScroll = ( event: { target: EventTarget | null } ) => { | |
| if ( timeoutRef.current ) { | |
| clearTimeout( timeoutRef.current ); | |
| } | |
| timeoutRef.current = setTimeout( () => { | |
| if ( event.target === scrollParentRef.current ) { | |
| cachedScrollPositions[ postId ] = Number( scrollRef.scrollTop ); | |
| } | |
| }, 250 ); | |
| }; | |
| scrollRef.addEventListener( 'scroll', handleScroll ); | |
| return () => { | |
| if ( timeoutRef.current ) { | |
| clearTimeout( timeoutRef.current ); // Clear the timeout during cleanup | |
| } | |
| scrollRef?.removeEventListener( 'scroll', handleScroll ); | |
| }; | |
| }, [ postId, scrollParentRef ] ); | |
| }; | |