@pdxui/router
v1.0.0-beta.1
Published
Compiled router for PDX UI — generates optimized ad-hoc router from @page declarations
Readme
@pdxui/router
Routing for PDX UI. A .pdx file becomes a page by declaring its path. The compiler collects
the declarations into the route table, and each page loads lazily.
pnpm add @pdxui/router@page '/users/:id';
@guard 'admin.users';<nav><pdx-link to="/users/:id" :params="{ id: 42 }">Ada</pdx-link></nav>
<pdx-router-outlet></pdx-router-outlet>The first block is a page; the second is the app shell that renders it. navigate('/users/:id', { id: 42 })
from @pdxui/router navigates from code; a route's pattern and its params are checked against the
declared @pages, and a built URL goes to navigate.url('/users/42').
Routes are destroyed when you leave them. A route declared @page '/results' { keepAlive }; is
frozen instead and resumed on return. One router runs in development and in a build: the compiler
emits the route table from the project's @page declarations, and the router builds its matcher from
it once, at startup.
Entry points
| Import | Contents |
|--------|----------|
| @pdxui/router | Navigation, guards, the current route and its params |
| @pdxui/router/outlet | <pdx-router-outlet> |
| @pdxui/router/link | <pdx-link> |
Documentation
Router, and the architecture.
License
MIT.
