:boom: Vue plugin for work with local storage, session storage and memory storage from Vue context

Related tags

Utilities vue-ls
Overview

vue-ls logo

vue-ls

Greenkeeper badge

Vue plugin for work with local storage, session storage and memory storage from Vue context

NPM

jsFiddle Example

Vue 1.x

Vue 2.x

Install

CDN

Recommended: https://unpkg.com/vue-ls, which will reflect the latest version as soon as it is published to npm. You can also browse the source of the npm package at https://unpkg.com/vue-ls/

Also available on jsDelivr or cdnjs, but these two services take some time to sync so the latest release may not be available yet.

NPM

npm install vue-ls --save

Yarn

yarn add vue-ls

Bower

bower install vue-ls --save

Development Setup

# install dependencies
npm install

# build dist files
npm run build

Usage

Vue storage API.

import Storage from 'vue-ls';

options = {
  namespace: 'vuejs__', // key prefix
  name: 'ls', // name variable Vue.[ls] or this.[$ls],
  storage: 'local', // storage name session, local, memory
};

Vue.use(Storage, options);

//or
//Vue.use(Storage);

new Vue({
    el: '#app',
    mounted: function() {
        Vue.ls.set('foo', 'boo');
        //Set expire for item
        Vue.ls.set('foo', 'boo', 60 * 60 * 1000); //expiry 1 hour
        Vue.ls.get('foo');
        Vue.ls.get('boo', 10); //if not set boo returned default 10
        
        let callback = (val, oldVal, uri) => {
          console.log('localStorage change', val);
        } 
        
        Vue.ls.on('foo', callback) //watch change foo key and triggered callback
        Vue.ls.off('foo', callback) //unwatch
        
        Vue.ls.remove('foo');
    }
});

Global

  • Vue.ls

Context

  • this.$ls

API

Vue.ls.get(name, def)

Returns value under name in storage. Internally parses the value from JSON before returning it.

  • def: default null, returned if not set name.

Vue.ls.set(name, value, expire)

Persists value under name in storage. Internally converts the value to JSON.

  • expire: default null, life time in milliseconds name

Vue.ls.remove(name)

Removes name from storage. Returns true if the property was successfully deleted, and false otherwise.

Vue.ls.clear()

Clears storage.

Vue.ls.on(name, callback)

Listen for changes persisted against name on other tabs. Triggers callback when a change occurs, passing the following arguments.

  • newValue: the current value for name in storage, parsed from the persisted JSON
  • oldValue: the old value for name in storage, parsed from the persisted JSON
  • url: the url for the tab where the modification came from

Vue.ls.off(name, callback)

Removes a listener previously attached with Vue.ls.on(name, callback).

Testing

  • npm run test - run unit test
  • npm run test:browserstack - run browser test
    • npm run test:browserstack:chrome
    • npm run test:browserstack:ie
    • npm run test:browserstack:edge
    • npm run test:browserstack:firefox
    • npm run test:browserstack:safari
  • npm run test:chrome - run browser test in chrome
  • npm run test:phantomjs - run browser test in phantomjs

Testing Supported By

Note

Some browsers don't support the storage event, and most of the browsers that do support it will only call it when the storage is changed by a different window. So, open your page up in two windows. Click the links in one window and you will probably see the event in the other.

The assumption is that your page will already know all interactions with localStorage in its own window and only needs notification when a different window changes things. This, of course, is a foolish assumption. But.

Other my Vue JS plugins

Project Status Description
vue-gallery npm VueJS responsive and customizable image and video gallery
vue-popper npm VueJS popover component based on popper.js

License

FOSSA Status

MIT © Igor Ognichenko

You might also like...
Vue plugin for advanced click directive

Vue plugin for advanced click directive

A vue code diff display plugin, support Vue2 / Vue3

A code diff display plugin, available for Vue2 / Vue3. It is the vue3 version of vue-code-diff, refer to a lot of code, thanks here.

Simple string format plugin for vue-formly
Simple string format plugin for vue-formly

Simple string format plugin for vue-formly

DOM helpers plugin for Vue.js using gaspard

Vue-gaspard DOM helpers plugin for Vue.js using gaspard Getting started Installing npm yarn bower unpkg npm install vue-gaspard yarn add vue-gaspard b

Vue.js plugin for generating ICalendar (.ics) files.

vue-ics Vue.js plugin for generating ICalendar (.ics) files. Installation NPM npm install vue-ics --save Vue import Vue from 'vue' import ICS from 'v

A simple Vue 3 plugin for handling browser cookies with typescript support

A vue 3 plugin for handling browser cookies with typescript support. Load and save cookies within your Vue 3 application

Feather icons plugin for Vue.js, SSR supported.

Feather icons plugin for Vue.js, SSR supported.

Async data loading plugin for Vue.js

Async data loading plugin for Vue.js

A simple Vue.js 3 plugin for handling browser cookies

vue3-cookies A simple Vue.js 3 plugin for handling browser cookies, forked from https://github.com/cmp-cc/vue-cookies Installation Package Managers np

Vue mixin that maps props to local data

Props To Local Works with: This mixin will sync down properties to local data. This allows defining a property that can be changed within the componen

Cristian Pallarés 6 Jan 2, 2022
Component and HTML unique id generation plugin for Vue.js

vue-unique-id Vue.js plugin that generates component-scoped HTML identifiers for use in form inputs, labels, jQuery plugins, etc. This solves the prob

Bertrand Guay-Paquet 47 Nov 23, 2022
Internationalization plugin for Vue.js - fluent-vue is Vue.js integration for Fluent.js

Internationalization plugin for Vue.js - fluent-vue is Vue.js integration for Fluent.js

Ivan Demchuk 164 Dec 28, 2022
JSX for Vue 3 - Babel Plugin JSX for Vue 3.0

JSX for Vue 3 - Babel Plugin JSX for Vue 3.0

vuejs 1.5k Jan 3, 2023
simple vue plugin to implement underscore

vue-underscore You know Underscore.js is a utility-belt library for JavaScript that provides support for the usual functional suspects (each, map, red

Haluk Keskin 18 Apr 28, 2021
Vue.js plugin that allows you to reference methods on parent classes

vue-super Provides a $super handler for accessing parent vue methods from a subclass. Behaves similarly to python's super implementation. vue-super is

Ryan P Kilby 34 Dec 1, 2022
A Vue.js plugin that protects routes based on user roles. Add your own authentication.

vue-router-user-roles A plugin for Vue.js SPAs that protects routes depending on user role. Add your own authentication. ?? Usage Check out the demo h

Anthony Gore 241 Sep 24, 2022
A Vue.js plugin to use webworkers in a simply way.

VueWorker A Vue.js plugin to use webworkers in a simply way. Changelog 1.2.1 Highlights: Fix README examples See full changelog here. Why Create and u

Israel Sant'Anna 562 Dec 3, 2022
JSX Syntactic Sugar Plugin for Vue Functional Components

DEPRECATED: Check https://github.com/vuejs/jsx instead JSX Functional Components for Vue JSX This babel plugin adds some syntactic sugar to JSX. Usage

Nick Messing 66 May 26, 2022
Vue.js Plugin to facilitate Backbone integration

vue-backbone Vue.js Plugin to facilitate gradual migration from Backbone. Backbone Collections and Models can be safely integrated with Vue instances

Michael Gallagher 44 Dec 21, 2022