use-browser-storage

React hook to use browser's storage. Currently supporting localStorage and sessionStorage.

Install

npm install --save use-browser-storage

Usage

import * as React from 'react'

import { useBrowserStorage } from 'use-browser-storage'

const Component = () => {
  const { getItem, setItem, removeItem } = useBrowserStorage({ forceUpdate: true });

  React.useEffect(() => {
    window.setTimeout(() => {
      setItem('welcome', 'Hi Dev, welcome!')
    }, 1000);
  }, [])

  return (
    <div>
      {getItem('welcome')}
    </div>
  )
}

Options

Option	Type	Default Value	Defination
type?	localStorage or sessionStorage	localStorage	Specify type of browser storage.
timestamp?	boolean	false	Store values with timestamp.
forceUpdate?	boolean	false	Update react component after calling setItem and removeItem

Note: ? denotes optional property

License

MIT © ravid7000