{"id":25191788,"url":"https://github.com/supertigerdev/solid-named-router","last_synced_at":"2025-05-07T21:42:22.310Z","repository":{"id":60580068,"uuid":"544087167","full_name":"SupertigerDev/solid-named-router","owner":"SupertigerDev","description":"A named based router for solidjs","archived":false,"fork":false,"pushed_at":"2022-11-07T16:03:25.000Z","size":481,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T12:45:51.577Z","etag":null,"topics":["navigation","router","solidjs","vue"],"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/SupertigerDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2022-10-01T16:00:35.000Z","updated_at":"2024-02-23T09:25:13.000Z","dependencies_parsed_at":"2023-01-21T08:04:45.328Z","dependency_job_id":null,"html_url":"https://github.com/SupertigerDev/solid-named-router","commit_stats":null,"previous_names":["supertigerr/solid-named-router"],"tags_count":0,"template":false,"template_full_name":"solidjs-community/solid-lib-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupertigerDev%2Fsolid-named-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupertigerDev%2Fsolid-named-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupertigerDev%2Fsolid-named-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SupertigerDev%2Fsolid-named-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SupertigerDev","download_url":"https://codeload.github.com/SupertigerDev/solid-named-router/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238030269,"owners_count":19404859,"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":["navigation","router","solidjs","vue"],"created_at":"2025-02-09T22:36:40.071Z","updated_at":"2025-02-09T22:36:40.683Z","avatar_url":"https://github.com/SupertigerDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp\u003e\n  \u003cimg width=\"100%\" src=\"https://assets.solidjs.com/banner?type=solid-named-router\u0026background=tiles\u0026project=%20\" alt=\"solid-named-router\"\u003e\n\u003c/p\u003e\n\n# Solid Named Router\n\n[![pnpm](https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg?style=for-the-badge\u0026logo=pnpm)](https://pnpm.io/)\n\nA third party router library for solidjs. Includes named routes inspired by vuejs.   \nThis router relies on the [route-parser](https://github.com/Unnamed-Chat-App/route-parser) package.   \nNote: This library is not complete. Please contribute and submit PRs to improve this library 💖\n\n## Quick start\n\nInstall it:\n\n```bash\nnpm i solid-named-router\n```\n\nWrap your root component with the Router component:\n\n```tsx\nimport { render } from \"solid-js/web\";\nimport { createRouter } from \"solid-named-router\";\nimport App from \"./App\";\n\nconst Router = createRouter({\n  routes: [\n    {\n      name: 'Home',\n      path: '/',\n      element: () =\u003e \u003cdiv\u003eHome\u003c/div\u003e\n    },\n    {\n      name: 'Users',\n      path: '/users/:userId',\n      element: () =\u003e \u003cdiv\u003eUsers\u003c/div\u003e\n    },\n  ]\n});\n\nrender(\n  () =\u003e (\n    \u003cRouter\u003e\n      \u003cApp /\u003e\n    \u003c/Router\u003e\n  ),\n  document.getElementById(\"app\")\n);\n```\n\nNow add the `RouterView` component to display the current route.\n```tsx\nimport {RouterView, Link} from \"solid-named-router\";\n\nconst App = () =\u003e {\n  return (\n    \u003c\u003e\n      \u003cRouterView/\u003e\n    \u003c/\u003e\n  );\n};\n```\n\n## Methods \u0026 Hooks\n### Link\n```tsx\n\u003cLink to={{name: 'Users', params: {userId: 1234}, query: {hideInfo: \"1\"}}}\u003eUser\u003c/Link\u003e\n\u003cLink to='app/users/1234'\u003eUser\u003c/Link\u003e\n```\n### navigate\n```ts\nnavigate({name: 'Users', params: {userId: 1234}, query: {hideInfo: \"1\"}})\nnavigate('app/users/1234')\n```\n\n### useNamedRoute\n```ts\nconst namedRoute = useNamedRoute(); // -\u003e {name, params, pathname, query};\n\n\u003cdiv\u003e\n  \u003cdiv\u003ename: {namedRoute.name}\u003c/div\u003e\n  \u003cdiv\u003eparams: {namedRoute.params.userId}\u003c/div\u003e\n  \u003cdiv\u003eparams: {namedRoute.pathname}\u003c/div\u003e\n\u003c/div\u003e\n```\n### useParams\n```ts\nconst params = useParams(); // -\u003e {userId};\n\n\u003cdiv\u003e\n  \u003cdiv\u003ename: {params.userId}\u003c/div\u003e\n\u003c/div\u003e\n```\n\n### Outlet Example\n```tsx\n\nconst Router = createRouter({\n  routes: [\n    {\n      name: 'Users',\n      path: '/users/:userId',\n      elements: {\n        drawer: () =\u003e \u003cdiv\u003eDrawer Here\u003c/div\u003e,\n        content: () =\u003e \u003cdiv\u003eContent Here\u003c/div\u003e\n      },\n      element: () =\u003e (\n        \u003cdiv\u003e\n          \u003cOutlet name=\"drawer\"\u003e\n          \u003cOutlet name=\"content\"\u003e\n        \u003c/div\u003e\n      ),\n    },\n  ]\n});\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupertigerdev%2Fsolid-named-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupertigerdev%2Fsolid-named-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupertigerdev%2Fsolid-named-router/lists"}