diff options
author | crupest <crupest@outlook.com> | 2021-06-15 18:25:17 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-15 18:25:17 +0800 |
commit | 4645761c2090aeaf8c26789155b342c048f44535 (patch) | |
tree | 1aab5ce94549f3f8b3fd1a31c84fb2dd8b6b2511 /FrontEnd/src/utilities/useScrollToTop.ts | |
parent | 485ef185153890b7c6ac4ed9798a3f2db80c8845 (diff) | |
parent | b6afd5e8161126522bdfff876f5483fa97e94797 (diff) | |
download | timeline-4645761c2090aeaf8c26789155b342c048f44535.tar.gz timeline-4645761c2090aeaf8c26789155b342c048f44535.tar.bz2 timeline-4645761c2090aeaf8c26789155b342c048f44535.zip |
Merge pull request #620 from crupest/vite
Migrate to vite!
Diffstat (limited to 'FrontEnd/src/utilities/useScrollToTop.ts')
-rw-r--r-- | FrontEnd/src/utilities/useScrollToTop.ts | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/FrontEnd/src/utilities/useScrollToTop.ts b/FrontEnd/src/utilities/useScrollToTop.ts new file mode 100644 index 00000000..892e3545 --- /dev/null +++ b/FrontEnd/src/utilities/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: 50, + 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; |