---
title: PhoneField
description: Use PhoneField to allow users to enter phone numbers.
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/phonefield
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/forms/phonefield.md
---

# Phone​Field

Use PhoneField to allow users to enter phone numbers.

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

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

* name

  string

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

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

* type

  'mobile' | ''

  Default: '' meaning no specific kind of phone number

  The type of number to collect.

  Specific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type.

* 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-phone-field label="Phone number" defaultValue="888-746-7439">
  </s-phone-field>
  ```

## Preview

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