Field

A component that provides labeling and validation for form controls.

Name

Visible on your profile

import { Field } from '@base-ui/react/field';
import styles from './index.module.css';

export default function ExampleField() {
  return (
    <Field.Root className={styles.Field}>
      <Field.Label className={styles.Label}>Name</Field.Label>
      <Field.Control required placeholder="Required" className={styles.Input} />

      <Field.Error className={styles.Error} match="valueMissing">
        Please enter your name
      </Field.Error>

      <Field.Description className={styles.Description}>Visible on your profile</Field.Description>
    </Field.Root>
  );
}

Anatomy

Import the component and assemble its parts:

Anatomy

import { Field } from '@base-ui/react/field';

<Field.Root>
  <Field.Label />
  <Field.Control />
  <Field.Description />
  <Field.Item />
  <Field.Error />
  <Field.Validity />
</Field.Root>

API reference

Root

Groups all parts of the field. Renders a <div> element.

namestring—

Name: name
Description: Identifies the field when a form is submitted. Takes precedence over the name prop on the <Field.Control> component.
Type: string | undefined

actionsRefReact.RefObject<Field.Root.Actions | null>—

Name: actionsRef
Description: A ref to imperative actions.

validate: Validates the field when called.
Type: | React.RefObject<Field.Root.Actions | null> | undefined

dirtyboolean—

Name: dirty
Description: Whether the field’s value has been changed from its initial value. Useful when the field state is controlled by an external library.
Type: boolean | undefined

touchedboolean—

Name: touched
Description: Whether the field has been touched. Useful when the field state is controlled by an external library.
Type: boolean | undefined

disabledbooleanfalse

Name: disabled
Description: Whether the component should ignore user interaction. Takes precedence over the disabled prop on the <Field.Control> component.
Type: boolean | undefined
Default: false

invalidboolean—

Name: invalid
Description: Whether the field is invalid. Useful when the field state is controlled by an external library.
Type: boolean | undefined

validatefunction—

Name: validate
Description: A function for custom validation. Return a string or an array of strings with the error message(s) if the value is invalid, or null if the value is valid. Asynchronous functions are supported, but they do not prevent form submission when using validationMode="onSubmit".
Type: | (( value: unknown, formValues: Form.Values, ) => | string | string[] | Promise<string | string[] | null> | null) | undefined

validationModeForm.ValidationMode'onSubmit'

Name: validationMode
Description: Determines when the field should be validated. This takes precedence over the validationMode prop on <Form>.

onSubmit: triggers validation when the form is submitted, and re-validates on change after submission.

onBlur: triggers validation when the control loses focus.

onChange: triggers validation on every change to the control value.
Type: Form.ValidationMode | undefined
Default: 'onSubmit'

validationDebounceTimenumber0

Name: validationDebounceTime
Description: How long to wait between validate callbacks if validationMode="onChange" is used. Specified in milliseconds.
Type: number | undefined
Default: 0

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Field.Root.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Field.Root.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Field.Root.State, ) => ReactElement) | undefined

data-disabled

Present when the field is disabled.

data-valid

Present when the field is valid.

data-invalid

Present when the field is invalid.

data-dirty

Present when the field’s value has changed.

data-touched

Present when the field has been touched.

data-filled

Present when the field is filled.

data-focused

Present when the field control is focused.

Attribute	Description	-
`data-disabled`	Present when the field is disabled.
`data-valid`	Present when the field is valid.
`data-invalid`	Present when the field is invalid.
`data-dirty`	Present when the field’s value has changed.
`data-touched`	Present when the field has been touched.
`data-filled`	Present when the field is filled.
`data-focused`	Present when the field control is focused.

Field.Root.PropsHide

Re-Export of Root props as FieldRootProps

Field.Root.StateHide

type FieldRootState = {
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Field.Root.ActionsHide

type FieldRootActions = { validate: () => void }

Label

An accessible label that is automatically associated with the field control. Renders a <label> element.

nativeLabelbooleantrue

Name: nativeLabel
Description: Whether the component renders a native <label> element when replacing it via the render prop. Set to false if the rendered element is not a label (for example, <div>).

This is useful to avoid inheriting label behaviors on <button> controls (such as <Select.Trigger> and <Combobox.Trigger>), including avoiding :hover on the button when hovering the label, and preventing clicks on the label from firing on the button.
Type: boolean | undefined
Default: true

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Field.Label.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Field.Label.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Field.Label.State, ) => ReactElement) | undefined

data-disabled

Present when the field is disabled.

data-valid

Present when the field is in valid state.

data-invalid

Present when the field is in invalid state.

data-dirty

Present when the field’s value has changed.

data-touched

Present when the field has been touched.

data-filled

Present when the field is filled.

data-focused

Present when the field control is focused.

Attribute	Description	-
`data-disabled`	Present when the field is disabled.
`data-valid`	Present when the field is in valid state.
`data-invalid`	Present when the field is in invalid state.
`data-dirty`	Present when the field’s value has changed.
`data-touched`	Present when the field has been touched.
`data-filled`	Present when the field is filled.
`data-focused`	Present when the field control is focused.

Field.Label.PropsHide

Re-Export of Label props as FieldLabelProps

Field.Label.StateHide

type FieldLabelState = {
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Control

The form control to label and validate. Renders an <input> element.

You can omit this part and use any Base UI input component instead. For example, Input, Checkbox, or Select, among others, will work with Field out of the box.

defaultValueUnion—

Name: defaultValue
Type: string | number | string[] | undefined

onValueChangefunction—

Name: onValueChange
Description: Callback fired when the value changes. Use when controlled.
Type: | (( value: string, eventDetails: Field.Control.ChangeEventDetails, ) => void) | undefined

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Field.Control.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Field.Control.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Field.Control.State, ) => ReactElement) | undefined

