useSessionStorageState API

useSessionStorageState 鉤子的 API 參考文檔。

導入

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

閱讀這篇關於最小化 bundle 大小的指南，了解它們之間的差異。

參考

useSessionStorageState

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

參數

• key: string | null 儲存在 window.sessionStorage 中的值的鍵。
• initialValue: T | null | () => T 當在 window.sessionStorage 中找不到 key 時返回的值。可以通過為此參數提供函數來延遲計算該值。
• options?: object 此鉤子的其他選項。
  • codec?: Codec<T> 一種編解碼器，可以將 V 類型的值編碼和解碼為字串以及從字串解碼為 V 類型的值。
    • parse: (raw: string) => T 將字串值解碼為 V 類型的值。
    • stringify: (value: T) => string 將 V 類型的值編碼為字串。

返回值

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