react-dev

React TypeScript

类型安全的 React = 编译期保证 = 有信心的重构。

<when_to_use>

• 构建带类型的 React 组件
• 实现泛型组件
• 为事件处理器、表单、ref 添加类型
• 使用 React 19 特性（Actions、Server Components、use()）
• 路由集成（TanStack Router、React Router）
• 具有正确类型的自定义 Hook

不适用于：非 React 的 TypeScript、原生 JS React

</when_to_use>

<react_19_changes>

React 19 的破坏性变更需要进行迁移。关键模式：

ref 作为 prop - forwardRef 已弃用：

// React 19 - ref as regular prop
type ButtonProps = {
  ref?: React.Ref<HTMLButtonElement>;
} & React.ComponentPropsWithoutRef<'button'>;

function Button({ ref, children, ...props }: ButtonProps) {
  return <button ref={ref} {...props}>{children}</button>;
}

useActionState - 取代 useFormState：

import { useActionState } from 'react';

type FormState = { errors?: string[]; success?: boolean };

function Form() {
  const [state, formAction, isPending] = useActionState(submitAction, {});
  return <form action={formAction}>...</form>;
}

use() - 解包 promise/context：

function UserProfile({ userPromise }: { userPromise: Promise<User> }) {
  const user = use(userPromise); // Suspends until resolved
  return <div>{user.name}</div>;
}

关于 useOptimistic、useTransition 和迁移检查清单，请参阅 react-19-patterns.md。

</react_19_changes>

<component_patterns>

Props - 扩展原生元素：

type ButtonProps = {
  variant: 'primary' | 'secondary';
} & React.ComponentPropsWithoutRef<'button'>;

function Button({ variant, children, ...props }: ButtonProps) {
  return <button className={variant} {...props}>{children}</button>;
}

子元素类型：

type Props = {
  children: React.ReactNode;          // Anything renderable
  icon: React.ReactElement;           // Single element
  render: (data: T) => React.ReactNode;  // Render prop
};

可辨识联合用于变体 props：

type ButtonProps =
  | { variant: 'link'; href: string }
  | { variant: 'button'; onClick: () => void };

function Button(props: ButtonProps) {
  if (props.variant === 'link') {
    return <a href={props.href}>Link</a>;
  }
  return <button onClick={props.onClick}>Button</button>;
}

</component_patterns>

<event_handlers>

使用具体的事件类型以实现准确的 target 类型：

// Mouse
function handleClick(e: React.MouseEvent<HTMLButtonElement>) {
  e.currentTarget.disabled = true;
}

// Form
function handleSubmit(e: React.FormEvent<HTMLFormElement>) {
  e.preventDefault();
  const formData = new FormData(e.currentTarget);
}

// Input
function handleChange(e: React.ChangeEvent<HTMLInputElement>) {
  console.log(e.target.value);
}

// Keyboard
function handleKeyDown(e: React.KeyboardEvent<HTMLInputElement>) {
  if (e.key === 'Enter') e.currentTarget.blur();
}

关于 focus、drag、clipboard、touch、wheel 事件，请参阅 event-handlers.md。

</event_handlers>

<hooks_typing>

useState - 对联合类型/null 显式标注：

const [user, setUser] = useState<User | null>(null);
const [status, setStatus] = useState<'idle' | 'loading'>('idle');

useRef - DOM 使用 null，可变值使用初始值：

const inputRef = useRef<HTMLInputElement>(null);  // DOM - use ?.
const countRef = useRef<number>(0);               // Mutable - direct access

useReducer - 对 action 使用可辨识联合：

type Action =
  | { type: 'increment' }
  | { type: 'set'; payload: number };

function reducer(state: State, action: Action): State {
  switch (action.type) {
    case 'set': return { ...state, count: action.payload };
    default: return state;
  }
}

自定义 Hook - 使用 as const 返回元组：

function useToggle(initial = false) {
  const [value, setValue] = useState(initial);
  const toggle = () => setValue(v => !v);
  return [value, toggle] as const;
}

useContext - null 守卫模式：

const UserContext = createContext<User | null>(null);

function useUser() {
  const user = useContext(UserContext);
  if (!user) throw new Error('useUser outside UserProvider');
  return user;
}

关于 useCallback、useMemo、useImperativeHandle、useSyncExternalStore，请参阅 hooks.md。

</hooks_typing>

<generic_components>

泛型组件从 props 推断类型 - 调用处无需手动标注。

模式 - 使用 keyof T 表示列键，使用 render props 实现自定义渲染：

type Column<T> = {
  key: keyof T;
  header: string;
  render?: (value: T[keyof T], item: T) => React.ReactNode;
};

type TableProps<T> = {
  data: T[];
  columns: Column<T>[];
  keyExtractor: (item: T) => string | number;
};

