Created
May 26, 2020 12:43
-
-
Save ivanstnsk/e775d28ebd0dff06981cc7b65e2238d9 to your computer and use it in GitHub Desktop.
use Mouse Scroll hook React in Typescript
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import { useEffect, useState, useRef } from 'react'; | |
type THook<T extends HTMLElement> = [ | |
React.RefObject<T>, | |
number, | |
]; | |
export const useMouseScroll = <T extends HTMLElement>(): THook<T> => { | |
const [scrollY, setScrollY] = useState<number>(0); | |
const ref = useRef<T>(null); | |
// eslint-disable-next-line consistent-return | |
useEffect(() => { | |
const handleScroll = (event: Event): void => { | |
const { target } = event; | |
setScrollY((target as T).scrollTop); | |
}; | |
const node = ref && ref.current; | |
if (node) { | |
node.addEventListener('scroll', handleScroll); | |
return () => { | |
node.removeEventListener('scroll', handleScroll); | |
}; | |
} | |
}, [ref]); | |
return [ref, scrollY]; | |
}; | |
// Example of usage | |
// const [containerRef, scrollY] = useMouseScroll<HTMLDivElement>(); | |
// ... | |
// <div ref={containerRef}>content</div> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment