文档
React Hook Form

React Hook Form

使用 React Hook Form 和 Zod 构建表单。

文档

表单很棘手。它们是你在 Web 应用程序中构建的最常见的东西之一，但也是最复杂的东西之一。

设计良好的 HTML 表单

  • 结构良好且语义正确。
  • 易于使用和导航（键盘）。
  • 使用 ARIA 属性和适当的标签进行访问。
  • 支持客户端和服务器端验证。
  • 样式良好，与应用程序的其余部分保持一致。

在本指南中，我们将探讨如何使用 react-hook-form 和 zod 构建表单。我们将使用 <FormField> 组件来使用 Radix UI 组件组合可访问的表单。

功能

<Form /> 组件是 react-hook-form 库的包装器。它提供了一些功能

  • 用于构建表单的可组合组件。
  • 用于构建受控表单字段的 <FormField /> 组件。
  • 使用 zod 进行表单验证。
  • 处理可访问性和错误消息。
  • 使用 React.useId() 生成唯一 ID。
  • 根据状态将正确的 aria 属性应用于表单字段。
  • 旨在与所有 Radix UI 组件配合使用。
  • 自带架构库。我们使用 zod，但你可以使用任何你想要的库。
  • 你可以完全控制标记和样式。

结构

<Form>
  <FormField
    control={...}
    name="..."
    render={() => (
      <FormItem>
        <FormLabel />
        <FormControl>
          { /* Your form field */}
        </FormControl>
        <FormDescription />
        <FormMessage />
      </FormItem>
    )}
  />
</Form>

示例

const form = useForm()
 
<FormField
  control={form.control}
  name="username"
  render={({ field }) => (
    <FormItem>
      <FormLabel>Username</FormLabel>
      <FormControl>
        <Input placeholder="shadcn" {...field} />
      </FormControl>
      <FormDescription>This is your public display name.</FormDescription>
      <FormMessage />
    </FormItem>
  )}
/>

安装

命令

npx shadcn@latest add form

使用

创建表单架构

使用 Zod 架构定义表单的形状。你可以在 Zod 文档 中了解更多关于使用 Zod 的信息。

"use client"
 
import { z } from "zod"
 
const formSchema = z.object({
  username: z.string().min(2).max(50),
})

定义表单

使用 react-hook-form 中的 useForm 钩子创建一个表单。

"use client"
 
import { zodResolver } from "@hookform/resolvers/zod"
import { useForm } from "react-hook-form"
import { z } from "zod"
 
const formSchema = z.object({
  username: z.string().min(2, {
    message: "Username must be at least 2 characters.",
  }),
})
 
export function ProfileForm() {
  // 1. Define your form.
  const form = useForm<z.infer<typeof formSchema>>({
    resolver: zodResolver(formSchema),
    defaultValues: {
      username: "",
    },
  })
 
  // 2. Define a submit handler.
  function onSubmit(values: z.infer<typeof formSchema>) {
    // Do something with the form values.
    // ✅ This will be type-safe and validated.
    console.log(values)
  }
}

由于 FormField 使用受控组件，你需要为该字段提供默认值。有关受控组件的更多信息，请参阅 React Hook Form 文档。

构建表单

现在我们可以使用 <Form /> 组件来构建我们的表单。

"use client"
 
import { zodResolver } from "@hookform/resolvers/zod"
import { useForm } from "react-hook-form"
import { z } from "zod"
 
import { Button } from "@/components/ui/button"
import {
  Form,
  FormControl,
  FormDescription,
  FormField,
  FormItem,
  FormLabel,
  FormMessage,
} from "@/components/ui/form"
import { Input } from "@/components/ui/input"
 
const formSchema = z.object({
  username: z.string().min(2, {
    message: "Username must be at least 2 characters.",
  }),
})
 
export function ProfileForm() {
  // ...
 
  return (
    <Form {...form}>
      <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-8">
        <FormField
          control={form.control}
          name="username"
          render={({ field }) => (
            <FormItem>
              <FormLabel>Username</FormLabel>
              <FormControl>
                <Input placeholder="shadcn" {...field} />
              </FormControl>
              <FormDescription>
                This is your public display name.
              </FormDescription>
              <FormMessage />
            </FormItem>
          )}
        />
        <Button type="submit">Submit</Button>
      </form>
    </Form>
  )
}

完成

就是这样。现在你拥有一个完全可访问的表单，该表单具有类型安全性和客户端验证。

This is your public display name.

示例

查看以下链接，了解有关如何将 <Form /> 组件与其他组件一起使用的更多示例

下拉菜单悬停卡