TextField

The text displayed as the field label, which identifies the purpose of the field to users. This value is also used as the placeholder when the field is empty.

A detailed description for screen readers.

Any content to render at the end of the text field. Commonly used to display an icon that opens a tooltip providing more information about the field.

A hint as to the intended content of the field.

When set to true, 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 false, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

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

In rare cases, like the PhoneField component, we completely control state. In those cases, there is never a difference between the value prop of the field and the current value in the field, and so this component never considers the field to have changed. Use the controlledValue prop to provide the value that should be shown to the buyer in those circumstances, but where the value prop will continue to be used as the comparison value to determine whether the field has changed. This value will usually be set to the last committed, unformatted value for the controlled input.

Whether the field is disabled, preventing any user interaction.

An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators.

An icon to render at the start or end of the field. It will render at the start by default.

A unique identifier for the field. When no id is set, a globally unique value will be used instead.

Specifies the maximum number of characters allowed.

Whether the field supports multiple lines of input. Set a number to define the default lines of the input.

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

A callback fired when the text field loses focus.

A callback fired when the user has finished editing the field, such as when they blur the field. Unlike onChange callbacks you may be familiar with from Polaris or other React component libraries, this callback is not run on every change to the input. Text fields are “partially controlled” components, which means that while the user edits the field, its state is controlled by the component. Once the user has signalled that they have finished editing the field (typically, by blurring the field), onChange is called if the input actually changed from the most recent value property. At that point, you are expected to store this “committed value” in state, and reflect it in the text field’s value property.

This state management model is important given how UI Extensions are rendered. UI Extension components run on a separate thread from the UI, so they can’t respond to input synchronously. A pattern popularized by controlled React components is to have the component be the source of truth for the input value, and update the value on every user input. The delay in responding to events from a UI extension is only a few milliseconds, but attempting to strictly store state with this delay can cause issues if a user types quickly, or if the user is using a lower-powered device. Having the UI thread take ownership for “in progress” input, and only synchronizing when the user is finished with a field, avoids this risk.

It can still sometimes be useful to be notified when the user makes any input in the field. If you need this capability, you can use the onInput prop. However, never use that property to create tightly controlled state for the value.

This callback is called with the current value of the field. If the value of a field is the same as the current value prop provided to the field, the onChange callback will not be run.

A callback fired when the text field receives focus.

A callback fired when the user makes any changes in the field, such as typing a character. As noted in the documentation for onChange, you must not use this to update state — use the onChange callback for that purpose. Use the onInput prop when you need to do something as soon as the user makes a change, like clearing validation errors that apply to the field as soon as the user begins making the necessary adjustments.

This callback is called with the current value of the field.

Text content to render before the value.

Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.

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 prop.

Text content to render at the end of the text field.

The content type a buyer will enter into the field. This type is used to provide semantic value to the field and, where possible, will provide the buyer with a better editing experience for the content type.

Note that the type property does not change the way the text field’s value will be provided in onChange or onInput; a text field with a type of 'number' will still provide the exact user entry, as a string, to those callbacks. The type also does not perform any form of automatic validation. If you want to perform validation, use the error property.

The current value for the field. If omitted, the field will be empty. You should update this value in response to the onChange callback.