function Table<T>({ data, columns, keyExtractor }: TableProps<T>) {
  return (
    <table>
      <thead>
        <tr>{columns.map(col => <th key={String(col.key)}>{col.header}</th>)}</tr>
      </thead>
      <tbody>
        {data.map(item => (
          <tr key={keyExtractor(item)}>
            {columns.map(col => (
              <td key={String(col.key)}>
                {col.render ? col.render(item[col.key], item) : String(item[col.key])}
              </td>
            ))}
          </tr>
        ))}
      </tbody>
    </table>
  );
}

约束泛型用于必需属性：

type HasId = { id: string | number };

function List<T extends HasId>({ items }: { items: T[] }) {
  return <ul>{items.map(item => <li key={item.id}>...</li>)}</ul>;
}

关于 Select、List、Modal、FormField 模式，请参阅 generic-components.md。

</generic_components>

<server_components>

React 19 Server Components 在服务端运行，可以是异步的。

异步数据获取：

export default async function UserPage({ params }: { params: { id: string } }) {
  const user = await fetchUser(params.id);
  return <div>{user.name}</div>;
}

Server Actions - 使用 'use server' 进行变更：

'use server';

export async function updateUser(userId: string, formData: FormData) {
  await db.user.update({ where: { id: userId }, data: { ... } });
  revalidatePath(`/users/${userId}`);
}

客户端 + Server Action：

'use client';

import { useActionState } from 'react';
import { updateUser } from '@/actions/user';

function UserForm({ userId }: { userId: string }) {
  const [state, formAction, isPending] = useActionState(
    (prev, formData) => updateUser(userId, formData), {}
  );
  return <form action={formAction}>...</form>;
}

use() 用于 promise 传递：

// Server: pass promise without await
async function Page() {
  const userPromise = fetchUser('123');
  return <UserProfile userPromise={userPromise} />;
}

// Client: unwrap with use()
'use client';
function UserProfile({ userPromise }: { userPromise: Promise<User> }) {
  const user = use(userPromise);
  return <div>{user.name}</div>;
}

关于并行获取、流式传输、错误边界，请参阅 server-components.md。

</server_components>

TanStack Router 和 React Router v7 都提供类型安全的路由解决方案。

TanStack Router - 使用 Zod 校验实现编译期类型安全：

import { createRoute } from '@tanstack/react-router';
import { z } from 'zod';

const userRoute = createRoute({
  path: '/users/$userId',
  component: UserPage,
  loader: async ({ params }) => ({ user: await fetchUser(params.userId) }),
  validateSearch: z.object({
    tab: z.enum(['profile', 'settings']).optional(),
    page: z.number().int().positive().default(1),
  }),
});

function UserPage() {
  const { user } = useLoaderData({ from: userRoute.id });
  const { tab, page } = useSearch({ from: userRoute.id });
  const { userId } = useParams({ from: userRoute.id });
}

React Router v7 - 使用 Framework Mode 自动生成类型：

import type { Route } from "./+types/user";

export async function loader({ params }: Route.LoaderArgs) {
  return { user: await fetchUser(params.userId) };
}

export default function UserPage({ loaderData }: Route.ComponentProps) {
  const { user } = loaderData; // Typed from loader
  return <h1>{user.name}</h1>;
}

关于 TanStack 模式，请参阅 tanstack-router.md；关于 React Router 模式，请参阅 react-router.md。

始终：

• 使用具体的事件类型（MouseEvent、ChangeEvent 等）
• 对联合类型/null 显式使用 useState
• 使用 ComponentPropsWithoutRef 扩展原生元素
• 对变体 props 使用可辨识联合
• 对元组返回使用 as const
• 在 React 19 中使用 ref 作为 prop（不使用 forwardRef）
• 对表单 action 使用 useActionState
• 使用类型安全的路由模式（见路由部分）

绝不：

• 为事件处理器使用 any
• 为子元素使用 JSX.Element（应使用 ReactNode）
• 在 React 19+ 中使用 forwardRef
• 使用 useFormState（已弃用）
• 忘记处理 DOM ref 的 null
• 在同一文件中混用 Server/Client 组件
• 在传递给 use() 时 await promise

- [hooks.md](references/hooks.md) - useState、useRef、useReducer、useContext、自定义 Hook - [event-handlers.md](references/event-handlers.md) - 所有事件类型、通用处理程序 - [react-19-patterns.md](references/react-19-patterns.md) - useActionState、use()、useOptimistic、迁移 - [generic-components.md](examples/generic-components.md) - Table、Select、List、Modal 模式 - [server-components.md](examples/server-components.md) - 异步组件、Server Actions、流式传输 - [tanstack-router.md](references/tanstack-router.md) - TanStack Router 类型化路由、搜索参数、导航 - [react-router.md](references/react-router.md) - React Router v7 loader、action、类型生成、表单