主分支
分支
main (6.23.1)dev
版本
6.23.1v4/5.xv3.x
useOutletContext

useOutletContext

类型声明
declare function useOutletContext<
  Context = unknown
>(): Context;

通常父路由管理状态或其他您希望与子路由共享的值。 您可以创建自己的 上下文提供者,但这种情况非常普遍,因此它内置在 <Outlet />

function Parent() {
  const [count, setCount] = React.useState(0);
  return <Outlet context={[count, setCount]} />;
}
import { useOutletContext } from "react-router-dom";

function Child() {
  const [count, setCount] = useOutletContext();
  const increment = () => setCount((c) => c + 1);
  return <button onClick={increment}>{count}</button>;
}

如果您使用的是 TypeScript,我们建议父组件提供一个自定义钩子来访问上下文值。 这使得消费者更容易获得良好的类型,控制消费者,并了解谁正在使用上下文值。 以下是一个更现实的示例

import * as React from "react";
import type { User } from "./types";
import { Outlet, useOutletContext } from "react-router-dom";

type ContextType = { user: User | null };

export default function Dashboard() {
  const [user, setUser] = React.useState<User | null>(null);

  return (
    <div>
      <h1>Dashboard</h1>
      <Outlet context={{ user } satisfies ContextType} />
    </div>
  );
}

export function useUser() {
  return useOutletContext<ContextType>();
}
import { useUser } from "../dashboard";

export default function DashboardMessages() {
  const { user } = useUser();
  return (
    <div>
      <h2>Messages</h2>
      <p>Hello, {user.name}!</p>
    </div>
  );
}