foxlau/react-router-better-auth / .agents/skills/react-router-framework-mode
react-router-framework-mode
VerifiedBuild full-stack React applications using React Router's framework mode. Use when configuring routes, working with loaders and actions, handling forms, handling navigation, pending/optimistic UI, error boundaries, or working with react-router.config.ts or other react router conventions.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 4.5 KB |
| references/actions.md | markdown | 8.9 KB |
| references/data-loading.md | markdown | 3.8 KB |
| references/error-handling.md | markdown | 4.5 KB |
| references/middleware.md | markdown | 6.6 KB |
| references/navigation.md | markdown | 4.1 KB |
| references/pending-ui.md | markdown | 6.8 KB |
| references/rendering-strategies.md | markdown | 3.8 KB |
| references/route-modules.md | markdown | 8.5 KB |
| references/routing.md | markdown | 6.0 KB |
| references/sessions.md | markdown | 10.2 KB |
| references/special-files.md | markdown | 12.2 KB |
| references/type-safety.md | markdown | 4.1 KB |
references/navigation.md
View on GitHub---
title: Navigation
description: Link, NavLink, useNavigate, redirect, and programmatic navigation
tags: [navigation, Link, NavLink, useNavigate, redirect, prefetch]
---
# Navigation
React Router provides several ways to navigate between routes.
## Link Component
Basic navigation:
```tsx
import { Link } from "react-router";
function Nav() {
return (
<nav>
<Link to="/">Home</Link>
<Link to="/about">About</Link>
<Link to="/products/123">Product</Link>
</nav>
);
}
```
### Link Props
- `to` - Destination path (string or object)
- `replace` - Replace current history entry instead of pushing
- `state` - Pass state to the destination
- `prefetch` - `"none"`, `"intent"`, `"render"`, `"viewport"`
```tsx
<Link to="/dashboard" replace state={{ from: "home" }} prefetch="intent">
Dashboard
</Link>
```
## NavLink Component
Link with active/pending state awareness:
```tsx
import { NavLink } from "react-router";
function Nav() {
return (
<nav>
<NavLink
to="/"
end
className={({ isActive }) => (isActive ? "active" : "")}
>
Home
</NavLink>
<NavLink
to="/products"
className={({ isActive, isPending }) =>
isPending ? "pending" : isActive ? "active" : ""
}
>
Products
</NavLink>
</nav>
);
}
```
### NavLink Props
- `end` - Only match if the path is exact (not just a prefix)
- `className` - String or function receiving `{ isActive, isPending }`
- `style` - Object or function receiving `{ isActive, isPending }`
- `children` - Can be a function receiving `{ isActive, isPending }`
```tsx
<NavLink to="/messages">
{({ isActive, isPending }) => (
<span>Messages {isPending && <Spinner />}</span>
)}
</NavLink>
```
## useNavigate Hook
Programmatic navigation:
```tsx
import { useNavigate } from "react-router";
function LogoutButton() {
const navigate = useNavigate();
async function handleLogout() {
await logout();
navigate("/login");
}
return <button onClick={handleLogout}>Logout</button>;
}
```
### Navigate Options
```tsx
const navigate = useNavigate();
// Basic navigation
navigate("/dashboard");
// Replace history entry
navigate("/login", { replace: true });
// Pass state
navigate("/checkout", { state: { cartId: "abc" } });
// Go back/forward
navigate(-1); // Back
navigate(1); // Forward
```
## redirect Function
Redirect from loaders and actions:
```tsx
import { redirect } from "react-router";
export async function loader({ request }: Route.LoaderArgs) {
const user = await getUser(request);
if (!user) {
throw redirect("/login");
}
return user;
}
export async function action({ request }: Route.ActionArgs) {
await createProject(request);
return redirect("/projects");
}
```
### Redirect with Status
```tsx
// Temporary redirect (302, default)
throw redirect("/new-location");
// Permanent redirect (301)
throw redirect("/new-location", { status: 301 });
```
## Form Navigation
Forms with `method="get"` navigate with search params:
```tsx
import { Form } from "react-router";
function SearchForm() {
return (
<Form method="get" action="/search">
<input type="text" name="q" />
<button type="submit">Search</button>
</Form>
);
}
// Navigates to /search?q=...
```
## Relative Navigation
Paths are relative to the current route:
```tsx
// If current URL is /products/123
<Link to="reviews"> // → /products/123/reviews
<Link to="../456"> // → /products/456
<Link to=".."> // → /products
```
Use `relative="path"` for path-based relativity instead of route-based:
```tsx
<Link to=".." relative="path">
```
## Accessing Location State
Read state passed during navigation:
```tsx
import { useLocation } from "react-router";
function Checkout() {
const location = useLocation();
const { from } = location.state || {};
return (
<div>
<h1>Checkout</h1>
{from && <Link to={from}>Go back</Link>}
</div>
);
}
```
## Scroll Restoration
`<ScrollRestoration />` (in root) handles scroll position automatically.
Prevent scroll reset on specific links:
```tsx
<Link to="/products" preventScrollReset>
Products
</Link>
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |