---
title: TextField
description: TextField allows a user to enter a plain text value with a keyboard.
thumbnail:
  image: /previews/components/core/text-field.jpeg
  video: /previews/components/core/text-field.mp4
links:
  - label: Aria docs
    href: https://react-spectrum.adobe.com/react-aria/TextField.html
  - label: Aria API Reference
    href: https://react-spectrum.adobe.com/react-aria/TextField.html#props
  - label: Report an issue
    href: https://github.com/mehdibha/dotUI/issues/new/choose
  - label: Edit this page
    href: https://github.com/mehdibha/dotUI/tree/main/content/components/inputs/text-field.mdx?plain=1
---

<ComponentPreview
  name="core/text-field-default"
  preview={`<TextField label="Email" placeholder="hello@mehdibha.com" />`}
/>

## Installation

<Tabs items={["CLI", "Manual"]}>
  <Tab value="CLI">
  
  ```package-install
npx dotui-cli@latest add text-field
```

  </Tab>
  <Tab value="manual">
  
    <Steps>
      <Step>Install the following dependencies:</Step>

    ```package-install
    react-aria-components
    ```

      <Step>Copy and paste the following code into your project.</Step>
      <ComponentSource name="core/text-field" />
      <Step>Update the import paths to match your project setup.</Step>
    </Steps>

  </Tab>
</Tabs>

## Usage

Use a `TextField` to allow users to input custom text entries with a keyboard.

## Options

### Size

Use the `size` prop to control the size of the `TextField`. The default size is `"md"`.

<ComponentPreview
  name="core/text-field-sizes"
  preview={`<TextField size="sm" />
<TextField size="md" />
<TextField size="lg" />`}
/>

### Prefix and suffix

To add additional context for the `TextField`, use the `prefix` and `suffix` props.

<ComponentPreview
  name="core/text-field-prefix-and-suffix"
  preview={`<TextField prefix={<span>https://</span>} />
<TextField suffix={<span>@dotui.org</span>} />
<TextField suffix={<ClearButton />} />`}
/>

### Label

A visual label can be provided for the `TextField` using the label prop, or a hidden label using `aria-label` prop.

<ComponentPreview
  name="core/text-field-label"
  preview={`<TextField label="Email" />
<TextField aria-label="Email" />`}
/>

### Description

A description can be supplied to `TextField` via the `description` prop. The description is always visible unless the `isInvalid` prop is `true` and an error message is provided.

<ComponentPreview
  name="core/text-field-description"
  preview={`<TextField label="Email" description="Enter your email." />`}
/>

### Contextual help

A `ContextualHelp` element may be placed next to the label to provide additional information or help about a TextField.

<ComponentPreview
  name="core/text-field-contextual-help"
  preview={`<TextField label="Password" contextualHelp={<ContextualHelp />} />`}
/>

### Error message

An `errorMessage` can be supplied to `TextField`, which will be displayed when the `isInvalid` prop is set to `true`.

<ComponentPreview
  name="core/text-field-error-message"
  preview={`<TextField
    label="Email"
    isInvalid
    errorMessage="This email is already taken."
  />`}
/>

### Loading

Use the `isLoading` prop to control the loading state of the TextField.
Use the `loaderPosition` prop to control the position of the loader.

<ComponentPreview
  name="core/text-field-loading"
  preview={`<TextField isLoading loaderPosition="prefix" />
<TextField isLoading loaderPosition="suffix" />`}
/>

### Disabled

Use the `isDisabled` prop to disable the TextField.

<ComponentPreview
  name="core/text-field-disabled"
  preview={`<TextField isDisabled />`}
/>

### ReadOnly

The `isReadOnly` boolean prop makes the TextField's text content immutable. Unlike `isDisabled`, the TextField remains focusable and the contents can still be copied.

<ComponentPreview
  name="core/text-field-read-only"
  preview={`<TextField isReadOnly />`}
/>

### Required

Use the `isRequired` prop to mark the TextField as required.
Use the `necessityIndicator` prop to control the visual style of the required state.

<ComponentPreview
  name="core/text-field-required"
  preview={`<TextField label="Email" isRequired />
<TextField label="Email" isRequired necessityIndicator="icon" />
<TextField label="Email" isRequired necessityIndicator="label" />
<TextField label="Email" necessityIndicator="label" />`}
/>

## Uncontrolled

Use the `defaultValue` prop to set the default input value.

<ComponentPreview
  name="core/text-field-uncontrolled"
  preview={`<TextField label="Name" defaultValue="Mehdi" />`}
/>

## Controlled

Use the `value` and `onChange` props to control the value of the input.

<ComponentPreview
  name="core/text-field-controlled"
  preview={`const [inputValue, setInputValue] = React.useState("Hello world!");
  return (
    <TextField
      value={inputValue}
      onChange={(text) => {
        setInputValue(text);
      }}
    />
  );`}
/>

## Composition

If you need to customize things further, you can drop down to the composition level.

<ComponentPreview
  name="core/text-field-composition"
  preview={`<TextFieldRoot>
    <Label>Email</Label>
    <InputRoot>
      <Input />
    </InputRoot>
    <Description>Enter your email.</Description>
  </TextFieldRoot>`}
/>

## API Reference

