useTextField

Provides the behavior and accessibility implementation for a text field.

install	`yarn add @react-aria/textfield`
version	3.5.0
usage	`import {useTextField} from '@react-aria/textfield'`

View ARIA spec

W3C

API#

useTextField<T = DefaultElementType>(
  (props: AriaTextFieldOptions<T>,
  , ref: TextFieldRefObject<T>
)): TextFieldAria<T>

Features#

Text fields can be built with <input> or <textarea> and <label> elements, but you must manually ensure that they are semantically connected via ids for accessibility. useTextField helps automate this, and handle other accessibility features while allowing for custom styling.

Built with a native <input> or <textarea> element
Visual and ARIA labeling support
Change, clipboard, composition, selection, and input event support
Required and invalid states exposed to assistive technology via ARIA
Support for description and error message help text linked to the input via ARIA

Anatomy#

Text fields consist of an input element and a label. useTextField automatically manages the relationship between the two elements using the for attribute on the <label> element and the aria-labelledby attribute on the <input> element.

useTextField also supports optional description and error message elements, which can be used to provide more context about the field, and any validation messages. These are linked with the input via the aria-describedby attribute.

useTextField returns props that you should spread onto the appropriate element:

Name	Type	Description
`inputProps`	`TextFieldInputProps<T>`	Props for the input element.
`labelProps`	`LabelHTMLAttributes<HTMLLabelElement>`	Props for the text field's visible label element, if any.
`descriptionProps`	`HTMLAttributes<HTMLElement>`	Props for the text field's description element, if any.
`errorMessageProps`	`HTMLAttributes<HTMLElement>`	Props for the text field's error message element, if any.

If there is no visual label, an aria-label or aria-labelledby prop must be passed instead to identify the element to screen readers.

Example#

function TextField(props) {
  let { label } = props;
  let ref = React.useRef();
  let { labelProps, inputProps, descriptionProps, errorMessageProps } =
    useTextField(props, ref);

  return (
    <div style={{ display: 'flex', flexDirection: 'column', width: 200 }}>
      <label {...labelProps}>{label}</label>
      <input {...inputProps} ref={ref} />
      {props.description && (
        <div {...descriptionProps} style={{ fontSize: 12 }}>
          {props.description}
        </div>
      )}
      {props.errorMessage &&
        (
          <div {...errorMessageProps} style={{ color: 'red', fontSize: 12 }}>
            {props.errorMessage}
          </div>
        )}
    </div>
  );
}

<TextField
  label="Email"
  placeholder="abc@example.com"
/>

function TextField(props) {
  let { label } = props;
  let ref = React.useRef();
  let {
    labelProps,
    inputProps,
    descriptionProps,
    errorMessageProps
  } = useTextField(props, ref);

  return (
    <div
      style={{
        display: 'flex',
        flexDirection: 'column',
        width: 200
      }}
    >
      <label {...labelProps}>{label}</label>
      <input {...inputProps} ref={ref} />
      {props.description &&
        (
          <div
            {...descriptionProps}
            style={{ fontSize: 12 }}
          >
            {props.description}
          </div>
        )}
      {props.errorMessage &&
        (
          <div
            {...errorMessageProps}
            style={{ color: 'red', fontSize: 12 }}
          >
            {props.errorMessage}
          </div>
        )}
    </div>
  );
}

<TextField
  label="Email"
  placeholder="abc@example.com"
/>

function TextField(
  props
) {
  let { label } = props;
  let ref = React
    .useRef();
  let {
    labelProps,
    inputProps,
    descriptionProps,
    errorMessageProps
  } = useTextField(
    props,
    ref
  );

  return (
    <div
      style={{
        display: 'flex',
        flexDirection:
          'column',
        width: 200
      }}
    >
      <label
        {...labelProps}
      >
        {label}
      </label>
      <input
        {...inputProps}
        ref={ref}
      />
      {props
        .description &&
        (
          <div
            {...descriptionProps}
            style={{
              fontSize:
                12
            }}
          >
            {props
              .description}
          </div>
        )}
      {props
        .errorMessage &&
        (
          <div
            {...errorMessageProps}
            style={{
              color:
                'red',
              fontSize:
                12
            }}
          >
            {props
              .errorMessage}
          </div>
        )}
    </div>
  );
}

<TextField
  label="Email"
  placeholder="abc@example.com"
/>

Description#

<TextField
  label="Email"
  placeholder="abc@example.com"
  description="Enter an email for us to contact you about your order."
/>

<TextField
  label="Email"
  placeholder="abc@example.com"
  description="Enter an email for us to contact you about your order."
/>

<TextField
  label="Email"
  placeholder="abc@example.com"
  description="Enter an email for us to contact you about your order."
/>

Error message#

