{"id":24073768,"url":"https://github.com/rodrigocfd/svelte-mini-router","last_synced_at":"2025-04-28T16:48:40.619Z","repository":{"id":267668293,"uuid":"901985989","full_name":"rodrigocfd/svelte-mini-router","owner":"rodrigocfd","description":"A declarative, minimal SPA router for Svelte 5, without SvelteKit.","archived":false,"fork":false,"pushed_at":"2024-12-27T15:36:23.000Z","size":88,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T11:32:42.156Z","etag":null,"topics":["router","svelte","svelte5"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/svelte-mini-router","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/rodrigocfd.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2024-12-11T17:24:35.000Z","updated_at":"2025-03-16T23:13:23.000Z","dependencies_parsed_at":"2024-12-11T18:40:54.801Z","dependency_job_id":"f527b40c-dcd1-4f8a-9432-f8bb5245aded","html_url":"https://github.com/rodrigocfd/svelte-mini-router","commit_stats":null,"previous_names":["rodrigocfd/svelte-mini-router"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rodrigocfd%2Fsvelte-mini-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rodrigocfd%2Fsvelte-mini-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rodrigocfd%2Fsvelte-mini-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rodrigocfd%2Fsvelte-mini-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rodrigocfd","download_url":"https://codeload.github.com/rodrigocfd/svelte-mini-router/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251348480,"owners_count":21575284,"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":["router","svelte","svelte5"],"created_at":"2025-01-09T17:56:46.795Z","updated_at":"2025-04-28T16:48:40.588Z","avatar_url":"https://github.com/rodrigocfd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Svelte Mini Router\n\nA declarative, minimal SPA router for Svelte 5, without SvelteKit. \n\nFeatures:\n\n* declarative – works with any directory structure\n* small API (see below)\n    * 2 components – `Router` and `Link`\n    * 3 functions – `navigate`, `getPathParams` and `getQueryParams`\n* works without SvelteKit – perfect for SPAs created with [Vite](https://vite.dev/guide/#scaffolding-your-first-vite-project)\n* scalable – routes are lazy-loaded\n* built-in TypeScript support\n\n## Usage\n\nInstall the package:\n\n```bash\nnpm i svelte-mini-router\n```\n\nFolder structure has no rules, you can organize the way you want. For example:\n\n```\nsrc/\n├─ pages/\n│  ├─ home/\n│  │  └─ MyHome.svelte\n│  └─ page1/\n│     └─ Page1.svelte\n├─ App.svelte\n├─ Error404.svelte\n├─ main.ts\n└─ routerConf.ts\n```\n\nDeclare your router:\n\n```ts\nimport {type RouterConf} from 'svelte-mini-router';\n\nexport const routerConf: RouterConf = {\n    routes: [\n        // this is your home page\n        {path: '/', render: () =\u003e import('./pages/home/MyHome.svelte')},\n\n        // another page\n        {path: '/page1', render: () =\u003e import('./pages/page1/Page1.svelte')},\n\n        // nested routes are up to you\n        {path: '/foo/bar/stuff', render: () =\u003e import('./pages/page1/Page1.svelte')},\n\n        // you can use path parameters anywhere\n        {path: '/foo/{name}/and/{age}', render: () =\u003e import('./pages/page1/Page1.svelte')},\n    ],\n\n    // if you use a base URL, set it here; optional\n    baseUrl: '/my-web-application',\n\n    // error 404 route; optional\n    // if not defined, a simple \"404 - Not found\" text will be displayed\n    render404: () =\u003e import('./Error404.svelte'),\n};\n```\n\nFinally add the `Router` component to your `App.svelte`:\n\n```svelte\n\u003cscript lang=\"ts\"\u003e\n    import {Router} from 'svelte-mini-router';\n    import {routerConf} from './routerConf';\n\u003c/script\u003e\n\n\u003cRouter {routerConf} /\u003e\n```\n\n### Navigating\n\nRendering an `\u003ca href=\"\"\u003e` element to a route with the `Link` component:\n\n```svelte\n\u003cscript lang=\"ts\"\u003e\n    import {Link} from 'svelte-mini-router';\n\u003c/script\u003e\n\n\u003c!-- without query parameters --\u003e\n\u003cLink path=\"/page1\"\u003e\n    Go to Page 1\n\u003c/Link\u003e\n\n\u003c!-- with query parameters --\u003e\n\u003c!-- means \"/page1?name=Joe\u0026age=43\" --\u003e\n\u003cLink path=\"/page1\" params={{name: 'Joe', age: 43}}\u003e\n    Go to Page 1\n\u003c/Link\u003e\n```\n\nProgrammatically navigating to a route with `navigate` function:\n\n```ts\nimport {navigate} from 'svelte-mini-router';\n\n// without query parameters\nnavigate('/page1');\n\n// with query parameters\n// means \"/page1?name=Joe\u0026age=43\"\nnavigate('/page1', {name: 'Joe', age: 43});\n```\n\n### Parameters\n\nCurrent URL path parameters can be retrieved as an object with `getPathParams` function:\n\n```ts\nimport {getPathParams} from 'svelte-mini-router';\n\n// from \"/foo/{name}/and/{age}\"\n// then \"/foo/Joe/and/43\"\nconst pathParams = getPathParams();\n// will be {name: 'Joe', age: '43'}\n```\n\nAnd query parameters with `getQueryParams` function:\n\n```ts\nimport {getQueryParams} from 'svelte-mini-router';\n\n// from \"/page1?name=Joe\u0026age=43\"\nconst queryParams = getQueryParams();\n// will be {name: 'Joe', age: '43'}\n```\n\n## License\n\nLicensed under [MIT license](https://opensource.org/licenses/MIT), see [LICENSE.md](LICENSE.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frodrigocfd%2Fsvelte-mini-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frodrigocfd%2Fsvelte-mini-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frodrigocfd%2Fsvelte-mini-router/lists"}