路由
本页内容

路由

配置路由

通过渲染 <Routes><Route> 来配置路由,它们将 URL 片段与 UI 元素耦合。

import React from "react";
import ReactDOM from "react-dom/client";
import { BrowserRouter, Routes, Route } from "react-router";
import App from "./app";

const root = document.getElementById("root");

ReactDOM.createRoot(root).render(
  <BrowserRouter>
    <Routes>
      <Route path="/" element={<App />} />
    </Routes>
  </BrowserRouter>,
);

这是一个更大的配置示例

<Routes>
  <Route index element={<Home />} />
  <Route path="about" element={<About />} />

  <Route element={<AuthLayout />}>
    <Route path="login" element={<Login />} />
    <Route path="register" element={<Register />} />
  </Route>

  <Route path="concerts">
    <Route index element={<ConcertsHome />} />
    <Route path=":city" element={<City />} />
    <Route path="trending" element={<Trending />} />
  </Route>
</Routes>

嵌套路由

路由可以嵌套在父路由内部。

<Routes>
  <Route path="dashboard" element={<Dashboard />}>
    <Route index element={<Home />} />
    <Route path="settings" element={<Settings />} />
  </Route>
</Routes>

父路由的路径会自动包含在子路由中,因此此配置会同时创建 "/dashboard""/dashboard/settings" 这两个 URL。

子路由通过父路由中的 <Outlet/> 进行渲染。

import { Outlet } from "react-router";

export default function Dashboard() {
  return (
    <div>
      <h1>Dashboard</h1>
      {/* will either be <Home/> or <Settings/> */}
      <Outlet />
    </div>
  );
}

布局路由

没有 path 的路由为其子路由创建新的嵌套,但它们不会向 URL 添加任何片段。

<Routes>
  <Route element={<MarketingLayout />}>
    <Route index element={<MarketingHome />} />
    <Route path="contact" element={<Contact />} />
  </Route>

  <Route path="projects">
    <Route index element={<ProjectsHome />} />
    <Route element={<ProjectsLayout />}>
      <Route path=":pid" element={<Project />} />
      <Route path=":pid/edit" element={<EditProject />} />
    </Route>
  </Route>
</Routes>

索引路由

索引路由在其父路由的 URL 处渲染到其父路由的 <Outlet/> 中(就像一个默认的子路由)。它们通过 index 属性配置

<Routes>
  <Route path="/" element={<Root />}>
    {/* renders into the outlet in <Root> at "/" */}
    <Route index element={<Home />} />

    <Route path="dashboard" element={<Dashboard />}>
      {/* renders into the outlet in <Dashboard> at "/dashboard" */}
      <Route index element={<DashboardHome />} />
      <Route path="settings" element={<Settings />} />
    </Route>
  </Route>
</Routes>

请注意,索引路由不能有子路由。如果您期望这种行为,您可能需要一个布局路由

路由前缀

一个没有 element 属性的 <Route path> 会为其子路由添加一个路径前缀,而不会引入父布局。

<Route path="projects">
  <Route index element={<ProjectsHome />} />
  <Route element={<ProjectsLayout />}>
    <Route path=":pid" element={<Project />} />
    <Route path=":pid/edit" element={<EditProject />} />
  </Route>
</Route>

动态段

如果路径段以 : 开头,那么它就变成了一个“动态段”。当路由匹配 URL 时,动态段将从 URL 中解析出来,并作为 params 提供给其他路由器 API,如 useParams

<Route path="teams/:teamId" element={<Team />} />
import { useParams } from "react-router";

export default function Team() {
  let params = useParams();
  // params.teamId
}

你可以在一个路由路径中拥有多个动态段

<Route
  path="/c/:categoryId/p/:productId"
  element={<Product />}
/>
import { useParams } from "react-router";

export default function CategoryProduct() {
  let { categoryId, productId } = useParams();
  // ...
}

您应该确保给定路径中的所有动态段都是唯一的。否则,在填充 params 对象时,后面的动态段值将覆盖前面的值。

可选段

你可以通过在段的末尾添加 ? 来使路由段变为可选。

<Route path=":lang?/categories" element={<Categories />} />

你也可以有可选的静态段

<Route path="users/:userId/edit?" element={<User />} />

Splat 路由

也称为“catchall”(捕获所有)和“star”(星号)段。如果路由路径模式以 /* 结尾,它将匹配 / 之后的任何字符,包括其他的 / 字符。

<Route path="files/*" element={<File />} />
let params = useParams();
// params["*"] will contain the remaining URL after files/
let filePath = params["*"];

你可以解构 *,只需要给它分配一个新名称。一个常见的名称是 splat

let { "*": splat } = useParams();

链接

使用 LinkNavLink 从您的 UI 链接到路由

import { NavLink, Link } from "react-router";

function Header() {
  return (
    <nav>
      {/* NavLink makes it easy to show active states */}
      <NavLink
        to="/"
        className={({ isActive }) =>
          isActive ? "active" : ""
        }
      >
        Home
      </NavLink>

      <Link to="/concerts/salt-lake-city">Concerts</Link>
    </nav>
  );
}

下一步: 导航

文档和示例 CC 4.0
编辑