Skip to content

buzuosheng/use-localstorage

Repository files navigation

@buzuosheng/use-localstorage

Access Local Storage with React Hooks

Demo

https://app-demo-git-main-buzuosheng.vercel.app/uselocalstorage

Open Chrome devtool => Application => Local Storage to see localstorage.

Installation

npm i @buzuosheng/use-localstorage

Usage

const [item, setItem] = useLocalStorage(key, { initialValue, prefix, age });

age is effective duration of localstorage item, it will be deal with ms.

So use it like this:

{age: '2 days'}  // 172800000
{age: '1d'}      // 86400000
{age: '10h'}     // 36000000
{age: '2.5 hrs'} // 9000000
{age: '2h'}      // 7200000
{age: '1m'}      // 60000
{age: '5s'}      // 5000
{age: '1y'}      // 31557600000
{age: '100'}     // 100

More information to see ms

Example

import { useLocalStorage } from '@buzuosheng/use-localstorage'

const App = () => {
  const [item, setItem] = useLocalStorage('name', { initialValue: '123' })
  // const [item, setItem] = useLocalStorage('name', {
  //   initialValue: 'initial value',
  //   prefix: 'Prefix:',
  //   age: '1d'
  // })
  return (
    < div className="use-localstorage" >
      <h1>For example: set the key of localstorage to 'name' </h1>
      <div>
        <label>
          name:
          <input
            type="text"
            placeholder="input localStorage.value"
            value={item || ''}
            onChange={e => setItem(e.target.value)}
          />
        </label>
      </div>
    </ div>
  )
}

About

access local storage with React hooks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published