{"id":19379032,"url":"https://github.com/fivethree-team/ngxs-ionic-router-plugin","last_synced_at":"2025-04-23T19:32:41.302Z","repository":{"id":48807558,"uuid":"167157435","full_name":"fivethree-team/ngxs-ionic-router-plugin","owner":"fivethree-team","description":"NGXS Ionic Router Plugin","archived":false,"fork":false,"pushed_at":"2021-07-11T02:34:14.000Z","size":777,"stargazers_count":5,"open_issues_count":21,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T19:21:30.295Z","etag":null,"topics":["angular","ionic","navigation","ngxs","plugin"],"latest_commit_sha":null,"homepage":"","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/fivethree-team.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-23T09:40:35.000Z","updated_at":"2023-07-25T14:23:06.000Z","dependencies_parsed_at":"2022-09-23T21:52:45.839Z","dependency_job_id":null,"html_url":"https://github.com/fivethree-team/ngxs-ionic-router-plugin","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivethree-team%2Fngxs-ionic-router-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivethree-team%2Fngxs-ionic-router-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivethree-team%2Fngxs-ionic-router-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivethree-team%2Fngxs-ionic-router-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fivethree-team","download_url":"https://codeload.github.com/fivethree-team/ngxs-ionic-router-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250499923,"owners_count":21440715,"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":["angular","ionic","navigation","ngxs","plugin"],"created_at":"2024-11-10T09:08:17.654Z","updated_at":"2025-04-23T19:32:40.940Z","avatar_url":"https://github.com/fivethree-team.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IonicRouterPlugin for NGXS\n\n[![npm version](https://badge.fury.io/js/%40fivethree%2Fngxs-ionic-router-plugin.svg)](https://www.npmjs.com/@fivethree/ngxs-ionic-router-plugin)\n[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/fivethree-team/ngxs-ionic-router-plugin/blob/master/LICENSE)\n\nRouter Plugin for Ionic 5 and NGXS 3.7.1 or higher.\n\n| Angular | @ngxs/store | ionic | @fivethree/@fivethree/ngxs-ionic-router-plugin |\n| ------- | ----------- | ----- | ---------------------------------------------- |\n| 11      | 3.7.1+      | 5.x.x | 1.0.0                                          |\n| 8/9     | 3.6.x+      | 5.x.x | 0.3.x                                          |\n| 8/9     | 3.6.x+      | 4.x.x | 0.2.x                                          |\n| 7       | 3.3.4+      | 4.x.x | 0.1.0                                          |\n\n## 📦 Installation\n\n```console\nnpm install @fivethree/ngxs-ionic-router-plugin --save\n\n# or if you are using yarn\nyarn add @fivethree/ngxs-ionic-router-plugin\n```\n\n## 🔨 Usage\n\nImport the module into your root application module:\n\n```typescript\nimport { NgModule } from '@angular/core';\nimport { NgxsModule } from '@ngxs/store';\nimport { NgxsIonicRouterPluginModule } from '@fivethree/ngxs-ionic-router-plugin';\n\n@NgModule({\n  imports: [NgxsModule.forRoot(states), NgxsIonicRouterPluginModule.forRoot()]\n})\nexport class AppModule {}\n```\n\nNow the route will be reflected in your store under the `ionicRouter` state name.\n\n## 🧭 Navigation\n\n`new NavigateRoot(path: string | UrlTree | any[], options?: NavigationOptions)`\n\n`new NavigateForward(path: string | UrlTree | any[], options?: NavigationOptions)`\n\n`new NavigateBackward(path: string | UrlTree | any[], options?: NavigationOptions)`\n\n`new NavigateBack(options?: AnimationOptions)`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivethree-team%2Fngxs-ionic-router-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffivethree-team%2Fngxs-ionic-router-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivethree-team%2Fngxs-ionic-router-plugin/lists"}