From 36baf3e5725aeae00d81d3a082b3c04074e09f8e Mon Sep 17 00:00:00 2001
From: Armand Philippot <git@armandphilippot.com>
Date: Wed, 15 Nov 2023 17:09:13 +0100
Subject: refactor(hooks): replace useRouteChange with useOnRouteChange hook

* handle both event start and event complete
* clean the effect
* add tests
---
 .../use-on-route-change/use-on-route-change.ts     | 35 ++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 src/utils/hooks/use-on-route-change/use-on-route-change.ts

(limited to 'src/utils/hooks/use-on-route-change/use-on-route-change.ts')

diff --git a/src/utils/hooks/use-on-route-change/use-on-route-change.ts b/src/utils/hooks/use-on-route-change/use-on-route-change.ts
new file mode 100644
index 0000000..85e7060
--- /dev/null
+++ b/src/utils/hooks/use-on-route-change/use-on-route-change.ts
@@ -0,0 +1,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]);
+};
-- 
cgit v1.2.3