# vuex-stateful-url

> StatefulURL is a Vuex plugin that can read and write the state from a query string

Latest version **1.0.2** (published 2020-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install vuex-stateful-url
pnpm add vuex-stateful-url
yarn add vuex-stateful-url
bun add vuex-stateful-url
```

## 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.0.2 |
| Published | 2020-09-03 |
| First published | 2020-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | James Doyle |
| Maintainers | james2doyle |
| Keywords | vuex, state, store, sync, tabs, origin |

## Links

- npm: https://www.npmjs.com/package/vuex-stateful-url
- Repository: https://github.com/james2doyle/vuex-stateful-url
- Homepage: https://github.com/james2doyle/vuex-stateful-url#readme
- Issues: https://github.com/james2doyle/vuex-stateful-url/issues
- npm.io page: https://npm.io/package/vuex-stateful-url

## Dependencies (1)

- [json-url](https://npm.io/package/json-url.md) ^2.6.0

## Alternatives

- [@reckona/mreact-store](https://npm.io/package/@reckona/mreact-store.md) — 976 weekly downloads
- [regular-state](https://npm.io/package/regular-state.md) — 410 weekly downloads
- [@pacote/flux-actions](https://npm.io/package/@pacote/flux-actions.md) — 65 weekly downloads
- [@pilotlab/lux-debug](https://npm.io/package/@pilotlab/lux-debug.md) — 39 weekly downloads
- [vue-persist-state](https://npm.io/package/vue-persist-state.md) — 19 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-09-03
- 1.0.1 — 2020-07-06
- 1.0.0 — 2020-07-04

## README

# Vuex StatefulURL

> StatefulURL is a Vuex plugin that can read and write the state from a query string

## Demo

![demo.gif](demo.gif)

They way it works is that it detects state changes and syncs a compressed object to a query string.

## Installation

* `npm install --save vuex-stateful-url`

```js
// es6
// import StatefulURL from 'vuex-stateful-url';
// commonjs
const StatefulURL = require('vuex-stateful-url');

export default new Vuex.Store({
  // ...
  plugins: [
    // your other plugins...
    StatefulURL()
  ],
  // ...
});
```

## Options

* `config.key`: the query string value to sync the state. default = `"state"` *(?state=blablabla)*

## License

[LICENSE](LICENSE)

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