data-disabled

Present when the field is disabled.

data-valid

Present when the field is in valid state.

data-invalid

Present when the field is in invalid state.

data-dirty

Present when the field’s value has changed.

data-touched

Present when the field has been touched.

data-filled

Present when the field is filled.

data-focused

Present when the field control is focused.

Attribute	Description	-
`data-disabled`	Present when the field is disabled.
`data-valid`	Present when the field is in valid state.
`data-invalid`	Present when the field is in invalid state.
`data-dirty`	Present when the field’s value has changed.
`data-touched`	Present when the field has been touched.
`data-filled`	Present when the field is filled.
`data-focused`	Present when the field control is focused.

Field.Control.PropsHide

Re-Export of Control props as FieldControlProps

Field.Control.StateHide

type FieldControlState = {
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Field.Control.ChangeEventReasonHide

type FieldControlChangeEventReason = 'none'

Field.Control.ChangeEventDetailsHide

type FieldControlChangeEventDetails = {
  /** The reason for the event. */
  reason: 'none';
  /** The native event associated with the custom event. */
  event: Event;
  /** Cancels Base UI from handling the event. */
  cancel: () => void;
  /** Allows the event to propagate in cases where Base UI will stop the propagation. */
  allowPropagation: () => void;
  /** Indicates whether the event has been canceled. */
  isCanceled: boolean;
  /** Indicates whether the event is allowed to propagate. */
  isPropagationAllowed: boolean;
  /** The element that triggered the event, if applicable. */
  trigger: Element | undefined;
}

Description

A paragraph with additional information about the field. Renders a <p> element.

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Field.Description.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Field.Description.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Field.Description.State, ) => ReactElement) | undefined

data-disabled

Present when the field is disabled.

data-valid

Present when the field is in valid state.

data-invalid

Present when the field is in invalid state.

data-dirty

Present when the field’s value has changed.

data-touched

Present when the field has been touched.

data-filled

Present when the field is filled.

data-focused

Present when the field control is focused.

Attribute	Description	-
`data-disabled`	Present when the field is disabled.
`data-valid`	Present when the field is in valid state.
`data-invalid`	Present when the field is in invalid state.
`data-dirty`	Present when the field’s value has changed.
`data-touched`	Present when the field has been touched.
`data-filled`	Present when the field is filled.
`data-focused`	Present when the field control is focused.

Field.Description.PropsHide

Re-Export of Description props as FieldDescriptionProps

Field.Description.StateHide

type FieldDescriptionState = {
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Item

Groups individual items in a checkbox group or radio group with a label and description. Renders a <div> element.

disabledbooleanfalse

Name: disabled
Description: Whether the wrapped control should ignore user interaction. The disabled prop on <Field.Root> takes precedence over this.
Type: boolean | undefined
Default: false

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Field.Item.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Field.Item.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Field.Item.State, ) => ReactElement) | undefined

Field.Item.PropsHide

Re-Export of Item props as FieldItemProps

Field.Item.StateHide

type FieldItemState = {
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Error

An error message displayed if the field control fails validation. Renders a <div> element.

matchUnion—

Name: match
Description: Determines whether to show the error message according to the field’s ValidityState. Specifying true will always show the error message, and lets external libraries control the visibility.
Type: | boolean | 'valid' | 'badInput' | 'customError' | 'patternMismatch' | 'rangeOverflow' | 'rangeUnderflow' | 'stepMismatch' | 'tooLong' | 'tooShort' | 'typeMismatch' | 'valueMissing' | undefined

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Field.Error.State) => string | undefined) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Field.Error.State, ) => React.CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Field.Error.State, ) => ReactElement) | undefined

data-disabled

Present when the field is disabled.

data-valid

Present when the field is in valid state.

data-invalid

Present when the field is in invalid state.

data-dirty

Present when the field’s value has changed.

data-touched

Present when the field has been touched.

data-filled

Present when the field is filled.

data-focused

Present when the field control is focused.

data-starting-style

Present when the error message is animating in.

data-ending-style

Present when the error message is animating out.

Attribute	Description	-
`data-disabled`	Present when the field is disabled.
`data-valid`	Present when the field is in valid state.
`data-invalid`	Present when the field is in invalid state.
`data-dirty`	Present when the field’s value has changed.
`data-touched`	Present when the field has been touched.
`data-filled`	Present when the field is filled.
`data-focused`	Present when the field control is focused.
`data-starting-style`	Present when the error message is animating in.
`data-ending-style`	Present when the error message is animating out.

Field.Error.PropsHide

Re-Export of Error props as FieldErrorProps

Field.Error.StateHide

type FieldErrorState = {
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Validity

Used to display a custom message based on the field’s validity. Requires children to be a function that accepts field validity state as an argument.

children^*

(state: Field.Validity.State) => React.ReactNode

—

Name: children
Description: A function that accepts the field validity state as an argument.

<Field.Validity> {(validity) => { return <div>...</div> }} </Field.Validity>
Type: (state: Field.Validity.State) => React.ReactNode

Field.Validity.PropsHide

Re-Export of Validity props as FieldValidityProps

Field.Validity.StateHide

type FieldValidityState = {
  /** The validity state. */
  validity: {
    badInput: boolean;
    customError: boolean;
    patternMismatch: boolean;
    rangeOverflow: boolean;
    rangeUnderflow: boolean;
    stepMismatch: boolean;
    tooLong: boolean;
    tooShort: boolean;
    typeMismatch: boolean;
    valueMissing: boolean;
    valid: boolean | null;
  };
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
  errors: string[];
  value: unknown;
  error: string;
  initialValue: unknown;
}