# use-store

> Shared, persistable React.js useState() hook effect, no context required

Latest version **1.7.3** (published 2019-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install use-store
pnpm add use-store
yarn add use-store
bun add use-store
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.3 |
| Published | 2019-10-10 |
| First published | 2019-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Kevin R. Whitley |
| Maintainers | krwhitley |
| Keywords | react, hooks, store, useState, useStore, localStorage, persist |

## Links

- npm: https://www.npmjs.com/package/use-store
- Repository: https://github.com/kwhitley/use-store
- Issues: https://github.com/kwhitley/use-store/issues
- npm.io page: https://npm.io/package/use-store

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.7.3 (latest) — 2019-10-10
- 1.7.2 — 2019-10-10

## README

Cross-component, persistable useState() effect, without context
===

# Why?
Even with the advent of React hooks, cross-component shared state
is still being solved with either context/provider hooks (messy), or traditional
stores like redux/mobx (messier).  This store more or less mirrors the signature of
the incredibly elegant `useState()` hook, with optional local persistence built-in.

# API
### useStore(namespace, [initialValue=undefined], [options={}])
returns `[ value, setValue ]` pair, identical to `useState()` in React
```js
import useStore from 'use-store'
// note: import { useStore } from 'use-store' will continue to work

// must be called inside a React component
let [ value, setValue ] = useStore('foo')
// value = undefined
setValue(3)
// value = 3
```

###### Arguments
- `namespace` (string) **required** - this is the reference you'll share throughout the app for a specific value.  E.g. `useStore('myValue')`
- `initialValue` (anything) **optional** - optional default value which will be set by the first component that encounters this hook on a given namespace.  This will be ignored if persist is enabled and value found locally.
- `options` (object) **optional** - options for the hook (see below):
  - `persist` (boolean, default=false)

### globalStore.set(namespace, initialValue, options) // params identical to `useStore()` above
For manually setting initial values and persist options so individual components don't have to (also to solve race conditions)
```js
import { globalStore } from 'use-store'

globalStore.set('foo', 'bar', { persist: true })
```

# Example (Elaborate)
```js
  // ComponentA.js

  import React from 'react'
  import useStore from 'use-store'

  export default function ComponentA() {
    let [ value, setValue ] = useStore('myValue', 3)

    return (
      <div>
        ComponentA:value = { value }

        <button onClick={() => setValue(value + 1)}>
          Increment
        </button>
      </div>
    )
  }
```

```js
  // ComponentB.js

  import React from 'react'
  import useStore from 'use-store'
  import ComponentA from './ComponentA'

  export default function ComponentB() {
    let [ value, setValue ] = useStore('myValue', 3)

    return (
      <div>
        ComponentB:value = { value } // this will increment as ComponentA clicks are registered

        <ComponentA />
      </div>
    )
  }
```

# Example (Event Handlers)
```js
  import React from 'react'
  import useStore from 'use-store'

  export default function ComponentA() {
    let [ value, setValue ] = useStore('myValue', 3)

    // traditional event handler no longer needed for inputs
    const changeHandler = (e) => setValue(e.target.value)

    return (
      <div>
        <!-- this still works -->
        <input value={value} onChange={changeHandler} />

        <!-- but so does this (no need to wrap the setter in an event handler) -->
        <input value={value} onChange={setValue} />
      </div>
    )
  }
```

---
_Source: https://npm.io/package/use-store · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._