Field
Accessible form field building blocks with labels and descriptions.
Loading…
import { Field, FieldDescription, FieldLabel } from "@/components/ui/field";import { Input } from "@/components/ui/input";export default function FieldDemo() { return ( <div className="w-full max-w-sm"> <Field> <FieldLabel htmlFor="username">Username</FieldLabel> <Input id="username" placeholder="cortexcn" /> <FieldDescription>This is your public display name.</FieldDescription> </Field> </div> );}Installation
npx shadcn@latest add @cortexcn/fieldCopy and paste the following code into your project.
"use client";import { useMemo } from "react";import { cva, type VariantProps } from "class-variance-authority";import { cn } from "@/lib/utils";import { Label } from "@/components/ui/label";import { Separator } from "@/components/ui/separator";function FieldSet({ className, ...props }: React.ComponentProps<"fieldset">) { return ( <fieldset data-slot="field-set" className={cn( "flex flex-col gap-6", "has-[>[data-slot=checkbox-group]]:gap-3 has-[>[data-slot=radio-group]]:gap-3", className, )} {...props} /> );}function FieldLegend({ className, variant = "legend", ...props}: React.ComponentProps<"legend"> & { variant?: "legend" | "label" }) { return ( <legend data-slot="field-legend" data-variant={variant} className={cn( "mb-3 font-medium", "data-[variant=legend]:text-base", "data-[variant=label]:text-sm", className, )} {...props} /> );}function FieldGroup({ className, ...props }: React.ComponentProps<"div">) { return ( <div data-slot="field-group" className={cn( "group/field-group @container/field-group flex w-full flex-col gap-7 data-[slot=checkbox-group]:gap-3 [&>[data-slot=field-group]]:gap-4", className, )} {...props} /> );}const fieldVariants = cva( "group/field flex w-full gap-3 data-[invalid=true]:text-destructive", { variants: { orientation: { vertical: ["flex-col [&>*]:w-full [&>.sr-only]:w-auto"], horizontal: [ "flex-row items-center", "[&>[data-slot=field-label]]:flex-auto", "has-[>[data-slot=field-content]]:items-start has-[>[data-slot=field-content]]:[&>[role=checkbox],[role=radio]]:mt-px", ], responsive: [ "flex-col @md/field-group:flex-row @md/field-group:items-center [&>*]:w-full @md/field-group:[&>*]:w-auto [&>.sr-only]:w-auto", "@md/field-group:[&>[data-slot=field-label]]:flex-auto", "@md/field-group:has-[>[data-slot=field-content]]:items-start @md/field-group:has-[>[data-slot=field-content]]:[&>[role=checkbox],[role=radio]]:mt-px", ], }, }, defaultVariants: { orientation: "vertical", }, },);function Field({ className, orientation = "vertical", ...props}: React.ComponentProps<"div"> & VariantProps<typeof fieldVariants>) { return ( <div role="group" data-slot="field" data-orientation={orientation} className={cn(fieldVariants({ orientation }), className)} {...props} /> );}function FieldContent({ className, ...props }: React.ComponentProps<"div">) { return ( <div data-slot="field-content" className={cn( "group/field-content flex flex-1 flex-col gap-1.5 leading-snug", className, )} {...props} /> );}function FieldLabel({ className, ...props}: React.ComponentProps<typeof Label>) { return ( <Label data-slot="field-label" className={cn( "group/field-label peer/field-label flex w-fit gap-2 leading-snug group-data-[disabled=true]/field:opacity-50", "has-[>[data-slot=field]]:w-full has-[>[data-slot=field]]:flex-col has-[>[data-slot=field]]:rounded-md has-[>[data-slot=field]]:border [&>*]:data-[slot=field]:p-4", "has-data-[state=checked]:border-primary has-data-[state=checked]:bg-primary/5 dark:has-data-[state=checked]:bg-primary/10", className, )} {...props} /> );}function FieldTitle({ className, ...props }: React.ComponentProps<"div">) { return ( <div data-slot="field-label" className={cn( "flex w-fit items-center gap-2 text-sm leading-snug font-medium group-data-[disabled=true]/field:opacity-50", className, )} {...props} /> );}function FieldDescription({ className, ...props }: React.ComponentProps<"p">) { return ( <p data-slot="field-description" className={cn( "text-sm leading-normal font-normal text-muted-foreground group-has-[[data-orientation=horizontal]]/field:text-balance", "last:mt-0 nth-last-2:-mt-1 [[data-variant=legend]+&]:-mt-1.5", "[&>a]:underline [&>a]:underline-offset-4 [&>a:hover]:text-primary", className, )} {...props} /> );}function FieldSeparator({ children, className, ...props}: React.ComponentProps<"div"> & { children?: React.ReactNode;}) { return ( <div data-slot="field-separator" data-content={!!children} className={cn( "relative -my-2 h-5 text-sm group-data-[variant=outline]/field-group:-mb-2", className, )} {...props} > <Separator className="absolute inset-0 top-1/2" /> {children && ( <span className="relative mx-auto block w-fit bg-background px-2 text-muted-foreground" data-slot="field-separator-content" > {children} </span> )} </div> );}function FieldError({ className, children, errors, ...props}: React.ComponentProps<"div"> & { errors?: Array<{ message?: string } | undefined>;}) { const content = useMemo(() => { if (children) { return children; } if (!errors?.length) { return null; } const uniqueErrors = [ ...new Map(errors.map((error) => [error?.message, error])).values(), ]; if (uniqueErrors?.length == 1) { return uniqueErrors[0]?.message; } return ( <ul className="ml-4 flex list-disc flex-col gap-1"> {uniqueErrors.map( (error, index) => error?.message && <li key={index}>{error.message}</li>, )} </ul> ); }, [children, errors]); if (!content) { return null; } return ( <div role="alert" data-slot="field-error" className={cn("text-sm font-normal text-destructive", className)} {...props} > {content} </div> );}export { Field, FieldLabel, FieldDescription, FieldError, FieldGroup, FieldLegend, FieldSeparator, FieldSet, FieldContent, FieldTitle,};Usage
import { Field, FieldDescription, FieldLabel } from "@/components/ui/field";<Field>
<FieldLabel htmlFor="name">Name</FieldLabel>
<Input id="name" />
<FieldDescription>Your full name.</FieldDescription>
</Field>Examples
Error
Use FieldError and aria-invalid to show a validation message.
Loading…
import { Field, FieldError, FieldLabel } from "@/components/ui/field";import { Input } from "@/components/ui/input";export default function FieldErrorDemo() { return ( <div className="w-full max-w-sm"> <Field data-invalid> <FieldLabel htmlFor="email-error">Email</FieldLabel> <Input id="email-error" type="email" defaultValue="not-an-email" aria-invalid /> <FieldError>Please enter a valid email address.</FieldError> </Field> </div> );}Field Set
Group related fields with FieldSet, FieldLegend, and FieldGroup.
Loading…
import { Field, FieldDescription, FieldGroup, FieldLabel, FieldLegend, FieldSet,} from "@/components/ui/field";import { Input } from "@/components/ui/input";export default function FieldSetDemo() { return ( <div className="w-full max-w-sm"> <FieldSet> <FieldLegend>Address</FieldLegend> <FieldDescription>Where should we ship your order?</FieldDescription> <FieldGroup> <Field> <FieldLabel htmlFor="street">Street</FieldLabel> <Input id="street" placeholder="123 Main St" /> </Field> <Field> <FieldLabel htmlFor="city">City</FieldLabel> <Input id="city" placeholder="San Francisco" /> </Field> </FieldGroup> </FieldSet> </div> );}