| Prop                 | Type                                                                                                   | Default    | Description                                                                                                                                                                                                                           |
| -------------------- | ------------------------------------------------------------------------------------------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `size`               | `"sm" \| "md" \| "lg"`                                                                                 | `"md"`     | The size of the input.                                                                                                                                                                                                                |
| `prefix`             | `ReactNode`                                                                                            | -          | A visual to display before the input.                                                                                                                                                                                                 |
| `suffix`             | `ReactNode`                                                                                            | -          | A visual to display after the input.                                                                                                                                                                                                  |
| `label`              | `ReactNode`                                                                                            |            | The content to display as the label.                                                                                                                                                                                                  |
| `description`        | `ReactNode`                                                                                            |            | A description for the field. Provides a hint such as specific requirements for what to choose.                                                                                                                                        |
| `errorMessage`       | `ReactNode \| (v: ValidationResult) => ReactNode`                                                      |            | An error message for the field.                                                                                                                                                                                                       |
| `loaderPosition`     | `"prefix" \| "suffix"`                                                                                 | `"suffix"` | The loader position                                                                                                                                                                                                                   |
| `isLoading`          | `boolean`                                                                                              | -          | Whether the TextField is in a pending state.                                                                                                                                                                                          |
| `isInvalid`          | `boolean`                                                                                              | -          | Whether the value is invalid.                                                                                                                                                                                                         |
| `isDisabled`         | `boolean`                                                                                              | -          | Whether the input is disabled.                                                                                                                                                                                                        |
| `isReadOnly`         | `boolean`                                                                                              | -          | Whether the input can be selected but not changed by the user.                                                                                                                                                                        |
| `isRequired`         | `boolean`                                                                                              | -          | Whether user input is required on the input before form submission.                                                                                                                                                                   |
| `validate`           | `(value: string) => ValidationError \| true \| null \| undefined`                                      | -          | A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead. |
| `autoFocus`          | `boolean`                                                                                              | -          | Whether the element should receive focus on render.                                                                                                                                                                                   |
| `value`              | `string`                                                                                               | -          | The current value (controlled).                                                                                                                                                                                                       |
| `defaultValue`       | `string`                                                                                               | -          | The default value (uncontrolled).                                                                                                                                                                                                     |
| `autoComplete`       | `string`                                                                                               | -          | Describes the type of autocomplete functionality the input should provide if any.                                                                                                                                                     |
| `maxLength`          | `number`                                                                                               | -          | The maximum number of characters supported by the input.                                                                                                                                                                              |
| `minLength`          | `number`                                                                                               | -          | The minimum number of characters required by the input.                                                                                                                                                                               |
| `pattern`            | `string`                                                                                               | -          | Regex pattern that the value of the input must match to be valid.                                                                                                                                                                     |
| `type`               | `'text' \| 'search' \| 'url' \| 'tel' \| 'email' \| 'password' \| string & {}`                         | -          | The type of input to render.                                                                                                                                                                                                          |
| `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.                                                                                                                                |
| `name`               | `string`                                                                                               | -          | The name of the input element, used when submitting an HTML form.                                                                                                                                                                     |
| `validationBehavior` | `'native' \| 'aria'`                                                                                   | 'native'   | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.                                                                        |
| `children`           | `ReactNode \| (values: TextFieldRenderProps & {defaultChildren: ReactNode \| undefined}) => ReactNode` | -          | The children of the component. A function may be provided to alter the children based on component state.                                                                                                                             |
| `className`          | `string`                                                                                               | -          | The CSS className for the element.                                                                                                                                                                                                    |
| `style`              | `CSSProperties \| (values: TextFieldRenderProps & {defaultStyle: CSSProperties}) => CSSProperties`     | -          | The inline style for the element. A function may be provided to compute the style based on component state.                                                                                                                           |

| Event                 | Type                                        | Description                                                                                                      |
| --------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `onFocus`             | `(e: FocusEvent<Target>) => void`           | Handler that is called when the element receives focus.                                                          |
| `onBlur`              | `(e: FocusEvent<Target>) => 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.                                                                   |
| `onChange`            | `(value: T) => void`                        | Handler that is called when the value changes.                                                                   |
| `onCopy`              | `ClipboardEventHandler<HTMLInputElement>`   | Handler that is called when the user copies text.                                                                |
| `onCut`               | `ClipboardEventHandler<HTMLInputElement>`   | Handler that is called when the user cuts text.                                                                  |
| `onPaste`             | `ClipboardEventHandler<HTMLInputElement>`   | Handler that is called when the user pastes text.                                                                |
| `onCompositionStart`  | `CompositionEventHandler<HTMLInputElement>` | Handler that is called when a text composition system starts a new text composition session.                     |
| `onCompositionEnd`    | `CompositionEventHandler<HTMLInputElement>` | Handler that is called when a text composition system completes or cancels the current text composition session. |
| `onCompositionUpdate` | `CompositionEventHandler<HTMLInputElement>` | Handler that is called when a new character is received in the current text composition session.                 |
| `onSelect`            | `ReactEventHandler<HTMLInputElement>`       | Handler that is called when text in the input is selected.                                                       |
| `onBeforeInput`       | `FormEventHandler<HTMLInputElement>`        | Handler that is called when the input value is about to be modified.                                             |
| `onInput`             | `FormEventHandler<HTMLInputElement>`        | Handler that is called when the input value is modified.                                                         |

| Data attribute    | Description                          |
| ----------------- | ------------------------------------ |
| `[data-disabled]` | Whether the text field is disabled.  |
| `[data-invalid]`  | Whether the text field is invalid.   |
| `[data-readonly]` | Whether the text field is read only. |
| `[data-required]` | Whether the text field is required.  |
