aq-uiSessionStorageOptions
typeSource L9Type contract for SessionStorageOptions.
type SessionStorageOptions<T> = StorageOptions<T>Use Session Storage
Open-code aq-ui React hook for Use Session Storage.
Installation
pnpm dlx aq-ui@alpha add use-session-storageAPI reference
Client moduleImport the parts you need, then jump to an export for its contract.
Quick start
"use client"
import { useSessionStorage } from "@/hooks/use-session-storage"SessionStorageSetter
typeSource L10Type contract for SessionStorageSetter.
type SessionStorageSetter<T> = StorageSetter<T>useSessionStorage
functionSource L12Open-code aq-ui React hook for Use Session Storage.
function useSessionStorage<T>(key: string, initialValue: T | (() => T), options?: SessionStorageOptions<T>): [T, SessionStorageSetter<T>, () => void]- Returns
[T, SessionStorageSetter<T>, () => void]
Parameters
| Name | Type |
|---|---|
key | string |
initialValue | T | (() => T) |
options? | SessionStorageOptions<T> |
Registry dependencies
hook-storage
Files
- hooks/use-session-storage.ts