The original author of ngStorage is Gias Kay Lee
As the repository was silent for about 11 months I decided to start a fork and began merging the pull requests into this fork.
An AngularJS module that makes Web Storage working in the Angular Way. Contains two services: $localStorage and $sessionStorage.
-
No Getter 'n' Setter Bullshit - Right from AngularJS homepage: "Unlike other frameworks, there is no need to [...] wrap the model in accessors methods. Just plain old JavaScript here." Now you can enjoy the same benefit while achieving data persistence with Web Storage.
-
sessionStorage - We got this often-overlooked buddy covered.
-
Cleanly-Authored Code - Written in the Angular Way, well-structured with testability in mind.
-
No Cookie Fallback - With Web Storage being readily available in all the browsers AngularJS officially supports, such fallback is largely redundant.
bower install ngstorageangular.module('app', [
'ngStorage'
]).controller('Ctrl', function(
$scope,
$localStorage,
$sessionStorage
){});Read and Write | Demo
Pass $localStorage (or $sessionStorage) by reference to a hook under $scope in plain ol' JavaScript:
$scope.$storage = $localStorage;And use it like you-already-know:
<body ng-controller="Ctrl">
<button ng-click="$storage.counter = $storage.counter + 1">{{$storage.counter}}</button>
</body>Optionally, specify default values using the
$default()method:$scope.$storage = $localStorage.$default({ counter: 42 });
With this setup, changes will be automatically sync'd between $scope.$storage, $localStorage, and localStorage - even across different browser tabs!
Read and Write Alternative (Not Recommended) | Demo
If you're not fond of the presence of $scope.$storage, you can always use watchers:
$scope.counter = $localStorage.counter || 42;
$scope.$watch('counter', function() {
$localStorage.counter = $scope.counter;
});
$scope.$watch(function() {
return angular.toJson($localStorage);
}, function() {
$scope.counter = $localStorage.counter;
});This, however, is not the way ngStorage is designed to be used with. As can be easily seen by comparing the demos, this approach is way more verbose, and may have potential performance implications as the values being watched quickly grow.
Delete | Demo
Plain ol' JavaScript again, what else could you better expect?
// Both will do
delete $scope.$storage.counter;
delete $localStorage.counter;This will delete the corresponding entry inside the Web Storage.
Delete Everything | Demo
If you wish to clear the Storage in one go, use the $reset() method:
$localStorage.$reset();Optionally, pass in an object you'd like the Storage to reset to:
$localStorage.$reset({ counter: 42 });
When using the module you should not care if or when something is written to the browsers storage engine. However, if you have a critical part, when you need to know the exact timing, you can use the $save() method:
$localStorage.value = 100;
$localStorage.$save()The $storage will expose the state of support for the browsers storage.
$localStorage.$supported === false;
$sessionStorage.$supported === false;If $supported is false your data cannot be saved.
Permitted Values | Demo
You can store anything except those not supported by JSON:
Infinity,NaN- Will be replaced withnull.undefined, Function - Will be removed.
Just run $ npm install to install dependencies. Then run $ grunt for minification.
- ngdoc Documentation
- Namespace Support
- Version Control - Changes need to change the version numbering
- #Issue 39 - Tobias Kopelke - The reason for the fork
- #Issue 41 - d10n - https://github.com/d10n
- #Issue 60 - Dmitri Zaitsev - https://github.com/dmitriz
- #Issue 63 - mrkoreye - https://github.com/mrkoreye
- #Issue 68 - Ken Baltrinic - https://github.com/kbaltrinic
Any contribution will be appreciated.