aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils/hooks/use-local-storage.tsx
diff options
context:
space:
mode:
Diffstat (limited to 'src/utils/hooks/use-local-storage.tsx')
-rw-r--r--src/utils/hooks/use-local-storage.tsx35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/utils/hooks/use-local-storage.tsx b/src/utils/hooks/use-local-storage.tsx
new file mode 100644
index 0000000..da0292b
--- /dev/null
+++ b/src/utils/hooks/use-local-storage.tsx
@@ -0,0 +1,35 @@
+import { LocalStorage } from '@services/local-storage';
+import { Dispatch, SetStateAction, useEffect, useState } from 'react';
+
+export type UseLocalStorageReturn<T> = {
+ value: T;
+ setValue: Dispatch<SetStateAction<T>>;
+};
+
+/**
+ * Use the local storage.
+ *
+ * @param {string} key - The storage local key.
+ * @param {T} [fallbackValue] - A fallback value if local storage is empty.
+ * @returns {UseLocalStorageReturn<T>} An object with value and setValue.
+ */
+const useLocalStorage = <T extends unknown>(
+ key: string,
+ fallbackValue: T
+): UseLocalStorageReturn<T> => {
+ const getInitialValue = () => {
+ if (typeof window === 'undefined') return fallbackValue;
+ const storedValue = LocalStorage.get<T>(key);
+ return storedValue || fallbackValue;
+ };
+
+ const [value, setValue] = useState<T>(getInitialValue);
+
+ useEffect(() => {
+ LocalStorage.set(key, value);
+ }, [key, value]);
+
+ return { value, setValue };
+};
+
+export default useLocalStorage;