Skip to main content
Version: v3.6.0

@rooks/use-localstorage

Localstorage hook for React. Syncs with localstorage values across components and browser windows automatically.


Build Status

Sets and retrieves a key from localStorage and subscribes to it for updates across windows.

Installation

npm install --save @rooks/use-localstorage

Importing the hook

import useLocalstorage from "@rooks/use-localstorage";

Usage

function Demo() {
const [value, set, remove] = useLocalstorage("my-value", 0);
// Can also be used as {value, set, remove}

return (
<p>
Value is {value}
<button onClick={() => set(value !== null ? value + 1 : 0)}>
Increment
</button>
<button onClick={remove}>Remove </button>
</p>
);
}

render(<Demo />);