react-storage-hook

Globals / react-storage-hook /

requires prop-types

requires react

requires react-dom

summary A react state hook that is synchronised and persisted in localStorage, and between tabs.

version 1.0.0

author zemnmez

copyright zemnmez 2019

license MIT

yarn add react-storage-hook

Check out the live example!

example

import React from 'react'
import { useStorage } from 'react-storage-hook'

export const SavedTextarea = () => {
  const [text, setText] = useStorage('saved-text', {
    placeholder: ""
  });

  const onChange = e => setText(e.target.value);

  return <textarea {...{
    onChange,
    value: text
  }}/>
}

• immutableValue

• useStorage

Ƭ immutableValue: any

Defined in index.tsx:21

An immutableValue is a value that would be returned by immutable.js's immutable.fromJS.

▸ useStorage<InputType>(name: string, __namedParameters: object): [immutableValue, setStored<InputType>]

Defined in index.tsx:39

useStorage is a react hook providing integration and synchronization with localStorage. The value returned will likely not be the same type as input, unless the input type is an immutable value that would be produced by immutable.js.

The output value will always be an immutableValue of the kind produced by immutable.js.

Type parameters:

▪ InputType: __type

Parameters:

▪ name: string

The key used to store the data in.

▪ __namedParameters: object

Returns: [immutableValue, setStored<InputType>]