Choose a version:

TextArea

This component is perfect when you need to allow users to input larger amounts of text, such as for comments, feedback, or any other multi-line input.

Anchor to textareapropsTextAreaProps

Anchor to label label string required: Content to use as the field label.
Anchor to rows rows number Default: 2: A number of visible text lines.
Anchor to disabled disabled boolean: Whether the field can be modified.
Anchor to error 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.
Anchor to id id string: A unique identifier for the field.
Anchor to name name string: An identifier for the field that is unique within the nearest containing Form component.
Anchor to onBlur onBlur () => void: Callback when focus is removed.
Anchor to onChange onChange (value: string) => void: Callback when the user has finished editing a field. Unlike onChange callbacks you may be familiar with from 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.
Anchor to onFocus onFocus () => void: Callback when input is focused.
Anchor to onInput onInput (value: string) => void: Callback when the user makes any changes in the field. As noted in the documentation for onChange, you must not use this to update value — 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.
Anchor to placeholder placeholder string: A short hint that describes the expected value of the field.
Anchor to readOnly readOnly boolean: Whether the field is read-only.
Anchor to defaultValue defaultValue string | string[]: A default value to populate for uncontrolled components.
Anchor to required required boolean: 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.
Anchor to value value T: The current value for the field. If omitted, the field will be empty. You should update this value in response to the onChange callback.
Anchor to maxLength maxLength number: Specifies the maximum number of characters allowed.
Anchor to minLength minLength number: Specifies the min number of characters allowed.
Anchor to autocomplete autocomplete boolean | | `section-${string} additional-name` | `section-${string} address-level1` | `section-${string} address-level2` | `section-${string} address-level3` | `section-${string} address-level4` | `section-${string} address-line1` | `section-${string} address-line2` | `section-${string} address-line3` | `section-${string} country-name` | `section-${string} country` | `section-${string} family-name` | `section-${string} given-name` | `section-${string} honorific-prefix` | `section-${string} honorific-suffix` | `section-${string} language` | `section-${string} name` | `section-${string} nickname` | `section-${string} one-time-code` | `section-${string} organization-title` | `section-${string} organization` | `section-${string} postal-code` | `section-${string} sex` | `section-${string} street-address` | `section-${string} transaction-currency` | `section-${string} username` | `section-${string} cc-additional-name` | `section-${string} credit-card-additional-name` | `section-${string} cc-family-name` | `section-${string} credit-card-family-name` | `section-${string} cc-given-name` | `section-${string} credit-card-given-name` | `section-${string} cc-name` | `section-${string} credit-card-name` | `section-${string} cc-type` | `section-${string} credit-card-type` | "shipping additional-name" | "shipping address-level1" | "shipping address-level2" | "shipping address-level3" | "shipping address-level4" | "shipping address-line1" | "shipping address-line2" | "shipping address-line3" | "shipping country-name" | "shipping country" | "shipping family-name" | "shipping given-name" | "shipping honorific-prefix" | "shipping honorific-suffix" | "shipping language" | "shipping name" | "shipping nickname" | "shipping one-time-code" | "shipping organization-title" | "shipping organization" | "shipping postal-code" | "shipping sex" | "shipping street-address" | "shipping transaction-currency" | "shipping username" | "shipping cc-additional-name" | "shipping credit-card-additional-name" | "shipping cc-family-name" | "shipping credit-card-family-name" | "shipping cc-given-name" | "shipping credit-card-given-name" | "shipping cc-name" | "shipping credit-card-name" | "shipping cc-type" | "shipping credit-card-type" | "billing additional-name" | "billing address-level1" | "billing address-level2" | "billing address-level3" | "billing address-level4" | "billing address-line1" | "billing address-line2" | "billing address-line3" | "billing country-name" | "billing country" | "billing family-name" | "billing given-name" | "billing honorific-prefix" | "billing honorific-suffix" | "billing language" | "billing name" | "billing nickname" | "billing one-time-code" | "billing organization-title" | "billing organization" | "billing postal-code" | "billing sex" | "billing street-address" | "billing transaction-currency" | "billing username" | "billing cc-additional-name" | "billing credit-card-additional-name" | "billing cc-family-name" | "billing credit-card-family-name" | "billing cc-given-name" | "billing credit-card-given-name" | "billing cc-name" | "billing credit-card-name" | "billing cc-type" | "billing credit-card-type" | `section-${string} shipping additional-name` | `section-${string} shipping address-level1` | `section-${string} shipping address-level2` | `section-${string} shipping address-level3` | `section-${string} shipping address-level4` | `section-${string} shipping address-line1` | `section-${string} shipping address-line2` | `section-${string} shipping address-line3` | `section-${string} shipping country-name` | `section-${string} shipping country` | `section-${string} shipping family-name` | `section-${string} shipping given-name` | `section-${string} shipping honorific-prefix` | `section-${string} shipping honorific-suffix` | `section-${string} shipping language` | `section-${string} shipping name` | `section-${string} shipping nickname` | `section-${string} shipping one-time-code` | `section-${string} shipping organization-title` | `section-${string} shipping organization` | `section-${string} shipping postal-code` | `section-${string} shipping sex` | `section-${string} shipping street-address` | `section-${string} shipping transaction-currency` | `section-${string} shipping username` | `section-${string} shipping cc-additional-name` | `section-${string} shipping credit-card-additional-name` | `section-${string} shipping cc-family-name` | `section-${string} shipping credit-card-family-name` | `section-${string} shipping cc-given-name` | `section-${string} shipping credit-card-given-name` | `section-${string} shipping cc-name` | `section-${string} shipping credit-card-name` | `section-${string} shipping cc-type` | `section-${string} shipping credit-card-type` | `section-${string} billing additional-name` | `section-${string} billing address-level1` | `section-${string} billing address-level2` | `section-${string} billing address-level3` | `section-${string} billing address-level4` | `section-${string} billing address-line1` | `section-${string} billing address-line2` | `section-${string} billing address-line3` | `section-${string} billing country-name` | `section-${string} billing country` | `section-${string} billing family-name` | `section-${string} billing given-name` | `section-${string} billing honorific-prefix` | `section-${string} billing honorific-suffix` | `section-${string} billing language` | `section-${string} billing name` | `section-${string} billing nickname` | `section-${string} billing one-time-code` | `section-${string} billing organization-title` | `section-${string} billing organization` | `section-${string} billing postal-code` | `section-${string} billing sex` | `section-${string} billing street-address` | `section-${string} billing transaction-currency` | `section-${string} billing username` | `section-${string} billing cc-additional-name` | `section-${string} billing credit-card-additional-name` | `section-${string} billing cc-family-name` | `section-${string} billing credit-card-family-name` | `section-${string} billing cc-given-name` | `section-${string} billing credit-card-given-name` | `section-${string} billing cc-name` | `section-${string} billing credit-card-name` | `section-${string} billing cc-type` | `section-${string} billing credit-card-type`: 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 value which describes the specific data you would like to be entered into this field during autofill.

