Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
import { useCallback, useEffect, useRef, useSyncExternalStore } from "react";
type SetStateAction<T> = T | ((prevState: T) => T);
const dispatchStorageEvent = (key: string, newValue: string | null): void => {
window.dispatchEvent(new StorageEvent("storage", { key, newValue }));
};
const setLocalStorageItem = (key: string, value: unknown): void => {
const stringifiedValue = JSON.stringify(value);
window.localStorage.setItem(key, stringifiedValue);
dispatchStorageEvent(key, stringifiedValue);
};
const removeLocalStorageItem = (key: string): void => {
window.localStorage.removeItem(key);
dispatchStorageEvent(key, null);
};
const getLocalStorageItem = (key: string): string | null => {
return window.localStorage.getItem(key);
};
const getLocalStorageServerSnapshot = (): never => {
throw Error("useLocalStorage is a client-only hook");
};
export const useLocalStorageState = <T>(
key: string,
initialValue: T,
{ tabLocal = false }: { tabLocal?: boolean } = {}
): [T, (value: SetStateAction<T>) => void] => {
// With tabLocal, localStorage is read once per key and then only followed for same-tab writes,
// so another tab's write never reaches this tab, not even on a later re-render. It is opt-in
// because a functional update then starts from this tab's copy, and for a value that holds
// entries from several tabs (a map keyed by org) the write would drop the other tabs' entries.
const snapshot = useRef<{ key: string; value: string | null } | null>(null);
if (snapshot.current?.key !== key) {
snapshot.current = { key, value: getLocalStorageItem(key) };
}
const subscribe = useCallback(
(callback: () => void) => {
// Same-tab events are dispatched manually and have no storageArea; native events from
// other tabs do.
const handler = (e: StorageEvent) => {
if (e.storageArea || e.key !== key) return;
snapshot.current = { key, value: e.newValue };
callback();
};
window.addEventListener("storage", handler);
return () => window.removeEventListener("storage", handler);
},
[key]
);
const store = useSyncExternalStore(
subscribe,
() => (tabLocal ? (snapshot.current?.value ?? null) : getLocalStorageItem(key)),
getLocalStorageServerSnapshot
);
const setState = useCallback(
(v: SetStateAction<T>): void => {
try {
const nextState =
typeof v === "function" ? (v as (prevState: T) => T)(JSON.parse(store || "null")) : v;
if (nextState === undefined || nextState === null) {
removeLocalStorageItem(key);
} else {
setLocalStorageItem(key, nextState);
}
} catch (e) {
console.warn(e);
}
},
[key, store]
);
useEffect(() => {
if (getLocalStorageItem(key) === null && typeof initialValue !== "undefined") {
setLocalStorageItem(key, initialValue);
}
}, [key, initialValue]);
return [store ? JSON.parse(store) : initialValue, setState];
};