The Number Input component for Retool Mobile

An input field to enter a number.

Version: Cloud and 3.179 Edge

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.

allowNegativeNumbers

Whether to allow the input of negative numbers.

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

Examples

true

---

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

---

hidden

Whether this object is hidden from view.

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

Examples

true

---

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

---

label

The text label to display.

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

Examples

"Label"

---

labelCaption

The additional text to display with the label.

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

---

maxLength

The maximum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	null

Examples

100

---

minLength

The minimum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	null

Examples

20

---

placeholder

The text to display within the input field when there is no value.

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content
Default	Enter a value

Examples

Enter a value

---

showStepper

Whether the input field includes buttons to adjust the value incrementally.

Type	boolean
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced

---

stepSize

The step size used when adjusting the value.

Type	number
Mutability	Read-only

---

value

The value.

Type	string | number | boolean | object | array
Mutability	Read-only

---

Methods

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

numberInput.clearValidation()

Clear the validation message from the input field.

Definition

numberInput.clearValidation()

Examples

Clear the validation message from numberInput.

numberInput.clearValidation();

---

numberInput.clearValue()

Clear the current values.

Definition

numberInput.clearValue()

Examples

Clear the current value of numberInput.

numberInput.clearValue();

---

numberInput.focus()

Set focus on the input field.

Definition

numberInput.focus()

Examples

Set focus on numberInput.

numberInput.focus();

---

numberInput.resetValue()

Reset the current value to the default value.

Definition

numberInput.resetValue()

Examples

Reset the current value of numberInput.

numberInput.resetValue();

---

numberInput.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

numberInput.setDisabled(disabled)

Parameters

disabled

boolean

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

Examples

Disable numberInput.

numberInput.setDisabled(true);

Enable numberInput.

numberInput.setDisabled(false);

---

numberInput.setHidden()

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

Definition

numberInput.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide numberInput.

numberInput.setHidden(true);

Unhide numberInput.

numberInput.setHidden(false);

---

numberInput.setValue()

Set the current value.

Definition

numberInput.setValue(value)

Parameters

value

string | number | boolean | object | array

The value.

Examples

Set the current value of numberInput to userValue.

numberInput.setValue(userValue);

---

numberInput.validate()

Validates the value of the input field.

Definition

numberInput.validate()

Examples

Validate the value of numberInput.

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

---