radyushin / vue-localstorage

The Vue plugin for work with LocalStorage from Vue context

vue-local-storage

The Vue plugin for work with LocalStorage from Vue context, with cookie fallback.

Introduction

vue-local-storage is wrapper for work with the Storage interface of the Web Storage API.

If localStorage is not available, such as in Safari Incognito mode, then cookie will be used.

Notice that max cookie size is around 4kb.

Development Setup

# install deps
yarn install

# build dist files
yarn compile

# run tests
yarn test

Installation

yarn add vue-local-storage

Usage

This is looks like work with the Web Storage API.

import Vue from 'vue';
import VueLocalStorage from 'vue-local-storage';

Vue.Use(VueLocalStorage);

new Vue({
    el: '#app',
    mounted: function() {
        this.$localStorage.set('foo', 'boo');
        // also, you can set expire for item
        this.$localStorage.set('foo', 'boo', 60 * 60 * 1000); // set an expiry of item at 1 hour
        this.$localStorage.set('foo', 'boo', 0); // endless item
        this.$localStorage.get('foo'); // get foo value
        this.$localStorage.remove('foo');
    }
});

You can use it directly from Vue.prototype as well:

Vue.localStorage.set('bar', 'baz');
Vue.localStorage.remove('bar');

Donation

If this project help you reduce time to develop, you can give me a cup of coffee :)