https://github.com/polymerelements/iron-localstorage
Access to localStorage
https://github.com/polymerelements/iron-localstorage
Last synced: about 1 year ago
JSON representation
Access to localStorage
- Host: GitHub
- URL: https://github.com/polymerelements/iron-localstorage
- Owner: PolymerElements
- Created: 2015-04-27T23:38:21.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-01-29T20:28:35.000Z (over 1 year ago)
- Last Synced: 2025-04-04T22:05:00.406Z (about 1 year ago)
- Language: HTML
- Homepage:
- Size: 305 KB
- Stars: 11
- Watchers: 15
- Forks: 17
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@polymer/iron-localstorage)
[](https://travis-ci.org/PolymerElements/iron-localstorage)
[](https://webcomponents.org/element/@polymer/iron-localstorage)
⚠️ This element is deprecated ⚠️
## <iron-localstorage>
Element access to Web Storage API (window.localStorage) by keeping `value`
property in sync with localStorage.
Value is saved as json by default.
See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-localstorage),
[Demo](https://www.webcomponents.org/element/@polymer/iron-localstorage/demo/demo/index.html).
## Usage
### Installation
```
npm install --save @polymer/iron-localstorage
```
### In an html file
```html
import '@polymer/iron-localstorage/iron-localstorage.js';
const ls = document.querySelector('iron-localstorage');
// initializes default if nothing has been stored
function initializeDefaultCartoon() {
ls.value = {
name: "Mickey",
hasEars: true
};
}
ls.addEventListener(
'iron-local-storage-load-empty', initializeDefaultCartoon);
// use path set api to propagate changes to localstorage
function makeModifications() {
ls.set('value.name', "Minions");
ls.set('value.hasEars', false);
}
```
### In a Polymer 3 element
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/iron-localstorage/iron-localstorage.js';
class SampleElement extends PolymerElement {
static get template() {
return html`
`;
}
static get properties() {
return {
cartoon: { type: Object },
}
}
// initializes default if nothing has been stored
initializeDefaultCartoon() {
this.cartoon = {
name: "Mickey",
hasEars: true
}
}
// use path set api to propagate changes to localstorage
makeModifications() {
this.set('cartoon.name', "Minions");
this.set('cartoon.hasEars', false);
}
}
customElements.define('sample-element', SampleElement);
```
## Contributing
If you want to send a PR to this element, here are
the instructions for running the tests and demo locally:
### Installation
```sh
git clone https://github.com/PolymerElements/iron-localstorage
cd iron-localstorage
npm install
npm install -g polymer-cli
```
### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:/demo/
```
### Running the tests
```sh
polymer test --npm
```