diff options
Diffstat (limited to 'FrontEnd/src/utilities/hooks/useScrollToTop.ts')
-rw-r--r-- | FrontEnd/src/utilities/hooks/useScrollToTop.ts | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/FrontEnd/src/utilities/hooks/useScrollToTop.ts b/FrontEnd/src/utilities/hooks/useScrollToTop.ts new file mode 100644 index 00000000..95c8b7b9 --- /dev/null +++ b/FrontEnd/src/utilities/hooks/useScrollToTop.ts @@ -0,0 +1,43 @@ +import React from "react"; +import { fromEvent } from "rxjs"; +import { filter, throttleTime } from "rxjs/operators"; + +function useScrollToTop( + handler: () => void, + enable = true, + option = { + maxOffset: 5, + throttle: 1000, + } +): void { + const handlerRef = React.useRef<(() => void) | null>(null); + + React.useEffect(() => { + handlerRef.current = handler; + + return () => { + handlerRef.current = null; + }; + }, [handler]); + + React.useEffect(() => { + const subscription = fromEvent(window, "scroll") + .pipe( + filter(() => { + return window.scrollY <= option.maxOffset; + }), + throttleTime(option.throttle) + ) + .subscribe(() => { + if (enable) { + handlerRef.current?.(); + } + }); + + return () => { + subscription.unsubscribe(); + }; + }, [enable, option.maxOffset, option.throttle]); +} + +export default useScrollToTop; |