Skip to content
UI
On this page

Field

Provides accessible form field composition and validation.

Overview

Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.

Preview

Visitor name field with help text

Installation

Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.

Usage

Wrap FieldLabel, a control, FieldDescription and FieldError in Field.

Set bordered to add a border and padding to Field. The default is false. This does not change the control border.

Field connects validation state and accessible descriptions. FieldControl provides the underlying control integration. FieldValidity provides render access to validation results. FieldItem arranges a control and its label.

Import from the local file installed by the CLI.

API reference

The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.

View API reference