TextAreaProps

rows
A number of visible text lines.
```
number
```
disabled
Whether the field can be modified.
```
boolean
```
error
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
```
string
```
id
A unique identifier for the field.
```
string
```
label
Content to use as the field label.
```
string
```
name
An identifier for the field that is unique within the nearest containing `Form` component.
```
string
```
onBlur
Callback when focus is removed.
```
() => void
```
onChange
Callback when the user has **finished editing** a field. Unlike `onChange` callbacks you may be familiar with from 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](https://reactjs.org/docs/forms.html#controlled-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.
```
(value: string) => void
```
onFocus
Callback when input is focused.
```
() => void
```
onInput
Callback when the user makes any changes in the field. As noted in the documentation for `onChange`, you **must not** use this to update `value` — 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.
```
(value: string) => void
```
placeholder
A short hint that describes the expected value of the field.
```
string
```
readOnly
Whether the field is read-only.
```
boolean
```
defaultValue
A default value to populate for uncontrolled components.
```
string | string[]
```
required
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.
```
boolean
```
value
The current value for the field. If omitted, the field will be empty. You should update this value in response to the `onChange` callback.
```
T
```
maxLength
Specifies the maximum number of characters allowed.
```
number
```
minLength
Specifies the min number of characters allowed.
```
number
```

autocomplete

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 value which describes the specific data you would like to be entered into this field during autofill.

boolean | TextAutocompleteField | `section-${string} additional-name` | `section-${string} address-level1` | `section-${string} address-level2` | `section-${string} address-level3` | `section-${string} address-level4` | `section-${string} address-line1` | `section-${string} address-line2` | `section-${string} address-line3` | `section-${string} country-name` | `section-${string} country` | `section-${string} family-name` | `section-${string} given-name` | `section-${string} honorific-prefix` | `section-${string} honorific-suffix` | `section-${string} language` | `section-${string} name` | `section-${string} nickname` | `section-${string} one-time-code` | `section-${string} organization-title` | `section-${string} organization` | `section-${string} postal-code` | `section-${string} sex` | `section-${string} street-address` | `section-${string} transaction-currency` | `section-${string} username` | `section-${string} cc-additional-name` | `section-${string} credit-card-additional-name` | `section-${string} cc-family-name` | `section-${string} credit-card-family-name` | `section-${string} cc-given-name` | `section-${string} credit-card-given-name` | `section-${string} cc-name` | `section-${string} credit-card-name` | `section-${string} cc-type` | `section-${string} credit-card-type` | "shipping additional-name" | "shipping address-level1" | "shipping address-level2" | "shipping address-level3" | "shipping address-level4" | "shipping address-line1" | "shipping address-line2" | "shipping address-line3" | "shipping country-name" | "shipping country" | "shipping family-name" | "shipping given-name" | "shipping honorific-prefix" | "shipping honorific-suffix" | "shipping language" | "shipping name" | "shipping nickname" | "shipping one-time-code" | "shipping organization-title" | "shipping organization" | "shipping postal-code" | "shipping sex" | "shipping street-address" | "shipping transaction-currency" | "shipping username" | "shipping cc-additional-name" | "shipping credit-card-additional-name" | "shipping cc-family-name" | "shipping credit-card-family-name" | "shipping cc-given-name" | "shipping credit-card-given-name" | "shipping cc-name" | "shipping credit-card-name" | "shipping cc-type" | "shipping credit-card-type" | "billing additional-name" | "billing address-level1" | "billing address-level2" | "billing address-level3" | "billing address-level4" | "billing address-line1" | "billing address-line2" | "billing address-line3" | "billing country-name" | "billing country" | "billing family-name" | "billing given-name" | "billing honorific-prefix" | "billing honorific-suffix" | "billing language" | "billing name" | "billing nickname" | "billing one-time-code" | "billing organization-title" | "billing organization" | "billing postal-code" | "billing sex" | "billing street-address" | "billing transaction-currency" | "billing username" | "billing cc-additional-name" | "billing credit-card-additional-name" | "billing cc-family-name" | "billing credit-card-family-name" | "billing cc-given-name" | "billing credit-card-given-name" | "billing cc-name" | "billing credit-card-name" | "billing cc-type" | "billing credit-card-type" | `section-${string} shipping additional-name` | `section-${string} shipping address-level1` | `section-${string} shipping address-level2` | `section-${string} shipping address-level3` | `section-${string} shipping address-level4` | `section-${string} shipping address-line1` | `section-${string} shipping address-line2` | `section-${string} shipping address-line3` | `section-${string} shipping country-name` | `section-${string} shipping country` | `section-${string} shipping family-name` | `section-${string} shipping given-name` | `section-${string} shipping honorific-prefix` | `section-${string} shipping honorific-suffix` | `section-${string} shipping language` | `section-${string} shipping name` | `section-${string} shipping nickname` | `section-${string} shipping one-time-code` | `section-${string} shipping organization-title` | `section-${string} shipping organization` | `section-${string} shipping postal-code` | `section-${string} shipping sex` | `section-${string} shipping street-address` | `section-${string} shipping transaction-currency` | `section-${string} shipping username` | `section-${string} shipping cc-additional-name` | `section-${string} shipping credit-card-additional-name` | `section-${string} shipping cc-family-name` | `section-${string} shipping credit-card-family-name` | `section-${string} shipping cc-given-name` | `section-${string} shipping credit-card-given-name` | `section-${string} shipping cc-name` | `section-${string} shipping credit-card-name` | `section-${string} shipping cc-type` | `section-${string} shipping credit-card-type` | `section-${string} billing additional-name` | `section-${string} billing address-level1` | `section-${string} billing address-level2` | `section-${string} billing address-level3` | `section-${string} billing address-level4` | `section-${string} billing address-line1` | `section-${string} billing address-line2` | `section-${string} billing address-line3` | `section-${string} billing country-name` | `section-${string} billing country` | `section-${string} billing family-name` | `section-${string} billing given-name` | `section-${string} billing honorific-prefix` | `section-${string} billing honorific-suffix` | `section-${string} billing language` | `section-${string} billing name` | `section-${string} billing nickname` | `section-${string} billing one-time-code` | `section-${string} billing organization-title` | `section-${string} billing organization` | `section-${string} billing postal-code` | `section-${string} billing sex` | `section-${string} billing street-address` | `section-${string} billing transaction-currency` | `section-${string} billing username` | `section-${string} billing cc-additional-name` | `section-${string} billing credit-card-additional-name` | `section-${string} billing cc-family-name` | `section-${string} billing credit-card-family-name` | `section-${string} billing cc-given-name` | `section-${string} billing credit-card-given-name` | `section-${string} billing cc-name` | `section-${string} billing credit-card-name` | `section-${string} billing cc-type` | `section-${string} billing credit-card-type`

export interface TextAreaProps
  extends InputProps<string>,
    MinMaxLengthProps,
    AutocompleteProps<TextAutocompleteField> {
  /**
   * A number of visible text lines.
   *
   * @defaultValue 2
   */
  rows?: number;
}

TextAutocompleteField

TextAutocompleteField

Was this section helpful?

Simple TextArea example

import {render, TextArea} from '@shopify/ui-extensions-react/admin';

render('Playground', () => <App />);

function App() {

return <TextArea label="Enter a scheduled social media posting" rows={4} />;

}

examples

Simple TextArea example

React

import {render, TextArea} from '@shopify/ui-extensions-react/admin';

render('Playground', () => <App />);

function App() {
  return <TextArea label="Enter a scheduled social media posting" rows={4} />;
}

JS

import {extend, TextArea} from '@shopify/ui-extensions/admin';

extend('Playground', (root) => {
  const textArea = root.createComponent(TextArea, {
    label: 'Enter a scheduled social media posting',
    rows: 5,
  });

  root.appendChild(textArea);
});

Preview

Anchor to relatedRelated

TextField