Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

Choose a version:

PhoneField

The phone field component collects phone numbers with country code formatting. The country code is required for the initial render, but customers can change it by selecting a country from the dropdown or editing the code directly in the text field.

Support

Targets (25)

Supported targets

Anchor to PropertiesProperties

Configure the following properties on the PhoneField component.

Anchor to label label string required: 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.
Anchor to accessibilityDescription accessibilityDescription string: A detailed description for screen readers.
Anchor to accessory accessory string | RemoteFragment: 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.
Anchor to autocomplete autocomplete | boolean: 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.
Anchor to disabled disabled boolean: Whether the phone field is disabled, preventing any user interaction.
Anchor to error error string: An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators.
Anchor to icon icon | {source: ; position?: 'start' | 'end'}: An icon to render at the start or end of the field. It will render at the start by default.
Anchor to id id string: A unique identifier for the field. When no id is set, a globally unique value will be used instead.
Anchor to maxLength maxLength number: Specifies the maximum number of characters allowed.
Anchor to name name string: An identifier for the field that is unique within the nearest containing Form component.
Anchor to onBlur onBlur () => void: A callback fired when the phone field loses focus.
Anchor to onChange onChange (value: string) => void: A callback fired when the user has finished editing the field, such as when they blur the field, or after using the country dropdown. 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. Phone 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 phone 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 formatted 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: A callback fired when the phone field receives focus.
Anchor to onInput onInput (value: string) => void: A callback fired when the user makes any changes in the field, such as typing a character or selecting a country in the dropdown. 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 formatted value.
Anchor to readonly readonly boolean: Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.
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 string: The current value for the field. If omitted, the field will be empty. You should update this value in response to the onChange callback.

Autocomplete

A descriptor for selecting the data a field would like to receive during autocomplete. This attribute is modeled off of a limited set of the autocomplete values supported in browsers. Learn more about [autofill detail tokens](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens).

field
The type of data that should be inserted into a field supporting autocomplete.
```
AutocompleteField
```
group
The contact information “group” the autocomplete data should be sourced from.
```
AutocompleteGroup
```

AutocompleteField

'name' | 'honorific-prefix' | 'given-name' | 'additional-name' | 'family-name' | 'honorific-suffix' | 'nickname' | 'username' | 'new-password' | 'current-password' | 'one-time-code' | 'organization-title' | 'organization' | 'street-address' | 'address-line1' | 'address-line2' | 'address-line3' | 'address-level4' | 'address-level3' | 'address-level2' | 'address-level1' | 'country' | 'country-name' | 'postal-code' | 'credit-card-name' | 'credit-card-given-name' | 'credit-card-additional-name' | 'credit-card-family-name' | 'credit-card-number' | 'credit-card-expiry' | 'credit-card-expiry-month' | 'credit-card-expiry-year' | 'credit-card-security-code' | 'credit-card-type' | 'transaction-currency' | 'transaction-amount' | 'language' | 'birthday' | 'birthday-day' | 'birthday-month' | 'birthday-year' | 'sex' | 'url' | 'photo' | 'telephone' | 'telephone-country-code' | 'telephone-national' | 'telephone-area-code' | 'telephone-local' | 'telephone-local-prefix' | 'telephone-local-suffix' | 'telephone-extension' | 'email' | 'instant-message' | 'home telephone' | 'home telephone-country-code' | 'home telephone-national' | 'home telephone-area-code' | 'home telephone-local' | 'home telephone-local-prefix' | 'home telephone-local-suffix' | 'home telephone-extension' | 'home email' | 'home instant-message' | 'work telephone' | 'work telephone-country-code' | 'work telephone-national' | 'work telephone-area-code' | 'work telephone-local' | 'work telephone-local-prefix' | 'work telephone-local-suffix' | 'work telephone-extension' | 'work email' | 'work instant-message' | 'mobile telephone' | 'mobile telephone-country-code' | 'mobile telephone-national' | 'mobile telephone-area-code' | 'mobile telephone-local' | 'mobile telephone-local-prefix' | 'mobile telephone-local-suffix' | 'mobile telephone-extension' | 'mobile email' | 'mobile instant-message' | 'fax telephone' | 'fax telephone-country-code' | 'fax telephone-national' | 'fax telephone-area-code' | 'fax telephone-local' | 'fax telephone-local-prefix' | 'fax telephone-local-suffix' | 'fax telephone-extension' | 'fax email' | 'fax instant-message' | 'pager telephone' | 'pager telephone-country-code' | 'pager telephone-national' | 'pager telephone-area-code' | 'pager telephone-local' | 'pager telephone-local-prefix' | 'pager telephone-local-suffix' | 'pager telephone-extension' | 'pager email' | 'pager instant-message'

