The Number Input component for Retool Mobile
An input field to enter a number.
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 |
| Configurability | Inspector |
| Default | false |
Examples
true
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
true
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
true
iconAfter
The suffix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Suffix icon |
| Default | null |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Prefix icon |
| Default | null |
Examples
/icon:bold/shopping-gift
label
The text label to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Label |
| Default | null |
Examples
"Label"
labelCaption
The additional text to display with the label.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Caption |
| Default | null |
maxLength
The maximum number of characters to allow.
| Type | number |
| Format | Integer |
| Configurability | Inspector > Interaction > Validation rules > Max length |
| Default | null |
Examples
100
minLength
The minimum number of characters to allow.
| Type | number |
| Format | Integer |
| Configurability | Inspector > Interaction > Validation rules > Min length |
| Default | null |
Examples
20
placeholder
The text to display within the input field when there is no value.
| Type | string |
| Format | string |
| Configurability | Inspector > Content > Placeholder |
| Default | Enter a value |
Examples
Enter a value
showStepper
Whether the input field includes buttons to adjust the value incrementally.
| Type | boolean |
| Configurability | Inspector > Appearance > Advanced > Show stepper buttons |
| Default | null |
stepSize
The step size used when adjusting the value.
| Type | number |
| Configurability | Read-only |
| Default | null |
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.
numberInput.clearValidation()
Examples
Clear the validation message from numberInput.
numberInput.clearValidation();
numberInput.clearValue()
Clear the current values.
numberInput.clearValue()
Examples
Clear the current value of numberInput.
numberInput.clearValue();
numberInput.focus()
Set focus on the input field.
numberInput.focus()
Examples
Set focus on numberInput.
numberInput.focus();
numberInput.resetValue()
Reset the current value to the default value.
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.
numberInput.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
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.
numberInput.setHidden(hidden)
Parameters
Examples
true
Examples
Hide numberInput.
numberInput.setHidden(true);
Unhide numberInput.
numberInput.setHidden(false);
numberInput.setValue()
Set the current value.
numberInput.setValue(key, value)
Examples
Set the current value of numberInput to userValue.
numberInput.setValue(userValue);
numberInput.validate()
Validates the value of the input field.
numberInput.validate()
Examples
Validate the value of numberInput.
numberInput.validate();
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Change | The value is changed. |