@rickbrown/use-local-storage

@rickbrown/use-local-storage

Description

useLocalStorage is a custom React hook, which simplifies using the browsers local storage, when developing React applications.

Installation

Use the package manager yarn to install the useLocalStorage hook.

yarn add @rickbrown/use-local-storage

Usage

import { useLocalStorage } from '@rickbrown/use-local-storage'

const Example = () => {
  // Optionally accepts 2 arguments for its initial value.
  // ('key','value')
  const [name, setName] = useLocalStorage()
  
  const [newName, setNewName] = React.useState('')

  return (
    <div>
      <p>Current value in local storage: {name}</p>
      <input
        type="text"
        placeholder="Enter your name"
        value={newName}
        onChange={e => setNewName(e.target.value)}
      />
      <button onClick={() => setName(newName)}>
        Click To Update Local Storage
      </button>
    </div>
  )
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT