# reactjs-localstorage

> Easy use localstorage in Reactjs

Latest version **1.0.1** (published 2020-05-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install reactjs-localstorage
pnpm add reactjs-localstorage
yarn add reactjs-localstorage
bun add reactjs-localstorage
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-05-18 |
| First published | 2016-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/reactjs-localstorage) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Dmitry Kalinin |
| Maintainers | null-none |
| Keywords | reactjs, localstorage, react, local storage |

## Links

- npm: https://www.npmjs.com/package/reactjs-localstorage
- Repository: https://github.com/null-none/react-localstorage
- Issues: https://github.com/null-none/react-localstorage/issues
- npm.io page: https://npm.io/package/reactjs-localstorage

## 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.0.1 (latest) — 2020-05-18
- 1.0.0 — 2020-05-15
- 0.0.8 — 2019-10-05
- 0.0.7 — 2018-08-08
- 0.0.6 — 2017-12-31
- 0.0.5 — 2016-11-22
- 0.0.4 — 2016-11-21
- 0.0.3 — 2016-11-20
- 0.0.2 — 2016-11-20
- 0.0.1 — 2016-11-20

## README

# reactLocalStorage
Easy use localstorage in Reactjs

https://www.npmjs.com/package/reactjs-localstorage


## Installation

```bash
npm install reactjs-localstorage
```
or
```bash
yarn add reactjs-localstorage
```

## Examples

```javascript
import {reactLocalStorage} from 'reactjs-localstorage';

reactLocalStorage.set('var', true);
reactLocalStorage.get('var', true);
reactLocalStorage.setObject('var', {'test': 'test'});
reactLocalStorage.getObject('var');
reactLocalStorage.remove('var');
reactLocalStorage.clear();
```

## Test

```bash
npm run test
```

## API Guide
- `reactLocalStorage.set(key, value)`
- `reactLocalStorage.get(key, deafultValue=undefined, silent=true)`
- `reactLocalStorage.setObject(key, object)`
- `reactLoacStorage.getObject(key, defaultValue={}, silent=true)`
- `reactLocalStorage.remove(key)`
- `reactLocalStorage.clear()`

**silent**:
- `true`: Will not throw exception instead will return defaultValue
- `false`: Will throw exception

## License
MIT

## Donation Button

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YYZQ6ZRZ3EW5C)

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