Skip to main content

Phone Input

Ant Design

The Phone Input component is a phone number field with a country picker that shows each country's flag and calling code. It stores the number in international E.164 form, such as +14155550123.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Phone
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
ValueThe phone number the field starts with, in E.164 form such as +14155550123.Text
Default countryTwo-letter country code, such as US or IN, picked when the number doesn't name a country.Text. Default: US
Only countriesTwo-letter codes of the countries the picker offers, such as ['US', 'GB', 'IN']. Leave it empty to offer every country.Array
Allow country changeLets the user pick a different country. Turn it off to fix the country.On or off. Default: On
Show flagShows the country flag next to the calling code.On or off. Default: On
PlaceholderHint text shown while the field is empty.Text. Default: Enter a phone number
Allow clearShows a clear icon in the field once it has a number.On or off. Default: Off
VariantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the number or the country changes.
On press enterTriggers when the user presses Enter in the field.
On focusTriggers when the number field gets keyboard focus.
On blurTriggers when the number field loses keyboard focus.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set valueSets the phone number to the given Number. A number that starts with a calling code also picks that country.components.phoneinput1.setFieldValue("")
Set countryPicks the country with the given Country (ISO code), such as GB. A country outside Only countries is ignored.components.phoneinput1.setCountryCode("")
Reset fieldSets the field back to the Value property.components.phoneinput1.resetFields()
FocusMoves keyboard focus to the number field.components.phoneinput1.focus()
BlurRemoves keyboard focus from the number field.components.phoneinput1.blur()
Set visibilityShows the component when true, hides it when false.components.phoneinput1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.phoneinput1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.phoneinput1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.phoneinput1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.phoneinput1.extra}}
tooltipText shown from an info icon after the label.{{components.phoneinput1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.phoneinput1.layout}}
valueThe phone number the field starts with, in E.164 form such as +14155550123.{{components.phoneinput1.value}}
defaultCountryTwo-letter country code, such as US or IN, picked when the number doesn't name a country.{{components.phoneinput1.defaultCountry}}
onlyCountriesTwo-letter codes of the countries the picker offers, such as ['US', 'GB', 'IN']. Leave it empty to offer every country.{{components.phoneinput1.onlyCountries}}
allowCountryChangeLets the user pick a different country. Turn it off to fix the country.{{components.phoneinput1.allowCountryChange}}
showFlagShows the country flag next to the calling code.{{components.phoneinput1.showFlag}}
placeholderHint text shown while the field is empty.{{components.phoneinput1.placeholder}}
allowClearShows a clear icon in the field once it has a number.{{components.phoneinput1.allowClear}}
variantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.{{components.phoneinput1.variant}}
sizeHeight and text size of the field.{{components.phoneinput1.size}}
countryTwo-letter code of the picked country, such as US.{{components.phoneinput1.country}}
countryCodeCalling code of the picked country, such as +1.{{components.phoneinput1.countryCode}}
formattedValueThe number with its calling code and digit groups, as the user reads it.{{components.phoneinput1.formattedValue}}
isValidNumbertrue when the number has a valid length for the picked country.{{components.phoneinput1.isValidNumber}}
isVisibleWhether the component is visible.{{components.phoneinput1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.phoneinput1.isLoading}}
isDisabledWhether the component is disabled.{{components.phoneinput1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.