useLocalStorage

Hook that manages local storage value

browser

test coverage

Last changed: last month

TIP

This hook uses localStorage browser api to provide enhanced functionality. Make sure to check for compatibility with different browsers when using this api

Installation

Library

CLI

Manual

import { useLocalStorage } from '@siberiacancode/reactuse';

Usage

const { value, set, remove } = useLocalStorage('key', 'value');

Demo

source

Api

Parameters

Name	Type	Default	Note
key	string	-	The key of the storage
initialValue?	UseStorageInitialValue<Value>	-	The initial value of the storage
options?	UseStorageOptions<Value>	-	The options of the storage

Type declaration

import type { UseStorageInitialValue, UseStorageOptions } from '../useStorage/useStorage';

Source

Source • Demo

Contributors

D

debabin

H

hywax