useLocalStorageState API

useLocalStorageState Hook 的 API 參考。

導入

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

閱讀這份關於最小化 bundle 大小的指南，瞭解差異。

參考

useLocalStorageState

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> 一個編碼解碼器，可以將 V 型別的值編碼和解碼為字串。
    • parse：(raw: string) => T 將字串值解碼為 V 型別的值。
    • stringify：(value: T) => string 將 V 型別的值編碼為字串。

回傳

[T | null, React.Dispatch<React.SetStateAction<T | null>>] 類似於 React.setState 的結果，它回傳一個元組，其中第一個項目表示狀態，第二個項目是狀態的設定器。