@pyreon/router 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Vit Bokisch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# @pyreon/router
+
+Type-safe client-side router for Pyreon with hash and history modes, nested routes, guards, loaders, and scroll restoration.
+
+## Install
+
+```bash
+bun add @pyreon/router
+```
+
+## Quick Start
+
+```ts
+import { createRouter, RouterProvider, RouterView, RouterLink } from "@pyreon/router"
+import { h } from "@pyreon/core"
+
+const router = createRouter({
+  routes: [
+    { path: "/", component: Home },
+    { path: "/user/:id", component: UserPage, name: "user" },
+    { path: "/admin", component: AdminLayout, children: [
+      { path: "users", component: AdminUsers },
+    ]},
+    { path: "/old-path", redirect: "/new-path" },
+    { path: "/dashboard", component: lazy(() => import("./Dashboard")) },
+    { path: "(.*)", component: NotFound },
+  ],
+})
+
+const App = () =>
+  h(RouterProvider, { router },
+    h(RouterView, null))
+```
+
+## Typed Params
+
+Route parameters are inferred from path strings:
+
+```ts
+const route = useRoute<"/user/:id">()
+route().params.id // string
+```
+
+## Named Navigation
+
+```ts
+const router = useRouter()
+router.push({ name: "user", params: { id: "42" } })
+```
+
+## Data Loaders
+
+```ts
+import { useLoaderData, prefetchLoaderData } from "@pyreon/router"
+
+const data = useLoaderData<typeof loader>()
+```
+
+## API
+
+### Router Creation
+
+- `createRouter(options: RouterOptions)` -- create a router instance
+- `lazy(loader)` -- define a lazily loaded route component
+
+### Hooks
+
+- `useRouter()` -- access the router instance
+- `useRoute<Path>()` -- access the current resolved route with typed params
+- `useLoaderData<T>()` -- access data returned by a route loader
+
+### Components
+
+- `RouterProvider` -- provides router context to the tree
+- `RouterView` -- renders the matched route component
+- `RouterLink` -- anchor element with client-side navigation
+
+### Utilities
+
+- `resolveRoute(routes, path)` -- match a path against route definitions
+- `parseQuery(search)` / `parseQueryMulti(search)` -- parse query strings
+- `stringifyQuery(params)` -- serialize query parameters
+- `buildPath(pattern, params)` -- build a path from a pattern and params
+- `findRouteByName(routes, name)` -- look up a named route
+- `prefetchLoaderData(router, path)` -- prefetch loader data for a path
+- `serializeLoaderData(router)` / `hydrateLoaderData(router, data)` -- SSR serialization
+
+### Types
+
+`ExtractParams`, `RouteMeta`, `ResolvedRoute`, `RouteRecord`, `RouterOptions`, `Router`, `NavigationGuard`, `AfterEachHook`, `ScrollBehaviorFn`, `LoaderContext`, `RouteLoaderFn`