Ballmac UI home

Field

Form field layout with label, description and error that wire their ids to the control automatically, plus fieldset, legend, orientation and invalid/disabled state.

We send the invite here.

Letters, numbers and hyphens.

Installation

$ pnpm dlx shadcn@latest add @ballmac/field

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

Notifications

New features, once a month.

Always on for account safety.

API reference

<FieldControl>

PropTypeDefault
idstring—
"aria-invalid"true—
"aria-describedby"string—
disabledtrue—

<FieldLegend>

PropTypeDefault
variant

`legend` for a section title, `label` for a smaller heading.

"legend" | "label""legend"

<Field>

PropTypeDefault
orientation

Layout of label and control. `horizontal` suits checkboxes and switches.

"vertical" | "horizontal" | "responsive""vertical"
invalid

Marks the control invalid: the label turns destructive, the control gets `aria-invalid` and the error is announced.

booleanfalse
disabled

Disables the control and dims the label.

booleanfalse
controlId

Override the generated id shared by the label and control.

string—
orientation"vertical" | "horizontal" | "responsive""vertical"

<FieldLabel>

PropTypeDefault
required

Show a required asterisk after the text. Add `required` to the control too.

boolean—

<FieldError>

PropTypeDefault
errors

Messages to show. Duplicates are removed; one message renders as text, several as a list.

Array<{ message?: string } | string | undefined>—
children

Custom content instead of `errors`.

React.ReactNode—
messagestring—

<FieldSeparator>

PropTypeDefault
children

Text in the middle of the rule, for example "or".

React.ReactNode—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
Click labelFocuses the control
Screen readersRead the description, and the error when invalid; the error is announced with role alert

Quality scorecard

7/7

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • 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

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.