useSessionStorage#

A useStorage preset backed by window.sessionStorage — a signal that persists for the current tab session and is cleared when the tab closes. Browser composable — import from @sigx/use-web.

TypeScript
import { useSessionStorage } from '@sigx/use-web';

const draft = useSessionStorage('draft', '');
draft.value = 'hello';   // persisted for this tab session

Signature#

TypeScript
function useSessionStorage<T extends Primitive>(key: string, defaults: T, options?: UseStorageOptions<T>): PrimitiveSignal<T>;
function useSessionStorage<T extends object>(key: string, defaults: T, options?: UseStorageOptions<T>): Signal<T>;

Same two overloads as useStorage: an object default returns a deep-reactive Signal<T> that auto-persists on mutation; a primitive default returns a PrimitiveSignal<T> that persists on .value write.

See useStorage for the full semantics — object proxies, serializers, options, and SSR behaviour.

See also#

  • useStorage — the flagship, with every option and the deep-reactive model.
  • useLocalStorage — the same preset persisted across sessions.