GitHub
DocsForm

Form

Building forms with React Hook Form and Zod validation.

Preview

Your public display name.

Max 160 characters.

Installation

npx shadcn@latest add form

Also install peer dependencies:

npm install react-hook-form @hookform/resolvers zod

Usage

"use client"

import { useForm } from "react-hook-form"
import { zodResolver } from "@hookform/resolvers/zod"
import { z } from "zod"
import {
  Form, FormControl, FormDescription,
  FormField, FormItem, FormLabel, FormMessage,
} from "@/components/ui/form"
import { Input } from "@/components/ui/input"
import { Button } from "@/components/ui/button"

const schema = z.object({
  username: z.string().min(2, "Username must be at least 2 characters."),
})

export function ProfileForm() {
  const form = useForm<z.infer<typeof schema>>({
    resolver: zodResolver(schema),
    defaultValues: { username: "" },
  })

  function onSubmit(values: z.infer<typeof schema>) {
    console.log(values)
  }

  return (
    <Form {...form}>
      <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-6">
        <FormField
          control={form.control}
          name="username"
          render={({ field }) => (
            <FormItem>
              <FormLabel>Username</FormLabel>
              <FormControl>
                <Input placeholder="johndoe" {...field} />
              </FormControl>
              <FormDescription>Your public display name.</FormDescription>
              <FormMessage />
            </FormItem>
          )}
        />
        <Button type="submit">Submit</Button>
      </form>
    </Form>
  )
}

Components

Form — wraps your form and provides context

FormField — connects a field to React Hook Form's control

FormItem — wraps the label, control, and message

FormLabel — accessible label linked to the control

FormControl — passes required a11y props to the input

FormDescription — helper text below the input

FormMessage — displays validation error messages