Skip to main content
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.

ConsentPhoneField

The ConsentPhoneField component displays a phone field for buyers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.

Support
Targets (50)

Supported targets

Anchor to ConsentPhoneFieldPropsConsentPhoneFieldProps

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 policy
policy
required

The policy for which buyer consent is being collected for.

sms-marketing: Represents the policy for SMS marketing consent.

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 ExamplesExamples

Anchor to Basic ConsentPhoneFieldBasic ConsentPhoneField

Basic ConsentPhoneField

Example

Basic ConsentPhoneField

import {
reactExtension,
ConsentPhoneField,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);

function Extension() {
return (
<ConsentPhoneField
label="Phone"
policy="sms-marketing"
/>
);
}
import {extension, ConsentPhoneField} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
const consentPhoneField = root.createComponent(ConsentPhoneField, {
label: 'Phone',
policy: 'sms-marketing',
});

root.appendChild(consentPhoneField);
});

Anchor to ConsentCheckbox with ConsentPhoneFieldConsentCheckbox with ConsentPhoneField

ConsentCheckbox with ConsentPhoneField

Example

ConsentCheckbox with ConsentPhoneField

import {
reactExtension,
BlockStack,
ConsentCheckbox,
ConsentPhoneField,
InlineStack,
InlineSpacer,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);

function Extension() {
return (
<BlockStack>
<ConsentCheckbox policy="sms-marketing">
Text me with news and offers
</ConsentCheckbox>
<InlineStack
inlineAlignment="start"
padding={[
'none',
'none',
'none',
'tight',
]}
>
<InlineSpacer spacing="extraTight" />
<ConsentPhoneField
label="Phone"
policy="sms-marketing"
/>
</InlineStack>
</BlockStack>
);
}
import {
extension,
BlockStack,
ConsentCheckbox,
ConsentPhoneField,
InlineStack,
InlineSpacer,
} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
const consentCheckbox = root.createComponent(
ConsentCheckbox,
{
policy: 'sms-marketing',
},
'Text me with news and offers',
);

const inlineSpacer = root.createComponent(InlineSpacer, {
spacing: 'extraTight',
});

const consentPhoneField = root.createComponent(ConsentPhoneField, {
label: 'Phone',
policy: 'sms-marketing',
});

const inlineStack = root.createComponent(
InlineStack,
{
inlineAlignment: 'start',
padding: ['none', 'none', 'none', 'tight'],
},
[inlineSpacer, consentPhoneField],
);

const layout = root.createComponent(BlockStack, undefined, [
consentCheckbox,
inlineStack,
]);

root.appendChild(layout);
});

Anchor to Best practicesBest practices

  • Write clear labels explaining the purpose: Provide labels to explain why the phone number is being collected and what messages buyers will receive.
  • Pre-fill when available: Pre-fill a known phone number so buyers can confirm without retyping.
  • Pair with consent checkbox: Use the ConsentCheckbox component alongside the ConsentPhoneField component to collect explicit marketing consent.
  • Use supported policies: For SMS marketing, set policy to sms-marketing so that Shopify can track consent automatically.

Anchor to LimitationsLimitations

  • The policy property only supports sms-marketing. Other consent types aren't available.
  • Full phone number validation and business rules aren't enforced by the ConsentPhoneField component. Implement your own validation when needed.

Anchor to RelatedRelated

ComponentConsentCheckbox
Was this page helpful?