{"id":21169568,"url":"https://github.com/polymerelements/iron-localstorage","last_synced_at":"2025-04-04T22:05:06.537Z","repository":{"id":31137331,"uuid":"34697098","full_name":"PolymerElements/iron-localstorage","owner":"PolymerElements","description":"Access to localStorage","archived":false,"fork":false,"pushed_at":"2025-01-29T20:28:35.000Z","size":312,"stargazers_count":11,"open_issues_count":14,"forks_count":17,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-04T22:05:00.406Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PolymerElements.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-04-27T23:38:21.000Z","updated_at":"2021-08-17T12:42:02.000Z","dependencies_parsed_at":"2024-06-18T15:35:39.304Z","dependency_job_id":"a9c5d9b6-4a95-4279-99e6-6fbc4cef20f5","html_url":"https://github.com/PolymerElements/iron-localstorage","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolymerElements%2Firon-localstorage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolymerElements%2Firon-localstorage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolymerElements%2Firon-localstorage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolymerElements%2Firon-localstorage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PolymerElements","download_url":"https://codeload.github.com/PolymerElements/iron-localstorage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256110,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T15:52:31.251Z","updated_at":"2025-04-04T22:05:06.508Z","avatar_url":"https://github.com/PolymerElements.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Published on NPM](https://img.shields.io/npm/v/@polymer/iron-localstorage.svg)](https://www.npmjs.com/package/@polymer/iron-localstorage)\n[![Build status](https://travis-ci.org/PolymerElements/iron-localstorage.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-localstorage)\n[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/iron-localstorage)\n\n⚠️ This element is deprecated ⚠️\n\n## \u0026lt;iron-localstorage\u0026gt;\nElement access to Web Storage API (window.localStorage) by keeping `value`\nproperty in sync with localStorage.\n\nValue is saved as json by default.\n\nSee: [Documentation](https://www.webcomponents.org/element/@polymer/iron-localstorage),\n  [Demo](https://www.webcomponents.org/element/@polymer/iron-localstorage/demo/demo/index.html).\n\n## Usage\n\n### Installation\n```\nnpm install --save @polymer/iron-localstorage\n```\n\n### In an html file\n```html\n\u003chtml\u003e\n  \u003cbody\u003e\n    \u003ciron-localstorage name=\"my-app-storage\"\u003e\u003c/iron-localstorage\u003e\n\n    \u003cscript type=\"module\"\u003e\n      import '@polymer/iron-localstorage/iron-localstorage.js';\n\n      const ls = document.querySelector('iron-localstorage');\n      // initializes default if nothing has been stored\n      function initializeDefaultCartoon() {\n        ls.value = {\n          name: \"Mickey\",\n          hasEars: true\n        };\n      }\n\n      ls.addEventListener(\n          'iron-local-storage-load-empty', initializeDefaultCartoon);\n\n      // use path set api to propagate changes to localstorage\n      function makeModifications() {\n        ls.set('value.name', \"Minions\");\n        ls.set('value.hasEars', false);\n      }\n    \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### In a Polymer 3 element\n```js\nimport {PolymerElement, html} from '@polymer/polymer';\nimport '@polymer/iron-localstorage/iron-localstorage.js';\n\nclass SampleElement extends PolymerElement {\n  static get template() {\n    return html`\n      \u003ciron-localstorage name=\"my-app-storage\"\n          value=\"{{cartoon}}\"\n          on-iron-localstorage-load-empty=\"initializeDefaultCartoon\"\u003e\n      \u003c/iron-localstorage\u003e\n    `;\n  }\n\n  static get properties() {\n    return {\n      cartoon: { type: Object },\n    }\n  }\n\n  // initializes default if nothing has been stored\n  initializeDefaultCartoon() {\n    this.cartoon = {\n      name: \"Mickey\",\n      hasEars: true\n    }\n  }\n\n  // use path set api to propagate changes to localstorage\n  makeModifications() {\n    this.set('cartoon.name', \"Minions\");\n    this.set('cartoon.hasEars', false);\n  }\n}\ncustomElements.define('sample-element', SampleElement);\n```\n\n## Contributing\nIf you want to send a PR to this element, here are\nthe instructions for running the tests and demo locally:\n\n### Installation\n```sh\ngit clone https://github.com/PolymerElements/iron-localstorage\ncd iron-localstorage\nnpm install\nnpm install -g polymer-cli\n```\n\n### Running the demo locally\n```sh\npolymer serve --npm\nopen http://127.0.0.1:\u003cport\u003e/demo/\n```\n\n### Running the tests\n```sh\npolymer test --npm\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolymerelements%2Firon-localstorage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolymerelements%2Firon-localstorage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolymerelements%2Firon-localstorage/lists"}