# redux-localstorage-adapter

> Localstorage adapter for redux

Latest version **1.1.1** (published 2017-02-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install redux-localstorage-adapter
pnpm add redux-localstorage-adapter
yarn add redux-localstorage-adapter
bun add redux-localstorage-adapter
```

## 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.1.1 |
| Published | 2017-02-14 |
| First published | 2016-12-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Maksim Chekrishov |
| Maintainers | m.chekryshov |
| Keywords | redux, localstorage-api, localstorage, localstorage-adapter, redux-localstorage |

## Links

- npm: https://www.npmjs.com/package/redux-localstorage-adapter
- Repository: https://github.com/maksim-chekrishov/redux-localstorage-adapter
- Homepage: https://github.com/maksim-chekrishov/redux-localstorage-adapter#readme
- Issues: https://github.com/maksim-chekrishov/redux-localstorage-adapter/issues
- npm.io page: https://npm.io/package/redux-localstorage-adapter

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2017-02-14
- 1.1.0 — 2017-02-14
- 1.0.9 — 2017-02-14
- 1.0.8 — 2017-02-14
- 1.0.7 — 2017-02-09
- 1.0.6 — 2017-02-08
- 1.0.5 — 2017-02-08
- 1.0.4 — 2017-02-08
- 1.0.3 — 2016-12-13
- 1.0.2 — 2016-12-13
- 1.0.1 — 2016-12-13
- 1.0.0 — 2016-12-13

## README

# redux-localstorage-adapter
Localstorage adapter for redux

[![npm version](https://badge.fury.io/js/redux-localstorage-adapter.svg)](https://badge.fury.io/js/redux-localstorage-adapter)

##Main points
- Keep your components pure.
- Sync localstorage and store and use actions to change it.


##Setup

###your/known-localstorage-api.js

```js
import LocalStorageApi from 'redux-localstorage-adapter';

const knownLocalStorageKeys = [
  'NEWS_SIMILAR_ENTRIES_TEMPLATE',
  'FIRE_THEME_ENABLED'
];

const knownApi = {};

knownLocalStorageKeys.forEach(key=> {
  knownApi[key] = new LocalStorageApi(key);
});

export default knownApi;
```

###your/localstorage-reducer.js

```js
import knownLocalStorageApi from 'your/known-localstorage-api';
import {combineReducers} from 'redux';

export default combineReducers(_.mapValues(knownLocalStorageApi, api => api.reducer));

```

###your/index-reducer.js

```js
import localStorage from 'your/localstorage-reducer';
import {combineReducers} from 'redux';

export default combineReducers({
  localStorage
  //..
});
```

###your/localstorage-actions.js

```js
import knownLocalStorageApi from 'your/known-localstorage-api';

export default _.mapValues(knownLocalStorageApi, api => api.actions);
```

##Usage

###your/some-redux-container.js
```js
import localStorageActions from 'your/localstorage-actions';

class SomeComponent extends BaseComponent {
/...
 onCarIconClick = ()=> {
    this.props.setFire(!this.props.fireEnabled);
  }
/...
}

const mapStateToProps = (state) => ({
  fireEnabled: state.localStorage.FIRE_THEME_ENABLED
});

const mapDispatchToProps = {
  setFire: localStorageActions.FIRE_THEME_ENABLED.setItem
}

export default connect(mapStateToProps, mapDispatchToProps)(SomeComponent);
```

##Enjoy the redux flow

![Image devTools](https://raw.githubusercontent.com/maksim-chekrishov/redux-localstorage-adapter/master/readme-src/dev-tools.png)

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