fn
useSessionStorage
v0.0.12testeddemoReactive sessionStorage binding — creates a ref synced with `window.sessionStorage`
Examples
ts
const count = useSessionStorage('my-count', 0);ts
const state = useSessionStorage('my-state', { hello: 'world' });Demo
Loading demo…
Signatures
ts
export function useSessionStorage<T extends string>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): RemovableRef<T>;ts
export function useSessionStorage<T extends number>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): RemovableRef<T>;ts
export function useSessionStorage<T extends boolean>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): RemovableRef<T>;ts
export function useSessionStorage<T>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): RemovableRef<T>;ts
export function useSessionStorage<T = unknown>(key: MaybeRefOrGetter<string>, initialValue: MaybeRefOrGetter<null>, options?: UseStorageOptions<T>): RemovableRef<T>;Type Parameters
TParameters
| Parameter | Type | Description |
|---|---|---|
key | MaybeRefOrGetter<string> | The storage key (can be reactive) |
initialValue | MaybeRefOrGetter<T> | The initial/default value |
options? | UseStorageOptions<T> | Options |
Returns
RemovableRef<T>A reactive ref synced with sessionStorage