路由对象

介绍

传递给 createBrowserRouter 的对象称为路由对象。

createBrowserRouter([
  {
    path: "/",
    Component: App,
  },
]);

路由模块是 React Router 数据功能的基础，它们定义了

数据加载
actions
重新验证
错误边界
等等

本指南快速概述了路由对象的每个功能。

Component

路由对象中的 Component 属性定义了当路由匹配时将渲染的组件。

createBrowserRouter([
  {
    path: "/",
    Component: MyRouteComponent,
  },
]);

function MyRouteComponent() {
  return (
    <div>
      <h1>Look ma!</h1>
      <p>
        I'm still using React Router after like 10 years.
      </p>
    </div>
  );
}

`loader`

路由 loader 在路由组件渲染之前为其提供数据。

import {
  useLoaderData,
  createBrowserRouter,
} from "react-router";

createBrowserRouter([
  {
    path: "/",
    loader: loader,
    Component: MyRoute,
  },
]);

async function loader({ params }) {
  return { message: "Hello, world!" };
}

function MyRoute() {
  let data = useLoaderData();
  return <h1>{data.message}</h1>;
}

另请参阅

loader params

`action`

路由 actions 允许进行服务器端数据修改，当从 <Form>、useFetcher 和 useSubmit 调用时，会自动重新验证页面上的所有 loader 数据。

import {
  createBrowserRouter,
  useLoaderData,
  useActionData,
  Form,
} from "react-router";
import { TodoList } from "~/components/TodoList";

createBrowserRouter([
  {
    path: "/items",
    action: action,
    loader: loader,
    Component: Items,
  },
]);

async function action({ request }) {
  const data = await request.formData();
  const todo = await fakeDb.addItem({
    title: data.get("title"),
  });
  return { ok: true };
}

// this data will be revalidated after the action completes...
async function loader() {
  const items = await fakeDb.getItems();
  return { items };
}

// ...so that the list here is updated automatically
export default function Items() {
  let data = useLoaderData();
  return (
    <div>
      <List items={data.items} />
      <Form method="post" navigate={false}>
        <input type="text" name="title" />
        <button type="submit">Create Todo</button>
      </Form>
    </div>
  );
}

`shouldRevalidate`

默认情况下，所有路由在 action 执行后都会重新验证。此函数允许路由选择退出对其数据没有影响的 action 的重新验证。

import type { ShouldRevalidateFunctionArgs } from "react-router";

function shouldRevalidate(
  arg: ShouldRevalidateFunctionArgs
) {
  return true; // false
}

createBrowserRouter([
  {
    path: "/",
    shouldRevalidate: shouldRevalidate,
    Component: MyRoute,
  },
]);

`lazy`

大多数属性可以进行懒加载导入，以减小初始捆绑包大小。

createBrowserRouter([
  {
    path: "/app",
    lazy: async () => {
      // load component and loader in parallel before rendering
      const [Component, loader] = await Promise.all([
        import("./app"),
        import("./app-loader"),
      ]);
      return { Component, loader };
    },
  },
]);

下一篇：数据加载