{"id":13810527,"url":"https://github.com/wobsoriano/pinia-shared-state","last_synced_at":"2025-05-15T06:04:31.164Z","repository":{"id":37512011,"uuid":"393999951","full_name":"wobsoriano/pinia-shared-state","owner":"wobsoriano","description":"🍍 Sync your Pinia state across browser tabs.","archived":false,"fork":false,"pushed_at":"2025-02-12T19:01:58.000Z","size":845,"stargazers_count":286,"open_issues_count":9,"forks_count":18,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-11T05:04:53.332Z","etag":null,"topics":["pinia","state","vue"],"latest_commit_sha":null,"homepage":"https://wobsoriano.github.io/pinia-shared-state/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wobsoriano.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-08T15:34:54.000Z","updated_at":"2025-05-09T00:28:01.000Z","dependencies_parsed_at":"2025-02-26T16:10:41.269Z","dependency_job_id":"b774ebfa-9734-469c-8e85-8c233c994efd","html_url":"https://github.com/wobsoriano/pinia-shared-state","commit_stats":{"total_commits":139,"total_committers":4,"mean_commits":34.75,"dds":"0.021582733812949617","last_synced_commit":"881b40d9de9ee9f0b96ff7c8d63f13637c2fdd71"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wobsoriano%2Fpinia-shared-state","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wobsoriano%2Fpinia-shared-state/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wobsoriano%2Fpinia-shared-state/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wobsoriano%2Fpinia-shared-state/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wobsoriano","download_url":"https://codeload.github.com/wobsoriano/pinia-shared-state/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254283337,"owners_count":22045140,"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":["pinia","state","vue"],"created_at":"2024-08-04T02:00:57.899Z","updated_at":"2025-05-15T06:04:31.144Z","avatar_url":"https://github.com/wobsoriano.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Components \u0026 Libraries"],"sub_categories":["Utilities"],"readme":"# pinia-shared-state\n\n[![npm (tag)](https://img.shields.io/npm/v/pinia-shared-state?style=flat\u0026colorA=000000\u0026colorB=000000)](https://www.npmjs.com/package/pinia-shared-state) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/pinia-shared-state?style=flat\u0026colorA=000000\u0026colorB=000000) ![NPM](https://img.shields.io/npm/l/pinia-shared-state?style=flat\u0026colorA=000000\u0026colorB=000000)\n\nSync your Pinia state across browser tabs.\n\n## Requirements\n\n- vue ^3.5.11\n\n## Install\n\n```sh\nnpm install pinia-shared-state\n```\n\n## Usage\n\n```js\nimport { PiniaSharedState } from 'pinia-shared-state'\n\n// Pass the plugin to your application's pinia plugin\npinia.use(\n  PiniaSharedState({\n    // Enables the plugin for all stores. Defaults to true.\n    enable: true,\n    // If set to true this tab tries to immediately recover the shared state from another tab. Defaults to true.\n    initialize: false,\n    // Enforce a type. One of native, idb, localstorage or node. Defaults to native.\n    type: 'localstorage',\n  }),\n)\n```\n\n```js\nconst useStore = defineStore({\n  id: 'counter',\n  state: () =\u003e ({\n    count: 0,\n    foo: 'bar',\n  }),\n  share: {\n    // An array of fields that the plugin will ignore.\n    omit: ['foo'],\n    // Override global config for this store.\n    enable: true,\n    initialize: true,\n  },\n})\n```\n\nVanilla usage:\n\n```ts\nimport { share } from 'pinia-shared-state'\nimport { onMounted, onUnmounted } from 'vue'\nimport useStore from './store'\n\nconst counterStore = useStore()\n\nonMounted(() =\u003e {\n  const { unshare } = share('counter', counterStore, { initialize: true })\n\n  onUnmounted(() =\u003e {\n    // Call `unshare` method to close the channel\n    unshare()\n  })\n})\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwobsoriano%2Fpinia-shared-state","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwobsoriano%2Fpinia-shared-state","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwobsoriano%2Fpinia-shared-state/lists"}