useLocalStorageState API

useLocalStorageState hook 的 API 参考。

导入

import useLocalStorageState from '@toolpad/core/useLocalStorageState';
// or
import { useLocalStorageState } from '@toolpad/core';

阅读关于最小化 bundle size 的指南，了解它们之间的区别。

const [state, setState] = useLocalStorageState('my-key', 'initial value');

参数

key: string | null 用于在 window.localStorage 中存储值的键。
initialValue: T | null | () => T 当在 window.localStorage 中找不到 key 时返回的值。可以通过为此参数提供函数来延迟计算该值。
options?: object 此 hook 的其他选项。
- codec?: Codec<T> 一种编解码器，可以将 T 类型的值编码和解码为字符串和从字符串解码。
  - parse: (raw: string) => T 将字符串值解码为 T 类型的值。
  - stringify: (value: T) => string 将 T 类型的值编码为字符串。

返回值

[T | null, React.Dispatch<React.SetStateAction<T | null>>] 类似于 React.setState 的结果，它返回一个元组，其中第一个项目表示状态，第二个项目是状态的 setter。