<TextField
  label="Email"
  placeholder="abc@example.com"
  errorMessage="Please enter a valid email address." />

<TextField
  label="Email"
  placeholder="abc@example.com"
  errorMessage="Please enter a valid email address." />

<TextField
  label="Email"
  placeholder="abc@example.com"
  errorMessage="Please enter a valid email address."
/>

Internationalization#

RTL#

In right-to-left languages, text fields should be mirrored. The label should be right aligned, along with the text in the text field. Ensure that your CSS accounts for this.

'input'

Name	Type	Default	Description
`inputElementType`	`T`	`'input'`	The HTML element used to render the input, e.g. 'input', or 'textarea'. It determines whether certain HTML attributes will be included in `inputProps`. For example, `type`.
`aria-activedescendant`	`string`	—	Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
`aria-autocomplete`	`'none' \| 'inline' \| 'list' \| 'both'`	—	Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
`aria-haspopup`	`boolean \| 'false' \| 'true' \| 'menu' \| 'listbox' \| 'tree' \| 'grid' \| 'dialog'`	—	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`validationState`	`ValidationState`	—	Whether the input should display its "valid" or "invalid" visual styling.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission. Often paired with the `necessityIndicator` prop to add a visual indicator to the input.
`description`	`ReactNode`	—	A description for the field. Provides a hint such as specific requirements for what to choose.
`errorMessage`	`ReactNode`	—	An error message for the field.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`onFocus`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	—	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is released.
`placeholder`	`string`	—	Temporary text that occupies the text input when it is empty.
`value`	`string`	—	The current value (controlled).
`defaultValue`	`string`	—	The default value (uncontrolled).
`onChange`	`( (value: T )) => void`	—	Handler that is called when the value changes.
`label`	`ReactNode`	—	The content to display as the label.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`excludeFromTabOrder`	`boolean`	—	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`id`	`string`	—	The element's unique identifier. See MDN.
`autoComplete`	`string`	—	Describes the type of autocomplete functionality the input should provide if any. See MDN.
`maxLength`	`number`	—	The maximum number of characters supported by the input. See MDN.
`minLength`	`number`	—	The minimum number of characters required by the input. See MDN.
`name`	`string`	—	The name of the input element, used when submitting an HTML form. See MDN.
`pattern`	`string`	—	Regex pattern that the value of the input must match to be valid. See MDN.
`type`	`'text' \| 'search' \| 'url' \| 'tel' \| 'email' \| 'password' \| string`	—	The type of input to render. See MDN.
`inputMode`	`'none' \| 'text' \| 'tel' \| 'url' \| 'email' \| 'numeric' \| 'decimal' \| 'search'`	—	Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN.
`onCopy`	`ClipboardEventHandler<HTMLInputElement>`	—	Handler that is called when the user copies text. See MDN.
`onCut`	`ClipboardEventHandler<HTMLInputElement>`	—	Handler that is called when the user cuts text. See MDN.
`onPaste`	`ClipboardEventHandler<HTMLInputElement>`	—	Handler that is called when the user pastes text. See MDN.
`onCompositionStart`	`CompositionEventHandler<HTMLInputElement>`	—	Handler that is called when a text composition system starts a new text composition session. See MDN.
`onCompositionEnd`	`CompositionEventHandler<HTMLInputElement>`	—	Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
`onCompositionUpdate`	`CompositionEventHandler<HTMLInputElement>`	—	Handler that is called when a new character is received in the current text composition session. See MDN.
`onSelect`	`ReactEventHandler<HTMLInputElement>`	—	Handler that is called when text in the input is selected. See MDN.
`onBeforeInput`	`FormEventHandler<HTMLInputElement>`	—	Handler that is called when the input value is about to be modified. See MDN.
`onInput`	`FormEventHandler<HTMLInputElement>`	—	Handler that is called when the input value is modified. See MDN.
`aria-errormessage`	`string`	—	Identifies the element that provides an error message for the object.

'valid' | 'invalid'

BaseEvent<ReactKeyboardEvent<any>>

T & {stopPropagation: () => void,
continuePropagation: () => void
}

The type of ref object that can be passed to useTextField based on the given intrinsic HTML element name; e.g.RefObject<HTMLInputElement>, RefObject<HTMLTextAreaElement>.

RefObject<>

Name	Type	Description
`inputProps`	`TextFieldInputProps<T>`	Props for the input element.
`labelProps`	`LabelHTMLAttributes<HTMLLabelElement>`	Props for the text field's visible label element, if any.
`descriptionProps`	`HTMLAttributes<HTMLElement>`	Props for the text field's description element, if any.
`errorMessageProps`	`HTMLAttributes<HTMLElement>`	Props for the text field's error message element, if any.

The type of inputProps returned by useTextField; e.g. InputHTMLAttributes, TextareaHTMLAttributes.