blob: 85e7060bd95cf3c43049667dd8c9ab72c042f229 (
plain)
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
|
import { useRouter } from 'next/router';
import { useEffect } from 'react';
export type OnRouteChangeStep = 'start' | 'end';
export type OnRouteChangeHandler = () => void;
/**
* React hook to trigger a callback function on route change.
*
* @param {OnRouteChangeHandler} handler - The callback to trigger.
* @param {OnRouteChangeStep} [step] - The event step.
*/
export const useOnRouteChange = (
handler: OnRouteChangeHandler,
step: OnRouteChangeStep = 'start'
) => {
const router = useRouter();
useEffect(() => {
if (step === 'end') {
router.events.on('routeChangeComplete', handler);
return () => {
router.events.off('routeChangeComplete', handler);
};
}
router.events.on('routeChangeStart', handler);
return () => {
router.events.off('routeChangeStart', handler);
};
}, [handler, router.events, step]);
};
|
