Form field layout with label, description and error that wire their ids to the control automatically, plus fieldset, legend, orientation and invalid/disabled state.
"use client";
import * as React from "react";
import { Button } from "@/components/ballmac/button";
import {
Field,
FieldDescription,
FieldError,
FieldGroup,
FieldLabel,
useFieldControl,
} from "@/components/ballmac/field";
import { Input } from "@/components/ballmac/input";
function EmailInput(props: React.ComponentProps<typeof Input>) {
return <Input {...useFieldControl()} {...props} />;
}
function SubdomainInput(props: React.ComponentProps<typeof Input>) {
return <Input {...useFieldControl()} {...props} />;
}
export default function FieldDemo() {
const [email, setEmail] = React.useState("jordan@");
const [touched, setTouched] = React.useState(true);
const emailError = touched && !/^\S+@\S+\.\S+$/.test(email) ? "Enter a full email address, like name@acme.com." : undefined;
return (
<form
noValidate
onSubmit={(e) => {
e.preventDefault();
setTouched(true);
}}
className="w-full max-w-sm rounded-xl border bg-card p-5 shadow-sm"
>
<FieldGroup>
<Field invalid={!!emailError}>
<FieldLabel required>Work email</FieldLabel>
<EmailInput
type="email"
autoComplete="email"
required
value={email}
onChange={(e) => setEmail(e.target.value)}
onBlur={() => setTouched(true)}
/>
<FieldDescription>We send the invite here.</FieldDescription>
<FieldError errors={[emailError]} />
</Field>
<Field>
<FieldLabel>Workspace URL</FieldLabel>
<SubdomainInput placeholder="acme" />
<FieldDescription>Letters, numbers and hyphens.</FieldDescription>
</Field>
<Button type="submit">Send invite</Button>
</FieldGroup>
</form>
);
}Installation
$ pnpm dlx shadcn@latest add @ballmac/fieldInstall the dependencies.
$ pnpm add class-variance-authorityCopy the source into your project.
components/ballmac/field.tsx// Ballmac UI: Field. https://ui.ballmac.com/components/field // Based on shadcn/ui Field (MIT, Copyright (c) 2023 shadcn), adding automatic id wiring (label, description, error) through useFieldControl and an invalid/disabled state that flows to the control. "use client"; import * as React from "react"; import { cva, type VariantProps } from "class-variance-authority"; import { cn } from "@/lib/utils"; type FieldContextValue = { id: string; invalid: boolean; disabled: boolean; }; const FieldContext = React.createContext<FieldContextValue | null>(null); type FieldControlProps = { id?: string; "aria-invalid"?: true; "aria-describedby"?: string; disabled?: true; }; /** * Props to spread on the control inside a `Field` (Input, Textarea, Select trigger, Combobox…). * It links the control to the label, description and error, and passes the invalid and disabled state. * Returns an empty object outside a `Field`. */ function useFieldControl(): FieldControlProps { const field = React.useContext(FieldContext); if (!field) return {}; return { id: field.id, "aria-invalid": field.invalid || undefined, "aria-describedby": [`${field.id}-description`, field.invalid ? `${field.id}-error` : null] .filter(Boolean) .join(" ") || undefined, disabled: field.disabled || undefined, }; } type FieldSetProps = React.ComponentProps<"fieldset">; function FieldSet({ className, ...props }: FieldSetProps) { return ( <fieldset data-slot="field-set" className={cn("flex flex-col gap-5", className)} {...props} /> ); } type FieldLegendProps = React.ComponentProps<"legend"> & { /** `legend` for a section title, `label` for a smaller heading. */ variant?: "legend" | "label"; }; function FieldLegend({ className, variant = "legend", ...props }: FieldLegendProps) { return ( <legend data-slot="field-legend" data-variant={variant} className={cn( "mb-3 font-semibold data-[variant=label]:text-sm data-[variant=legend]:text-base", className, )} {...props} /> ); } type FieldGroupProps = React.ComponentProps<"div">; function FieldGroup({ className, ...props }: FieldGroupProps) { return ( <div data-slot="field-group" className={cn("group/field-group flex w-full flex-col gap-5", className)} {...props} /> ); } const fieldVariants = cva("group/field flex w-full gap-2 data-[invalid=true]:text-destructive", { variants: { orientation: { vertical: "flex-col", horizontal: "flex-row items-center [&>[data-slot=field-label]]:flex-auto", responsive: "flex-col @md/field-group:flex-row @md/field-group:items-center @md/field-group:[&>[data-slot=field-label]]:flex-auto", }, }, defaultVariants: { orientation: "vertical" }, }); type FieldProps = React.ComponentProps<"div"> & VariantProps<typeof fieldVariants> & { /** Layout of label and control. `horizontal` suits checkboxes and switches. */ orientation?: "vertical" | "horizontal" | "responsive"; /** Marks the control invalid: the label turns destructive, the control gets `aria-invalid` and the error is announced. */ invalid?: boolean; /** Disables the control and dims the label. */ disabled?: boolean; /** Override the generated id shared by the label and control. */ controlId?: string; }; function Field({ className, orientation = "vertical", invalid = false, disabled = false, controlId, ...props }: FieldProps) { const generated = React.useId(); const id = controlId ?? generated; const value = React.useMemo(() => ({ id, invalid, disabled }), [id, invalid, disabled]); return ( <FieldContext.Provider value={value}> <div role="group" data-slot="field" data-orientation={orientation} data-invalid={invalid} data-disabled={disabled} className={cn( fieldVariants({ orientation }), "data-[disabled=true]:opacity-60", className, )} {...props} /> </FieldContext.Provider> ); } type FieldContentProps = React.ComponentProps<"div">; /** Groups the label and description beside a horizontal control. */ function FieldContent({ className, ...props }: FieldContentProps) { return ( <div data-slot="field-content" className={cn("flex flex-1 flex-col gap-1 leading-snug", className)} {...props} /> ); } type FieldLabelProps = React.ComponentProps<"label"> & { /** Show a required asterisk after the text. Add `required` to the control too. */ required?: boolean; }; function FieldLabel({ className, required, children, htmlFor, ...props }: FieldLabelProps) { const field = React.useContext(FieldContext); return ( <label data-slot="field-label" htmlFor={htmlFor ?? field?.id} className={cn( "flex w-fit select-none items-center gap-2 text-sm leading-snug font-medium group-data-[disabled=true]/field:cursor-not-allowed", className, )} {...props} > {children} {required && ( <span aria-hidden="true" className="text-destructive"> * </span> )} </label> ); } type FieldTitleProps = React.ComponentProps<"div">; /** A label-styled title for cards that hold a control (radio cards, switch rows). */ function FieldTitle({ className, ...props }: FieldTitleProps) { return ( <div data-slot="field-title" className={cn("flex w-fit items-center gap-2 text-sm leading-snug font-medium", className)} {...props} /> ); } type FieldDescriptionProps = React.ComponentProps<"p">; function FieldDescription({ className, id, ...props }: FieldDescriptionProps) { const field = React.useContext(FieldContext); return ( <p data-slot="field-description" id={id ?? (field ? `${field.id}-description` : undefined)} className={cn("text-sm leading-normal font-normal text-muted-foreground", className)} {...props} /> ); } type FieldErrorProps = Omit<React.ComponentProps<"div">, "children"> & { /** Messages to show. Duplicates are removed; one message renders as text, several as a list. */ errors?: Array<{ message?: string } | string | undefined>; /** Custom content instead of `errors`. */ children?: React.ReactNode; }; /** Announces validation messages (`role="alert"`). Renders nothing when there are none. */ function FieldError({ className, errors, children, id, ...props }: FieldErrorProps) { const field = React.useContext(FieldContext); const messages = React.useMemo(() => { const list = (errors ?? []) .map((e) => (typeof e === "string" ? e : e?.message)) .filter((m): m is string => Boolean(m)); return [...new Set(list)]; }, [errors]); const content = children ?? (messages.length === 0 ? null : messages.length === 1 ? ( messages[0] ) : ( <ul className="ms-4 flex list-disc flex-col gap-1"> {messages.map((m) => ( <li key={m}>{m}</li> ))} </ul> )); if (!content) return null; return ( <div role="alert" data-slot="field-error" id={id ?? (field ? `${field.id}-error` : undefined)} className={cn("text-sm font-normal text-destructive", className)} {...props} > {content} </div> ); } type FieldSeparatorProps = React.ComponentProps<"div"> & { /** Text in the middle of the rule, for example "or". */ children?: React.ReactNode; }; function FieldSeparator({ children, className, ...props }: FieldSeparatorProps) { return ( <div data-slot="field-separator" aria-hidden="true" className={cn("relative -my-1 flex h-5 items-center text-sm", className)} {...props} > <span className="absolute inset-x-0 h-px bg-border" /> {children && ( <span className="relative mx-auto bg-background px-2 text-muted-foreground"> {children} </span> )} </div> ); } export { Field, FieldLabel, FieldDescription, FieldError, FieldGroup, FieldLegend, FieldSeparator, FieldSet, FieldContent, FieldTitle, useFieldControl, fieldVariants, type FieldControlProps, type FieldProps, type FieldLabelProps, type FieldDescriptionProps, type FieldErrorProps, type FieldGroupProps, type FieldLegendProps, type FieldSeparatorProps, type FieldSetProps, type FieldContentProps, type FieldTitleProps, };Update the import paths to match your project setup.
Usage
import { Field, FieldLabel, FieldDescription, FieldError, FieldGroup, FieldLegend, FieldSeparator, FieldSet, FieldContent, FieldTitle, useFieldControl } from "@/components/ballmac/field"The full example is in the Code tab above.
Examples
Switch rows
import { Checkbox } from "@/components/ballmac/checkbox";
import {
Field,
FieldContent,
FieldDescription,
FieldGroup,
FieldLabel,
FieldLegend,
FieldSeparator,
FieldSet,
} from "@/components/ballmac/field";
import { Switch } from "@/components/ballmac/switch";
export default function FieldStates() {
return (
<FieldSet className="w-full max-w-sm">
<FieldLegend variant="label">Notifications</FieldLegend>
<FieldGroup className="gap-4">
<Field orientation="horizontal">
<FieldContent>
<FieldLabel htmlFor="field-product">Product updates</FieldLabel>
<FieldDescription>New features, once a month.</FieldDescription>
</FieldContent>
<Switch id="field-product" defaultChecked />
</Field>
<Field orientation="horizontal">
<FieldContent>
<FieldLabel htmlFor="field-security">Security alerts</FieldLabel>
<FieldDescription>Always on for account safety.</FieldDescription>
</FieldContent>
<Switch id="field-security" defaultChecked disabled />
</Field>
<FieldSeparator>or</FieldSeparator>
<Field orientation="horizontal" disabled>
<Checkbox id="field-digest" disabled />
<FieldLabel htmlFor="field-digest">Weekly digest (unavailable)</FieldLabel>
</Field>
</FieldGroup>
</FieldSet>
);
}API reference
<FieldControl>
| Prop | Type | Default |
|---|---|---|
id | string | — |
"aria-invalid" | true | — |
"aria-describedby" | string | — |
disabled | true | — |
<FieldLegend>
| Prop | Type | Default |
|---|---|---|
variant`legend` for a section title, `label` for a smaller heading. | "legend" | "label" | "legend" |
<Field>
| Prop | Type | Default |
|---|---|---|
orientationLayout of label and control. `horizontal` suits checkboxes and switches. | "vertical" | "horizontal" | "responsive" | "vertical" |
invalidMarks the control invalid: the label turns destructive, the control gets `aria-invalid` and the error is announced. | boolean | false |
disabledDisables the control and dims the label. | boolean | false |
controlIdOverride the generated id shared by the label and control. | string | — |
orientation | "vertical" | "horizontal" | "responsive" | "vertical" |
<FieldLabel>
| Prop | Type | Default |
|---|---|---|
requiredShow a required asterisk after the text. Add `required` to the control too. | boolean | — |
<FieldError>
| Prop | Type | Default |
|---|---|---|
errorsMessages to show. Duplicates are removed; one message renders as text, several as a list. | Array<{ message?: string } | string | undefined> | — |
childrenCustom content instead of `errors`. | React.ReactNode | — |
message | string | — |
<FieldSeparator>
| Prop | Type | Default |
|---|---|---|
childrenText in the middle of the rule, for example "or". | React.ReactNode | — |
Also accepts the standard attributes of its root element.
Accessibility
| Key | Action |
|---|---|
| Click label | Focuses the control |
| Screen readers | Read the description, and the error when invalid; the error is announced with role alert |
Quality scorecard
Every applicable check passes
Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.
Passed: Accessibility scan
No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).
Passed: Small screens
No sideways scrolling at 360, 390 or 1280 px wide.
Passed: Reduced motion
No endless animation to begin with.
Passed: Right to left
Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).
Passed: Clean console
No console errors or React hydration errors while loading.
Passed: Keyboard
4 tab stops, each showing a visible change when it takes focus. 2 documented keys.
Not applicable: Loading, empty and error
Does not show data or take submissions.
Passed: Automated tests
Covered by field.test.tsx.
For information: Footprint
2.6 KB of source (gzip) in 1 file. Installs class-variance-authority.
Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.
Use with AI
Wrap a control in Field, spread useFieldControl() on it, and label, description, error, aria-invalid and disabled are connected for you. With the shadcn MCP server set up (guide), ask your agent:
Add the Ballmac UI Field (@ballmac/field) to this project with the shadcn MCP, then use it where it fits.
Use it for
- Any labelled form control
- Forms with validation messages
- Settings rows with a switch or checkbox
Not for
- A single unlabeled search box; use search-field
- Complete form state management; combine with your form library
Registry JSON: https://ui.ballmac.com/r/field.json
Credits
Based on shadcn/ui Field, adapted by Ballmac. Free to use in personal and commercial projects.
- Registry
- shadcn/utils
Pairs well with
Input
A text input in three heights that match Button, plus InputGroup and InputGroupAddon for leading or trailing icons, units and domains.
Textarea
A multi-line text field that can grow with its content between minRows and maxRows, then scroll. Plain resizable mode when autoResize is off.
Select
A Radix select with a sized trigger, popper-positioned menu, scroll buttons, groups, labels, separators and a check indicator on the chosen item.
Checkbox
A Radix checkbox with checked and indeterminate (mixed) states, a check or minus icon, focus ring and invalid styling, for forms and select-all lists.
Ballmac UI Pro
Need the whole screen, not one piece?
311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.
Not ready? Try three Pro blocks free
Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.