Aura Router

Aura Router upgrades ordinary HTML pages with client-side navigation. This guide is the canonical documentation for @auraui/router.

Current release: 0.3.0. Pin the package version and check the changelog when upgrading.

New to Aura Router? Complete Static site → SPA in 10 minutes first, then use these chapters for concepts and API details.

Read in order

1. Fundamentals — install the package, learn the three elements, and create the first routes.

2. Routes and navigation — define paths, upgrade links, understand matching, and redirect.

3. Views and layouts — load content, use extract, nest routes, and preserve shared layouts.

4. Document meta — keep title, description, canonical, and social tags in sync on navigation.

5. Lifecycle and route data — add guards, loaders, updates, cleanup, and transitions.

6. First paint: MPA → SPA — adopt server-rendered HTML without refetching the current route.

7. Navigation experience — configure scroll, prefetch, cache, and loading feedback.

8. Errors and accessibility — handle 404s and failures, active links, and focus.

9. API reference — look up defaults, methods, events, public types, and compatibility.

Each chapter links to the previous and next chapter. You can follow the guide linearly without choosing between multiple documentation paths.

Task-focused examples

Use the recipes when you want a focused copy-and-paste pattern:

• Authentication
• Nested layouts
• Prefetch and cache
• Not found and errors
• First paint

Related documentation

• 10-minute tutorial — upgrade two complete HTML pages and verify progressive enhancement
• What Aura is not — boundaries vs Turbo / Unpoly / swup / htmx; forms stay in the app
• README — project overview and quick start
• Known limitations
• Security policy
• Roadmap
• Changelog