CheckboxField
A checkbox input with validation.
The CheckboxField is useful for boolean inputs such as agreeing to terms.
Preview
"use client";
import { zodResolver } from "@hookform/resolvers/zod";
import { useForm, FormProvider } from "react-hook-form";
import { z } from "zod";
import CheckboxField from "@/components/ui/CheckboxField";
import { schema } from "./checkbox-field-schema";
export function CheckboxFieldBasicExample() {
const methods = useForm<z.infer<typeof schema>>({
resolver: zodResolver(schema),
defaultValues: {
accept: true,
},
});
const onSubmit = (data: z.infer<typeof schema>) => {
console.log("Form data:", data);
alert("Check the console for the form data!");
};
return (
<FormProvider {...methods}>
<form onSubmit={methods.handleSubmit(onSubmit)} className="space-y-4 w-80">
<CheckboxField name="accept" label="I agree to the terms and conditions" />
<button
type="submit"
className="form-button form-button-primary w-full"
>
Submit
</button>
</form>
</FormProvider>
);
}
Props
| Name | Type | Default | Description |
|---|---|---|---|
| name* | string | - | The name attribute used for form registration. |
| label | string | - | Label displayed next to the checkbox. |