vue-save-state
Version:
A Vue mixin to save the state of a component to local storage
173 lines (112 loc) • 4.6 kB
Markdown
# A Vue mixin to save the state of a component to local storage
[](https://npmjs.com/package/vue-save-state)
[](LICENSE.md)
[](https://travis-ci.org/spatie/vue-save-state)
[](https://npmjs.com/package/vue-save-state)
This package provides a `SaveState` mixin that automatically saves any change in the state of your component to localStorage. The next time that component gets initialized it will restore its state from the saved values in local storage.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## Postcardware
You're free to use this package (it's [MIT-licensed](LICENSE.md)), but if it makes it to your production environment we highly apprecatie you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
All postcards are published [on our website](https://spatie.be/en/opensource/postcards).
## Install
You can install the package via yarn:
```bash
yarn add vue-save-state
```
or npm
```bash
npm install vue-save-state
```
## Usage
In order to save the state of your component you'll need to add the `SaveState` mixin:
```js
import saveState from 'vue-save-state';
export default {
mixins: [saveState],
...
}
```
Next you'll need to add a method called `getSaveStateConfig`:
```js
import saveState from 'vue-save-state';
export default {
mixins: [saveState],
// ...
methods: {
getSaveStateConfig() {
return {
'cacheKey': 'nameOfYourComponent',
};
},
},
}
```
With these steps done any change to the state of your component will get written to local storage. The value given in `cacheKey` determines to which key in local storage the state of this component will get written. When the component is created it'll restore its state from local storage.
## Only save certain properties of the state
There's also a configuration option to determine which properties of the state should be saved/restored:
```js
import saveState from 'vue-save-state';
export default {
// ...
methods: {
getSaveStateConfig() {
return {
'cacheKey': 'nameOfYourComponent',
'saveProperties': ['title', 'text'],
};
},
},
}
```
With this configuration only the `title` and `text` properties of your state will get saved/restored.
Alternatively you could specify which fields to ignore:
```js
import saveState from 'vue-save-state';
export default {
// ...
methods: {
getSaveStateConfig() {
return {
'cacheKey': 'nameOfYourComponent',
'ignoreProperties': ['title'],
};
},
},
}
```
In this scenario all fields except for the `title` property in your state will get saved/restored.
## Transforming the state on load
If you want to transform the values stored in local storage before loading the into the state of the component add an `onLoad` function to the object return by `getSaveStateConfig`.
```js
import saveState from 'vue-save-state';
export default {
// ...
methods: {
getSaveStateConfig() {
return {
'onLoad': (key, value) => {
//return a new value
},
};
},
},
}
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ npm run test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please contact [Freek Van der Herten](https://github.com/freekmurze) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.