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