SSE Hooks

useReadLocalStorage

Custom hook that reads a value from localStorage, closely related to useLocalStorage().

Installation

npx sse-hooks add use-read-local-storage

Usage

example.ts
import { useReadLocalStorage } from "./{hooks file}";

const storedData = useReadLocalStorage("myKey");
// Access the stored data from local storage.

API

Parameters

Prop Default Type
options-

Options<T, false>

key-

string

Returns

Return Value Default Type
return-

T | null

Hook return value

Types Aliases

No specific type aliases defined for this component.

Changelog

c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation

30da4 — feat: add new hooks and their metadata

cf13e — feat: add custom hooks for step navigation, ternary dark mode, timeout, toggle, unmount, and window size

Built with Love • © 2026