useLocalStorage

轻松管理 localStorage

useLocalStorage 将 React 状态绑定到一个 localStorage 键。它返回一个类似 useState 的 [value, setValue] 元组。值在挂载时从存储中读取，每次调用 setValue 时写回。将值设为 null 移除该键。可以为非字符串数据类型提供自定义序列化器，hook 默认监听跨标签页的 storage 事件，以便一个标签页的更改反映在其他标签页中。

使用场景

  • 跨页面重载持久化用户偏好（主题、语言、布局）
  • 缓存表单草稿或应用状态，以便用户可以从中断处继续
  • 通过 storage 事件在浏览器标签页之间共享简单状态

注意事项

  • 持久化：数据在页面重载和浏览器重启后仍然存在。如果只需要当前会话的数据，请使用 useSessionStorage。
  • 跨标签页同步：默认情况下，hook 监听 storage 事件，一个标签页的更改会更新其他标签页。通过 listenToStorageChanges: false 禁用。
  • 自定义序列化：对于对象或非字符串值，在选项中提供 serializer.read 和 serializer.write 函数。默认行为对对象使用 JSON 序列化，对字符串值使用原始字符串。
  • 参见 useSessionStorage 了解会话作用域存储，以及 useCookie 了解基于 cookie 的持久化。

Usage

Live Editor
function Demo() {
  // 绑定字符串
  const [value, setValue] = useLocalStorage("my-key", "key");
  
  // 绑定对象（使用自定义序列化器）
  const [myObj, setMyObj] = useLocalStorage(
    "myObj",
    {
      name: "test",
    },
    {
      serializer: {
        read: (val) => {
          console.log("读取", val);
          return JSON.parse(val);
        },
        write: (val) => {
          console.log("写入", val);
          return JSON.stringify(val);
        },
      },
    }
  );

  return (
    <div>
      <div>
        <h3>字符串值</h3>
        <div>值: {value}</div>
        <button onClick={() => setValue("bar")}>设置为 "bar"</button>
        <button onClick={() => setValue("baz")}>设置为 "baz"</button>
        <button onClick={() => setValue(null)}>移除</button>
      </div>
      
      <div style={{ marginTop: "20px" }}>
        <h3>对象值</h3>
        <div>对象: {JSON.stringify(myObj)}</div>
        <button onClick={() => setMyObj({ name: "updated" })}>
          更新对象
        </button>
        <button onClick={() => setMyObj({ name: "test", count: 1 })}>
          添加属性
        </button>
        <button onClick={() => setMyObj(null)}>移除对象</button>
      </div>
    </div>
  );
};
Result

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) => voidconsole.error
effectStorageValue首次挂载时没有数据时设置到 storage, 已弃用T | (() => T)-
mountStorageValue首次挂载时没有数据时设置到 storageT | (() => T)-
listenToStorageChanges监听 storage 变化booleantrue

UseLocalStorageSerializer

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