AutocompleteGroup

'shipping' | 'billing'

IconSource

The name of the icon to display. Each value maps to a specific pictogram from the icon set.

'arrowLeft' | 'arrowRight' | 'arrowUp' | 'arrowUpRight' | 'arrowDown' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caretDown' | 'cart' | 'cashDollar' | 'categories' | 'checkmark' | 'chevronLeft' | 'chevronRight' | 'chevronUp' | 'chevronDown' | 'clipboard' | 'clock' | 'close' | 'creditCard' | 'critical' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'email' | 'error' | 'errorFill' | 'external' | 'filter' | 'geolocation' | 'gift' | 'giftFill' | 'grid' | 'hamburger' | 'hollowCircle' | 'horizontalDots' | 'image' | 'info' | 'infoFill' | 'list' | 'lock' | 'magnify' | 'map' | 'marker' | 'minus' | 'mobile' | 'note' | 'orderBox' | 'pen' | 'plus' | 'profile' | 'question' | 'questionFill' | 'reorder' | 'reset' | 'return' | 'savings' | 'settings' | 'star' | 'starFill' | 'starHalf' | 'store' | 'success' | 'truck' | 'upload' | 'verticalDots' | 'warning' | 'warningFill'

Anchor to ExamplesExamples

Anchor to Collect a phone numberCollect a phone number

Use phone field to collect a phone number with automatic country code formatting. This example shows a basic phone input with a country code dropdown.

Collect a phone number

A phone field with a country code dropdown and number input

Collect a phone number

import {

reactExtension,

PhoneField,

} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(

'customer-account.page.render',

() => <Extension />,

);

function Extension() {

return (

<PhoneField

label="Phone"

value="1 (555) 555-5555"

);

}

import {extension, PhoneField} from '@shopify/ui-extensions/customer-account';

export default extension('customer-account.page.render', (root) => {

const phoneField = root.createComponent(PhoneField, {

label: 'Phone',

value: '1 (555) 555-5555',

});

root.appendChild(phoneField);

});

React

import {
  reactExtension,
  PhoneField,
} from '@shopify/ui-extensions-react/customer-account';

export default reactExtension(
  'customer-account.page.render',
  () => <Extension />,
);

function Extension() {
  return (
    <PhoneField
      label="Phone"
      value="1 (555) 555-5555"
    />
  );
}

JS

import {extension, PhoneField} from '@shopify/ui-extensions/customer-account';

export default extension('customer-account.page.render', (root) => {
  const phoneField = root.createComponent(PhoneField, {
    label: 'Phone',
    value: '1 (555) 555-5555',
  });

  root.appendChild(phoneField);
});

Anchor to Best practicesBest practices

Label with context: Use labels like "Contact number" or "Mobile number" to clarify the expected type of phone number.
Explain why it's needed: When requiring a phone number, provide context about why, such as "Required for delivery updates."
Use autocomplete: Set the autocomplete attribute to tel to help customers fill in the field faster.
Use consent phone field for marketing: If collecting a phone number for marketing purposes, use ConsentPhoneField instead.

Anchor to LimitationsLimitations

The type prop applies styling hints only.

Was this page helpful?