The Phone Number Input component for Retool Apps

An input field to enter a phone number.

Version: Self-hosted 3.114 Stable

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

disabled

Whether input, interaction, selection, or triggering is disabled.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction Method setDisabled()
Default	false

Examples

true

---

formattedValue

The selected value in the specified format.

Type	string
Mutability	Read-only

---

iconAfter

The suffix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

/icon:bold/shopping-gift

---

iconBefore

The prefix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

/icon:bold/shopping-gift

---

inputTooltip

The tooltip helper text to display below the input on focus.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	`Shift+Enter` to save, `Esc` to cancel

Examples

`Shift+Enter` to save, `Esc` to cancel

---

labelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

top

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction
Default	false

Examples

true

---

lockedCountryCode

Whether to prevent changes to the country code.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

parsedValue

The parsed value.

Type	object
Mutability	Read-only

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced
Default	false

Examples

true

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	false

Examples

true

---

showClear

Whether to display a button to clear the value of the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

textAfter

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

USD

px

@example.com

---

textBefore

The prefix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

$

Email address

SKU

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

Submit

---

value

The current or default value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content Method setValue()
Default	null

Examples

Hello world!

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

phoneNumberInput.clearValidation()

Clear the validation message from the input field.

Definition

phoneNumberInput.clearValidation()

Examples

Clear the validation message from phoneNumberInput.

phoneNumberInput.clearValidation();

---

phoneNumberInput.clearValue()

Clear the current values.

Definition

phoneNumberInput.clearValue()

Examples

Clear the current value of phoneNumberInput.

phoneNumberInput.clearValue();

---

phoneNumberInput.focus()

Set focus on the input field.

Definition

phoneNumberInput.focus()

Examples

Set focus on phoneNumberInput.

phoneNumberInput.focus();

---

phoneNumberInput.resetValue()

Reset the current value to the default value.

Definition

phoneNumberInput.resetValue()

Examples

Reset the current value of phoneNumberInput.

phoneNumberInput.resetValue();

---

phoneNumberInput.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

phoneNumberInput.scrollIntoView(options)

Parameters

options Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block Required

string

The scroll position relative to the component.

Supported Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

Examples

Scroll the minimum amount to immediately bring phoneNumberInput into view.

phoneNumberInput.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

phoneNumberInput.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

phoneNumberInput.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide phoneNumberInput.

phoneNumberInput.setHidden(true);

Unhide phoneNumberInput.

phoneNumberInput.setHidden(false);

---

phoneNumberInput.setValue()

Set the current value.

Definition

phoneNumberInput.setValue(value)

Parameters

value

string | number | boolean | object | array

The value.

Examples

Set the current value of phoneNumberInput to userValue.

phoneNumberInput.setValue(userValue);

---

phoneNumberInput.validate()

Validates the value of the input field.

Definition

phoneNumberInput.validate()

Examples

Validate the value of phoneNumberInput.

phoneNumberInput.validate();

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.

---

submit

The value is submitted.

---

focus

The input field is selected.

---

blur

The input field is deselected.

---