grevory

angular-local-storage

An AngularJS module that gives you access to the browsers local storage with cookie fallback
Under Other
By grevory

javascript angularjs angular cookie localstorage

angular-local-storage

An Angular module that gives you access to the browsers local storage



Table of contents:

Get Started

(1) You can install angular-local-storage using 3 different ways:
Git:
clone & build this repository
Bower:
bash
$ bower install angular-local-storage --save
npm:
bash
$ npm install angular-local-storage
(2) Include angular-local-storage.js (or angular-local-storage.min.js) from the dist directory in your index.html, after including Angular itself.


(3) Add 'LocalStorageModule' to your main module's list of dependencies.


When you're done, your setup should look similar to the following:


```html



...


...

var myApp = angular.module('myApp', ['LocalStorageModule']);


...


```


Configuration
setPrefix

You could set a prefix to avoid overwriting any local storage variables from the rest of your app
Default prefix: ls.<your-key>
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setPrefix('yourAppName');
});


setStorageType

You could change web storage type to localStorage or sessionStorage
Default storage: localStorage
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setStorageType('sessionStorage');
});


setDefaultToCookie

If localStorage is not supported, the library will default to cookies instead. This behavior can be disabled.
Default: true
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setDefaultToCookie(false);
});


setStorageCookie

Set cookie options (usually in case of fallback)
expiry: number of days before cookies expire (0 = session cookie). default: 30
path: the web path the cookie represents. default: '/'
secure: whether to store cookies as secure. default: false
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setStorageCookie(45, '<path>', false);
});


setStorageCookieDomain

Set the cookie domain, since this runs inside a the config() block, only providers and constants can be injected. As a result, $location service can't be used here, use a hardcoded string or window.location.
No default value
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setStorageCookieDomain('<domain>');
});


For local testing (when you are testing on localhost) set the domain to an empty string ''. Setting the domain to 'localhost' will not work on all browsers (eg. Chrome) since some browsers only allow you to set domain cookies for registry controlled domains, i.e. something ending in .com or so, but not IPs or intranet hostnames like localhost.


setNotify

Configure whether events should be broadcasted on $rootScope for each of the following actions:
setItem , default: true, event "LocalStorageModule.notification.setitem"
removeItem , default: false, event "LocalStorageModule.notification.removeitem"
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setNotify(true, true);
});


Configuration Example

Using all together
js
myApp.config(function (localStorageServiceProvider) {
localStorageServiceProvider
.setPrefix('myApp')
.setStorageType('sessionStorage')
.setNotify(true, true)
});


API Documentation
isSupported

Checks if the browser support the current storage type(e.g: localStorage, sessionStorage).
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
if(localStorageService.isSupported) {
//...
}
//...
});


setPrefix

Change the local storage prefix during execution
Returns: Null
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
localStorageService.setPrefix('newPrefix');
//...
});


getStorageType

Returns: String
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
var storageType = localStorageService.getStorageType(); //e.g localStorage
//...
});
You can also dynamically change storage type by passing the storage type as the last parameter for any of the API calls. For example: localStorageService.set(key, val, "sessionStorage");


set

Directly adds a value to local storage.
If local storage is not supported, use cookies instead.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function submit(key, val) {
return localStorageService.set(key, val);
}
//...
});


get

Directly get a value from local storage.
If local storage is not supported, use cookies instead.
Returns: value from local storage
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function getItem(key) {
return localStorageService.get(key);
}
//...
});


keys

Return array of keys for local storage, ignore keys that not owned.
Returns: value from local storage
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
var lsKeys = localStorageService.keys();
//...
});


remove

Remove an item(s) from local storage by key.
If local storage is not supported, use cookies instead.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function removeItem(key) {
return localStorageService.remove(key);
}
//...
function removeItems(key1, key2, key3) {
return localStorageService.remove(key1, key2, key3);
}
});


clearAll

Remove all data for this app from local storage.
If local storage is not supported, use cookies instead.
Note: Optionally takes a regular expression string and removes matching.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function clearNumbers(key) {
return localStorageService.clearAll(/^\d+$/);
}
//...
function clearAll() {
return localStorageService.clearAll();
}
});


bind

Bind $scope key to localStorageService.
Usage: localStorageService.bind(scope, property, value[optional], key[optional])
key: The corresponding key used in local storage
Returns: deregistration function for this listener.
```js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
localStorageService.set('property', 'oldValue');
$scope.unbind = localStorageService.bind($scope, 'property');


//Test Changes
$scope.update = function(val) {
$scope.property = val;
$timeout(function() {
alert("localStorage value: " + localStorageService.get('property'));
});
}
//...
});
html

{{property}}



update
unbind

```


deriveKey

Return the derive key
Returns String
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
localStorageService.set('property', 'oldValue');
//Test Result
console.log(localStorageService.deriveKey('property')); // ls.property
//...
});


length

Return localStorageService.length, ignore keys that not owned.
Returns Number
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
var lsLength = localStorageService.length(); // e.g: 7
//...
});


Cookie

Deal with browser's cookies directly.


cookie.isSupported

Checks if cookies are enabled in the browser.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
if(localStorageService.cookie.isSupported) {
//...
}
//...
});


cookie.set

Directly adds a value to cookies.
Note: Typically used as a fallback if local storage is not supported.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function submit(key, val) {
return localStorageService.cookie.set(key, val);
}
//...
});
Cookie Expiry Pass a third argument to specify number of days to expiry
js
localStorageService.cookie.set(key,val,10)
sets a cookie that expires in 10 days.
Secure Cookie Pass a fourth argument to set the cookie as secure W3C
js
localStorageService.cookie.set(key,val,null,false)
sets a cookie that is secure.


cookie.get

Directly get a value from a cookie.
Returns: value from local storage
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function getItem(key) {
return localStorageService.cookie.get(key);
}
//...
});


cookie.remove

Remove directly value from a cookie.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function removeItem(key) {
return localStorageService.cookie.remove(key);
}
//...
});


cookie.clearAll

Remove all data for this app from cookie.
Returns: Boolean
js
myApp.controller('MainCtrl', function($scope, localStorageService) {
//...
function clearAll() {
return localStorageService.cookie.clearAll();
}
});


Check out the full demo at http://gregpike.net/demos/angular-local-storage/demo.html


Development:

Clone the project:
sh
$ git clone https://github.com/<your-repo>/angular-local-storage.git
$ npm install
$ bower install
Run the tests:
sh
$ grunt test
Deploy:
Run the build task, update version before(bower,package)
sh
$ npm version patch|minor|major
$ grunt dist
$ git commit [message]
$ git push origin master --tags