Forms and selection · stable · MIT

Field

One labelled control with descriptions, validation, and layout state.

Install editable source

Add Field

Base UI / canonicalnpx shadcn@latest add https://gummyui.dev/r/gummy-field.json

No package dependency beyond React. Shared Gummy material is resolved automatically.

Behavior contract

Semantics before surface

Semantics

Generated IDs associate label, description, and alert feedback.

Keyboard

Follows the composed control.

System support

Light and dark themes, logical RTL layout, reduced motion, responsive content, and forwarded public refs.

Source-derived reference

Anatomy and public API

Exported anatomy

These public React parts are read directly from the canonical source during the documentation build.

  • GummyField

Prop contracts

GummyFieldProps

Composes Omit< React.HTMLAttributes<HTMLDivElement>, "children" > & { /** One native or custom form control. Its accessibility props are composed. */ children: React.ReactElement<GummyFieldControlProps>; /** Visible label associated to the child control. */ label: React.ReactNode; description?: React.ReactNode; errorMessage?: React.ReactNode; successMessage?: React.ReactNode; required?: boolean; optional?: boolean; disabled?: boolean; readOnly?: boolean; orientation?: "vertical" | "horizontal"; density?: "default" | "compact"; controlId?: string; }

Troubleshooting

Check behavior before surface.

Live product source

Inspect the canonical states

The Component Lab exercises real source across default, focus, disabled, responsive, dark, reduced-motion, and RTL contexts.

Open the live Component Lab

Interactive inspection

Try Field in context

Resize the canvas, switch its theme, or reverse its reading direction without changing the rest of the page.

Width
Theme
Direction

Shown to collaborators.

Field preview: fluid width, light theme, left to right.

Editable source

Read before you install

Canonical Base UI or native source

Loading editable source…