Field

Provides a flexible container for form inputs, labels, and helper text.

LabelPlease enter your E-Mail

Examples

The Field component provides contexts such as invalid, disabled, required, and readOnly for form elements. While most Ark UI components natively support these contexts, you can also use the Field component with standard HTML form elements.

Input

This example shows how to use the Field component with a standard input field.

Example not found

Example not found

Example not found

Example not found

Textarea

This example illustrates how to use the Field component with a textarea element.

Example not found

Example not found

Example not found

Example not found

Textarea Autoresize

Pass the autoresize prop to the Textarea component to enable automatic resizing as the user types.

Example not found

Example not found

Example not found

Example not found

Select

This example demonstrates how to integrate the Field component with a select dropdown.

Example not found

Example not found

Example not found

Example not found

Checkbox

This example demonstrates how to integrate the Field and Checkbox components.

Example not found

Example not found

Example not found

Example not found

Root Provider

Use the useField hook to create the field store and pass it to the Field.RootProvider component. This allows you to have maximum control over the field programmatically.

Example not found

Example not found

Example not found

Example not found

If you're using the Field.RootProvider component, you don't need to use the Field.Root component.

Custom Control

Use the Field.Context or useFieldContext hook to access the internal state of the field.This can help you wire up custom controls with the Field component.

Example not found

Example not found

Example not found

Example not found

API Reference

Root

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.
`disabled`		`boolean` Indicates whether the field is disabled.
`ids`		`ElementIds` The ids of the field parts.
`invalid`		`boolean` Indicates whether the field is invalid.
`readOnly`		`boolean` Indicates whether the field is read-only.
`required`		`boolean` Indicates whether the field is required.

ErrorText

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

HelperText

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Input

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Label

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

RequiredIndicator

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.
`fallback`		`string \| number \| bigint \| boolean \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| Promise<...>`

RootProvider

Prop	Default	Type
`value`		`{ ariaDescribedby: string \| undefined; ids: { root: string; control: string; label: string; errorText: string; helperText: string; }; refs: { rootRef: RefObject<HTMLDivElement \| null>; }; ... 11 more ...; getRequiredIndicatorProps: () => Omit<...>; }`
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Select

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.

Textarea

Prop	Default	Type
`asChild`		`boolean` Use the provided child element as the default rendered element, combining their props and behavior. For more details, read our Composition guide.
`autoresize`	`false`	`boolean` Whether the textarea should autoresize