---
title: TextField
description: Lets users enter or edit text within a single-line input. Use to collect short, free-form information from users.
api_version: 2025-10
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/forms/textfield
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/forms/textfield.md
---

# Text​Field

Lets users enter or edit text within a single-line input. Use to collect short, free-form information from users.

## Properties

* autocomplete

  AutocompleteField | \`${AutocompleteSection} ${AutocompleteField}\` | \`${AutocompleteGroup} ${AutocompleteField}\` | \`${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}\` | "on" | "off"

  Default: 'on' for everything else

  A hint as to the intended content of the field.

  When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.

  When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

  Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.

* defaultValue

  string

  The default value for the field.

* disabled

  boolean

  Default: false

  Disables the field, disallowing any interaction.

* error

  string

  Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

* icon

  '' | 'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar'

  Default: ''

  The type of icon to be displayed in the field.

* id

  string

  A unique identifier for the element.

* label

  string

  Content to use as the field label.

* labelAccessibilityVisibility

  'visible' | 'exclusive'

  Default: 'visible'

  Changes the visibility of the component's label.

  * `visible`: the label is visible to all users.
  * `exclusive`: the label is visually hidden but remains in the accessibility tree.

* maxLength

  number

  Default: Infinity

  Specifies the maximum number of characters allowed.

* minLength

  number

  Default: 0

  Specifies the min number of characters allowed.

* name

  string

  An identifier for the field that is unique within the nearest containing form.

* prefix

  string

  Default: ''

  A value to be displayed immediately before the editable portion of the field.

  This is useful for displaying an implied part of the value, such as "https\://" or "+353".

  This cannot be edited by the user, and it isn't included in the value of the field.

  It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.

* readOnly

  boolean

  Default: false

  The field cannot be edited by the user. It is focusable will be announced by screen readers.

* required

  boolean

  Default: false

  Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property.

* suffix

  string

  Default: ''

  A value to be displayed immediately after the editable portion of the field.

  This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".

  This cannot be edited by the user, and it isn't included in the value of the field.

  It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.

* value

  string

  The current value for the field. If omitted, the field will be empty.

### AutocompleteSection

The “section” scopes the autocomplete data that should be inserted to a specific area of the page. Commonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.

```ts
`section-${string}`
```

### AutocompleteGroup

The contact information group the autocomplete data should be sourced from.

```ts
"shipping" | "billing"
```

## Events

* blur

  ((event: CallbackEventListener\<typeof tagName>) => void) | null

  Callback when the element loses focus.

* change

  ((event: CallbackEventListener\<typeof tagName>) => void) | null

  Callback when the user has **finished editing** a field, e.g. once they have blurred the field.

* focus

  ((event: CallbackEventListener\<typeof tagName>) => void) | null

  Callback when the element receives focus.

* input

  ((event: CallbackEventListener\<typeof tagName>) => void) | null

  Callback when the user makes any changes in the field.

### CallbackEventListener

```ts
(EventListener & {
    (event: CallbackEvent<TTagName, TEvent>): void;
}) | null
```

### CallbackEvent

```ts
TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}
```

## Slots

* accessory

  HTMLElement

  Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.

### Examples

* #### Code

  ##### Default

  ```html
  <s-text-field
    label="First name (optional)"
    defaultValue="Taylor"
  ></s-text-field>
  ```

## Preview

![](https://shopify.dev/images/templated-apis-screenshots/checkout-ui-extensions/2025-10/text-field-default.png)

## Best Practices

* Clearly label text fields so that it’s obvious what customers should enter.
* Label text fields as optional when input isn’t required. For example, use the label **First name (optional)**.
* Don’t have optional fields pass true to the required property.