Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bazzite/vue-warehouse
A Cross-browser storage for Vue.js and Nuxt.js, with plugins support and easy extensibility based on Store.js.
https://github.com/bazzite/vue-warehouse
browser-storage cookie cookies cross-browser expiration localstorage marquez nuxt nuxt-module storage storage-functionality vue vue-plugin
Last synced: 3 months ago
JSON representation
A Cross-browser storage for Vue.js and Nuxt.js, with plugins support and easy extensibility based on Store.js.
- Host: GitHub
- URL: https://github.com/bazzite/vue-warehouse
- Owner: juliomrqz
- License: mit
- Created: 2018-03-23T13:43:32.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-07T04:04:47.000Z (almost 2 years ago)
- Last Synced: 2024-05-22T23:56:11.740Z (6 months ago)
- Topics: browser-storage, cookie, cookies, cross-browser, expiration, localstorage, marquez, nuxt, nuxt-module, storage, storage-functionality, vue, vue-plugin
- Language: JavaScript
- Homepage: https://marquez.co/docs/vue-warehouse
- Size: 3.88 MB
- Stars: 174
- Watchers: 9
- Forks: 9
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.codacy.com/app/juliomrqz/vue-warehouse?utm_source=github.com&utm_medium=referral&utm_content=juliomrqz/vue-warehouse&utm_campaign=Badge_Grade)
[](https://travis-ci.org/juliomrqz/vue-warehouse)
[](https://ci.appveyor.com/project/juliomrqz/vue-warehouse)
[](https://codecov.io/gh/juliomrqz/vue-warehouse)
[](https://david-dm.org/juliomrqz/vue-warehouse?type=peer)
[](https://david-dm.org/juliomrqz/vue-warehouse?type=dev)
[](https://www.npmjs.com/package/vue-warehouse)
[](https://raw.githubusercontent.com/juliomrqz/vue-warehouse/develop/LICENSE)
# Vue.js Warehouse
A Cross-browser storage for **Vue.js** and **Nuxt.js**, with plugins support and easy extensibility based on **Store.js**.
This plugin will **pick the best available browser storage**, and automatically **falls back to the first available** storage that works.
*Read this in other languages: [English][documentation], [Español][documentation-es]*
## Features
* Backed by the great library [Store.js][storejs]
* Support for multiple Storages (localStorage, cookies, etc.)
* Basic key/value storage functionality (`get/set/remove/each`)
* Easy integration with Vue.js
* Support for Nuxt.js
* Get notified with Vuex when the stored values change
## Why use this plugin
Some reasons why you could consider to use this plugin:
* Use a **fallback Browser storage** method in case the user's browser has limitations. Safari in Private mode can deny writing data in localStorage.
* Easy extensibility with **Plugins**. Support for expiring stored values at a given time, declare default values, etc.
* A **consistent API** across browsers for a key/value storage functionality.
* Easy definition of **alternative Storage methods**. For example: you could reuse a Vue Component, that relies on a storage method, in the user's browser (using **localStorage**) or a mobile app (using **NativeScript application-settings** module) just by changing the storage method without modifying the internal logic of the component.
* **Synchronization** of stored values changes with **Vuex**.
## Installation
This module is distributed via [npm][npm-homepage] which is bundled with [node][node-homepage] and should be installed as one of your project's `dependencies`:
```bash
npm install --save store vue-warehouse
```
or
```bash
yarn add store vue-warehouse
```
## Example of use
Suppose you want to use **localStorage** by default and **cookies** as an alternative in case your user's browser doesn't allow any interaction with **localStorage** (Safari Private mode). Besides, you want to define **defaults values** and an **expiration date** for all the data that is going to be saved.
### Configuration for Vue.js
```javascript
import Vue from 'vue'
import VueWarehouse from 'vue-warehouse'
import VueWarehouseSync from 'vue-warehouse/sync'
import VuexStore from './vuex/store' // vuex store instance
import VueWarehouseStore from 'store' // vue-warehouse store instance
VueWarehouseSync(VuexStore, VueWarehouseStore)
Vue.use(VueWarehouse, {
store: VueWarehouseStore,
plugins: [
require('store/plugins/expire'), // Expire stored values at a given time
require('store/plugins/defaults') // Declare default values
],
storages: [
require('store/storages/localStorage'), // localStorage support
require('store/storages/cookieStorage') // cookies support
]
})
```
### Configuration for Nuxt.js
```javascript
{
modules: [
['vue-warehouse/nuxt',
{
vuex: true,
plugins: [
'store/plugins/expire',
'store/plugins/defaults'
],
storages: [
'store/storages/localStorage',
'store/storages/cookieStorage'
]
}
],
]
}
```
### API Usage
```javascript
// Define defaults values
this.$warehouse.defaults({ user: { name: 'John Doe' } })
// Change current user with an expiration date of 2 hours starting from now
const expiration = new Date().getTime() + (3600 * 2000)
this.$warehouse.set('user', { name:'Marie Doe' }, expiration)
// Get current user value
this.$warehouse.get('user')
// Get current user expiration
this.$warehouse.getExpiration('user')
// Remove current user
this.$warehouse.remove('user') // return the default value -> { name: 'John Doe' }
// Clear all keys
this.$warehouse.clearAll()
// Loop over all stored values
this.$warehouse.each(function(value, key) {
console.log(key, '==', value)
})
```
### Vuex State
The last change made to the **browser store** (localStorage, cookie, etc.) are synced with the Vuex state:
```javascript
// Store current user
this.$warehouse.set('user', { name: 'John Doe' })
// Update the user
this.$warehouse.set('user', { name: 'Marie Doe' })
// get state values
store.state.warehouse.action // action performed -> set
store.state.warehouse.key // key affected -> user
store.state.warehouse.value // stored value -> { name: 'Marie Doe' }
store.state.warehouse.oldValue // last value -> { name: 'John Doe' }
```
## Documentation & Support
- 📄 If you want extra details of how to configure and use this plugin, the full documentation is available at [https://marquez.co/docs/vue-warehouse][documentation].
- 🐞 For Bug reports or Feature requests, use the [Issues section][issues].
- 💬 For **questions**, you can also use the [Issues section][issues].
- 🚀 You may also want to **follow me** [on Twitter][twitter].
## Professional Support
This project is sponsored by me, a Full Stack Developer. If you require Professional Assistance on your project(s), please contact me at [https://marquez.co][contact-page].
## Contributing
Please make sure to read the [Contributing Guide][contributing] before making a pull request.
## Code of Conduct
Everyone participating in this project is expected to agree to abide by the [Code of Conduct][code-of-conduct].
## License
Code released under the [MIT License][license-page].
[npm-homepage]: https://www.npmjs.com/
[node-homepage]: https://nodejs.org
[storejs]: https://github.com/marcuswestin/store.js/
[documentation]: https://marquez.co/docs/vue-warehouse?utm_source=github&utm_medium=readme&utm_campaign=vue-warehouse
[documentation-es]: https://marquez.co/es/docs/vue-warehouse?utm_source=github&utm_medium=readme&utm_campaign=vue-warehouse
[contributing]: https://marquez.co/docs/vue-warehouse/contributing?utm_source=github&utm_medium=readme&utm_campaign=vue-warehouse
[code-of-conduct]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
[issues]: https://github.com/juliomrqz/vue-warehouse/issues
[spectrum-chat]: https://spectrum.chat/bazzite/login?r=https://spectrum.chat/bazzite/open-source
[twitter]: https://twitter.com/AceforthHQ
[contact-page]: https://marquez.co?utm_source=github&utm_medium=readme&utm_campaign=vue-warehouse
[license-page]: https://marquez.co/docs/vue-warehouse/license?utm_source=github&utm_medium=readme&utm_campaign=vue-warehouse