A hook that manages a state variable in sync with local storage, allowing data persistence across browser sessions.

useLocalStorage

A nifty little hook that keeps your state variable in sync with the local storage, ensuring your data sticks around even when the browser session ends.

Usage

import { useLocalStorage } from "rehooks-ts";
 
const [name, setName] = useLocalStorage("name", "John Doe");

API

useLocalStorage

function useLocalStorage<T>(
  key: string,
  initialValue: T,
): [T, (value: T) => void];

Parameters

Name	Type	Description
`key`	`string`	The key for the local storage item.
`initialValue`	`T`	The initial value for the state variable.

Returns

Name	Type	Description
`storedValue`	`T`	The current value synchronized with local storage.
`setValue`	`(value: T) => void`	A function to update the state and sync it with local storage.

useLocalStorage

useLocalStorage

Usage

API

useLocalStorage

Parameters

Returns

On this page