API Reference
Every public Extro API, one templated page each.
The reference covers Extro's full public surface. For concepts and learning order, start with the Guide; these pages are for lookup.
Configuration
extro.config.ts
Every config option with type, default, and behavior.
CLI
extro dev and extro build.
File Conventions
page.tsx, layout.tsx, error.tsx, not-found.tsx, and the script entries.
Components
Hooks
All hooks are imported from extrojs/navigation and must be called inside a routable surface.
useRouter
Programmatic navigation: push, replace, back, forward.
useLocation
The current pathname and search string.
useParams
Dynamic segment values of the matched route.
useSearchParams
Read and write the query string.
Functions
Import map
| Subpath | Exports |
|---|---|
extrojs | defineConfig |
extrojs/link | Link |
extrojs/navigation | useRouter, useLocation, useParams, useSearchParams, and the PageProps, LayoutProps, ErrorProps, Router types |
extrojs/asset | asset |
extrojs/client | ambient import.meta.env typing for scripts |