Skip to main content

Phone field

Use PhoneField to allow users to enter phone numbers.

Support
Targets (29)

Supported targets

  • purchase.checkout.actions.render-before
  • purchase.checkout.block.render
  • purchase.checkout.cart-line-item.render-after
  • purchase.checkout.cart-line-list.render-after
  • purchase.checkout.contact.render-after
  • purchase.checkout.delivery-address.render-after
  • purchase.checkout.delivery-address.render-before
  • purchase.checkout.footer.render-after
  • purchase.checkout.header.render-after
  • purchase.checkout.payment-method-list.render-after
  • purchase.checkout.payment-method-list.render-before
  • purchase.checkout.pickup-location-list.render-after
  • purchase.checkout.pickup-location-list.render-before
  • purchase.checkout.pickup-location-option-item.render-after
  • purchase.checkout.pickup-point-list.render-after
  • purchase.checkout.pickup-point-list.render-before
  • purchase.checkout.reductions.render-after
  • purchase.checkout.reductions.render-before
  • purchase.checkout.shipping-option-item.details.render
  • purchase.checkout.shipping-option-item.render-after
  • purchase.checkout.shipping-option-list.render-after
  • purchase.checkout.shipping-option-list.render-before
  • purchase.thank-you.announcement.render
  • purchase.thank-you.block.render
  • purchase.thank-you.cart-line-item.render-after
  • purchase.thank-you.cart-line-list.render-after
  • purchase.thank-you.customer-information.render-after
  • purchase.thank-you.footer.render-after
  • purchase.thank-you.header.render-after

Anchor to propertiesProperties

Anchor to autocomplete
autocomplete
AutocompleteField | `${} ${AutocompleteField}` | `${} ${AutocompleteField}` | `${} ${} ${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.

Anchor to defaultValue
defaultValue
string

The default value for the field.

Anchor to disabled
disabled
boolean
Default: false

Disables the field, disallowing any interaction.

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

Anchor to label
label
string

Content to use as the field label.

Anchor to labelAccessibilityVisibility
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.
Anchor to name
name
string

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

Anchor to readOnly
readOnly
boolean
Default: false

The field cannot be edited by the user. It is focusable will be announced by screen readers.

Anchor to required
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.

Anchor to type
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.

Anchor to value
value
string

The current value for the field. If omitted, the field will be empty.

Anchor to eventsEvents

Learn more about registering events.

Anchor to blur
blur
<typeof tagName>

Callback when the element loses focus.

Anchor to change
change
<typeof tagName>

Callback when the user has finished editing a field, e.g. once they have blurred the field.

Anchor to focus
focus
<typeof tagName>

Callback when the element receives focus.

Anchor to input
input
<typeof tagName>

Callback when the user makes any changes in the field.

Anchor to slotsSlots

Learn more about component slots.

Anchor to accessory
accessory
HTMLElement

Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.

Examples
<s-phone-field label="Phone number" defaultValue="888-746-7439">
</s-phone-field>

Preview

Was this page helpful?