Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/remix-run/react-router/llms.txt

Use this file to discover all available pages before exploring further.

​
Route Configuration

React Router v7 uses a configuration-based approach to defining routes through the routes.ts file located in your app directory. This provides type safety, flexibility, and better maintainability compared to convention-based routing.

​
Basic Configuration

Every React Router application requires a routes.ts file that exports an array of route configuration objects: 
// app/routes.ts
import { type RouteConfig } from "@react-router/dev/routes";
import { index, route, layout } from "@react-router/dev/routes";

export default [
  index("routes/home.tsx"),
  route("about", "routes/about.tsx"),
  route("contact", "routes/contact.tsx"),
] satisfies RouteConfig;

​
Route Config Helpers

React Router provides helper functions to define routes in a type-safe, declarative way:

​
route()

Defines a standard route with a path and component file: 
import { route } from "@react-router/dev/routes";

// Basic route
route("about", "routes/about.tsx")

// Route with children
route("dashboard", "routes/dashboard.tsx", [
  route("settings", "routes/dashboard/settings.tsx"),
  route("profile", "routes/dashboard/profile.tsx"),
])

// Route with options
route("admin", "routes/admin.tsx", { caseSensitive: true })

// Route with custom ID
route("users/:id", "routes/user.tsx", { id: "user-detail" })

​
index()

Defines an index route that renders at the parent’s path: 
import { index } from "@react-router/dev/routes";

index("routes/home.tsx")

// With custom ID
index("routes/home.tsx", { id: "homepage" })

​
layout()

Defines a layout route (no path segment) that wraps child routes: 
import { layout } from "@react-router/dev/routes";

layout("routes/auth-layout.tsx", [
  route("login", "routes/login.tsx"),
  route("signup", "routes/signup.tsx"),
])

// With custom ID
layout("routes/app-layout.tsx", { id: "app" }, [
  route("dashboard", "routes/dashboard.tsx"),
])

​
prefix()

Adds a path prefix to a group of routes without requiring a parent component: 
import { prefix, route } from "@react-router/dev/routes";

export default [
  ...prefix("api", [
    route("users", "routes/api/users.tsx"),
    route("posts", "routes/api/posts.tsx"),
  ]),
];
// Creates routes: /api/users, /api/posts

​
Route Configuration Options

Each route config entry supports the following options:
OptionTypeDescription
filestringPath to the route module (relative to app directory or absolute)
pathstringURL path pattern to match
idstringUnique identifier for the route (auto-generated from file path if not provided)
indexbooleanWhether this is an index route
caseSensitivebooleanWhether path matching is case-sensitive (default: false)
childrenRouteConfigEntry[]Nested child routes

​
File-Based Routing

While manual configuration is recommended, you can use file-based routing conventions via the @react-router/fs-routes package: 
// app/routes.ts
import { type RouteConfig } from "@react-router/dev/routes";
import { flatRoutes } from "@react-router/fs-routes";

export default flatRoutes() satisfies RouteConfig;
This automatically discovers routes based on files in the app/routes/ directory. See File Conventions for details.

​
Absolute File Paths

You can use absolute paths for route modules: 
import path from "node:path";
import { type RouteConfig, index } from "@react-router/dev/routes";
import { getAppDirectory } from "@react-router/dev/routes";

export default [
  index(path.resolve(import.meta.dirname, "routes/home.tsx")),
] satisfies RouteConfig;

​
Relative Scoping

For splitting route configuration across multiple files, use the relative() helper: 
// app/routes.ts
import { route } from "@react-router/dev/routes";
import { adminRoutes } from "./routes/admin/config";

export default [
  route("admin", "routes/admin/layout.tsx", adminRoutes),
];

// app/routes/admin/config.ts
import { relative } from "@react-router/dev/routes";

const { route, index } = relative(import.meta.dirname);

export const adminRoutes = [
  index("index.tsx"),
  route("users", "users.tsx"),
  route("settings", "settings.tsx"),
];

​
Route Modules

Each route file exports React components and data functions: 
// app/routes/about.tsx
import type { Route } from "./+types/about";

export async function loader({ request }: Route.LoaderArgs) {
  return { message: "Welcome to About" };
}

export default function About({ loaderData }: Route.ComponentProps) {
  return <h1>{loaderData.message}</h1>;
}

​
Best Practices

  1. Use helpers: Always use route, index, and layout helpers instead of raw objects
  2. Type safety: Use satisfies RouteConfig to ensure type checking
  3. Relative paths: Prefer relative file paths ("routes/about.tsx") over absolute paths
  4. Logical grouping: Organize routes by feature or domain, not just URL structure
  5. Avoid deep nesting: Keep route hierarchies shallow when possible

​
Migration from Remix

If migrating from Remix with the routes option, use the adapter: 
import { remixRoutesOptionAdapter } from "@react-router/remix-routes-option-adapter";

export default remixRoutesOptionAdapter((defineRoutes) => {
  return defineRoutes((route) => {
    route("/", "routes/home.tsx", { index: true });
    route("about", "routes/about.tsx");
  });
});

Build docs developers (and LLMs) love

Get started for freeTalk to us