diff --git a/packages/status-react/src/hooks/use-local-storage.tsx b/packages/status-react/src/hooks/use-local-storage.tsx new file mode 100644 index 00000000..d3f96bb1 --- /dev/null +++ b/packages/status-react/src/hooks/use-local-storage.tsx @@ -0,0 +1,96 @@ +import { useCallback, useEffect, useState } from 'react' + +// See: https://usehooks-ts.com/react-hook/use-event-listener +// import { useEventListener } from '../useEventListener' +import type { Dispatch, SetStateAction } from 'react' + +declare global { + interface WindowEventMap { + 'local-storage': CustomEvent + } +} + +type SetValue = Dispatch> + +export function useLocalStorage( + key: string, + initialValue: T +): [T, SetValue] { + // Get from local storage then + // parse stored json or return initialValue + const readValue = useCallback((): T => { + // Prevent build error "window is undefined" but keep keep working + if (typeof window === 'undefined') { + return initialValue + } + + try { + const item = window.localStorage.getItem(key) + return item ? (parseJSON(item) as T) : initialValue + } catch (error) { + console.warn(`Error reading localStorage key “${key}”:`, error) + return initialValue + } + }, [initialValue, key]) + + // State to store our value + // Pass initial state function to useState so logic is only executed once + const [storedValue, setStoredValue] = useState(readValue) + + // Return a wrapped version of useState's setter function that ... + // ... persists the new value to localStorage. + const setValue: SetValue = useCallback( + value => { + // Prevent build error "window is undefined" but keeps working + if (typeof window == 'undefined') { + console.warn( + `Tried setting localStorage key “${key}” even though environment is not a client` + ) + } + + try { + // Allow value to be a function so we have the same API as useState + const newValue = value instanceof Function ? value(storedValue) : value + + // Save to local storage + window.localStorage.setItem(key, JSON.stringify(newValue)) + + // Save state + setStoredValue(newValue) + + // We dispatch a custom event so every useLocalStorage hook are notified + window.dispatchEvent(new Event('local-storage')) + } catch (error) { + console.warn(`Error setting localStorage key “${key}”:`, error) + } + }, + [key, storedValue] + ) + + useEffect(() => { + setStoredValue(readValue()) + // eslint-disable-next-line react-hooks/exhaustive-deps + }, []) + + // const handleStorageChange = useCallback(() => { + // setStoredValue(readValue()) + // }, [readValue]) + + // this only works for other documents, not the current one + // useEventListener('storage', handleStorageChange) + + // this is a custom event, triggered in writeValueToLocalStorage + // See: useLocalStorage() + // useEventListener('local-storage', handleStorageChange) + + return [storedValue, setValue] +} + +function parseJSON(value: string | null): T | undefined { + try { + return value === 'undefined' ? undefined : JSON.parse(value ?? '') + } catch { + console.log('Parse error', { value }) + return undefined + } +}