useLocalStorage

轻松管理 localStorage

Usage

实时编辑器

function Demo() {
  // bind string
  const [value, setValue] = useLocalStorage("my-key", "key");

  return (
    <div>
      <div>值: {value}</div>
      <button onClick={() => setValue("bar")}>设置为bar</button>
      <button onClick={() => setValue("baz")}>设置为baz</button>
      {/* delete data from storage */}
      <button onClick={() => setValue(null)}>移除</button>
    </div>
  );
};

结果

值: key

API

useLocalStorage

Returns

readonly [T | null, React.Dispatch<React.SetStateAction<T | null>>]: 包含以下元素的元组：

• localStorage 的当前值。
• 更新 localStorage 值的函数。

Arguments

参数名	描述	类型	默认值
key	键值	string (必填)	-
defaultValue	默认值	T | undefined	-
options	可选参数	UseLocalStorageOptions<T> | undefined	-

UseLocalStorageOptions

参数名	描述	类型	默认值
serializer	自定义数据序列化	UseLocalStorageSerializer<T>	-
onError	错误回调	(error: unknown) => void	console.error
effectStorageValue	首次挂载时没有数据时设置到 storage, 已弃用	T | (() => T)	-
mountStorageValue	首次挂载时没有数据时设置到 storage	T | (() => T)	-
listenToStorageChanges	监听 storage 变化	boolean	true

UseLocalStorageSerializer

参数名	描述	类型	默认值
read	自定义数据读取	(raw: string) => T (必填)	-
write	自定义数据写入	(value: T) => string (必填)	-