Router reference
Compact index of @ilha/router exports mapped to the routing guides.
A map of the public @ilha/router API. For how-to guidance, start with Router overview.
Builder and routing
| Export / method | Guide |
|---|---|
router(options) |
Routes and navigation |
.route(pattern, island, loader?) |
Routes and navigation |
.mount(target, options?) |
Routes and navigation |
.hydrate(registry) / .prime() |
Routes and navigation |
navigate / prefetch / invalidate / navigating |
Routes and navigation |
useRoute / routePath / routeParams / routeSearch / routeHash / isActive |
Routes and navigation |
RouterView / RouterLink |
Routes and navigation |
Loaders
| Export / method | Guide |
|---|---|
loader / loader.client / load |
Loaders |
redirect / error / composeLoaders |
Loaders |
InferLoader / MergeLoaders |
Loaders |
.runLoader |
Loaders |
File-system routing
| Topic | Guide |
|---|---|
| Pages plugin (Vite/Rspack/Rolldown) | File-system routing |
| Layouts / error boundaries / route groups | File-system routing |
Virtual modules (ilha:pages/*, ilha:loaders) |
File-system routing |
Server rendering
| Export / method | Guide |
|---|---|
.render / .renderHydratable / .renderResponse |
Server rendering |
.respond(urlOrRequest, registry, options?) |
Server rendering |
httpResponse(body, options) / serializeHead |
Server rendering |
useContext() |
Server islands |
Server islands and security
| Topic | Guide |
|---|---|
*.server.tsx / *.server.ts islands |
Server islands |
@ilha/router/ssr middleware |
Deployment |
setFrameGuard / setLoaderGuard / setFrameAuth |
Middleware and security |