2025-04-07 19:16:56 -04:00
|
|
|
/* `useLocalStorage`
|
|
|
|
*
|
|
|
|
* Features:
|
|
|
|
* - JSON Serializing
|
|
|
|
* - Also value will be updated everywhere, when value updated (via `storage` event)
|
|
|
|
*/
|
|
|
|
|
2025-08-28 00:44:49 -04:00
|
|
|
import { useEffect, useState, useCallback } from 'react';
|
2025-04-07 19:16:56 -04:00
|
|
|
|
|
|
|
export default function useLocalStorage<T>(
|
|
|
|
key: string,
|
|
|
|
defaultValue: T,
|
|
|
|
globalSetState?: (value: T) => void,
|
2025-04-09 18:38:48 -04:00
|
|
|
storageCondition?: (value: T, rawCurrentValue?: string | null) => boolean,
|
2025-04-07 19:16:56 -04:00
|
|
|
): [T, (value: T) => void] {
|
|
|
|
const [value, setValue] = useState(defaultValue);
|
|
|
|
|
|
|
|
useEffect(() => {
|
|
|
|
const item = localStorage.getItem(key);
|
|
|
|
|
2025-04-09 18:38:48 -04:00
|
|
|
if (!item && !storageCondition) {
|
|
|
|
localStorage.setItem(key, JSON.stringify(defaultValue));
|
|
|
|
} else if (!item && storageCondition && storageCondition(defaultValue)) {
|
2025-04-07 19:16:56 -04:00
|
|
|
localStorage.setItem(key, JSON.stringify(defaultValue));
|
|
|
|
}
|
|
|
|
|
2025-04-09 16:11:16 -04:00
|
|
|
const initialValue = item && item !== 'undefined' ? JSON.parse(item) : defaultValue;
|
2025-04-07 19:16:56 -04:00
|
|
|
setValue(initialValue);
|
|
|
|
if (globalSetState) {
|
|
|
|
globalSetState(initialValue);
|
|
|
|
}
|
|
|
|
|
|
|
|
function handler(e: StorageEvent) {
|
|
|
|
if (e.key !== key) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
const lsi = localStorage.getItem(key);
|
|
|
|
setValue(JSON.parse(lsi ?? ''));
|
|
|
|
}
|
|
|
|
|
|
|
|
window.addEventListener('storage', handler);
|
|
|
|
|
|
|
|
return () => {
|
|
|
|
window.removeEventListener('storage', handler);
|
|
|
|
};
|
|
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
|
|
}, [key, globalSetState]);
|
|
|
|
|
2025-08-28 00:44:49 -04:00
|
|
|
const setValueWrap = useCallback(
|
|
|
|
(value: T) => {
|
|
|
|
try {
|
|
|
|
setValue(value);
|
|
|
|
const storeLocal = () => {
|
|
|
|
localStorage.setItem(key, JSON.stringify(value));
|
|
|
|
window?.dispatchEvent(new StorageEvent('storage', { key }));
|
|
|
|
};
|
|
|
|
if (!storageCondition) {
|
|
|
|
storeLocal();
|
|
|
|
} else if (storageCondition(value, localStorage.getItem(key))) {
|
|
|
|
storeLocal();
|
|
|
|
}
|
|
|
|
globalSetState?.(value);
|
|
|
|
} catch (e) {
|
|
|
|
console.error(e);
|
2025-04-07 19:16:56 -04:00
|
|
|
}
|
2025-08-28 00:44:49 -04:00
|
|
|
},
|
|
|
|
[key, globalSetState, storageCondition],
|
|
|
|
);
|
2025-04-07 19:16:56 -04:00
|
|
|
|
|
|
|
return [value, setValueWrap];
|
|
|
|
}
|