The Text Input component for Retool Mobile
An input field to enter a single line of text.
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.
autoCapitalize
The type of automatic capitalization that the browser can automatically perform when using virtual or on-screen keyboards.
| Type | string | ||||||||||
| Format | Plain Text | ||||||||||
| Mutability |
| ||||||||||
| Allowed Values |
| ||||||||||
| Default | |
Examples
"words"
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
hidden
Whether this object is hidden from view.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
iconAfter
The suffix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
label
The text label to display.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
"Label"
labelCaption
The additional text to display with the label.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
maxLength
The maximum number of characters to allow.
| Type | number | ||||
| Format | Integer | ||||
| Mutability |
| ||||
| Default | |
Examples
100
minLength
The minimum number of characters to allow.
| Type | number | ||||
| Format | Integer | ||||
| Mutability |
| ||||
| Default | |
Examples
20
pattern
A regular expression (regex), without forward slashes around the pattern, to validate input if patternType is regex.
| Type | string | ||||
| Format | Regular Expression | ||||
| Mutability |
| ||||
| Default | |
Examples
^[a-zA-Z0-9]+$
patternType
The pattern with which to validate the input.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Mutability |
| ||||||||
| Allowed Values |
| ||||||||
| Default | |
placeholder
The text to display within the input field when there is no value.
| Type | string | ||||
| Format | string | ||||
| Mutability |
| ||||
| Default | |
Examples
Enter a value
showCharacterCount
Whether to display a character count with the input field.
| Type | boolean | ||||
| Mutability |
|
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
textInput.clearValidation()
Examples
Clear the validation message from textInput.
textInput.clearValidation();
textInput.clearValue()
Examples
Clear the current value of textInput.
textInput.clearValue();
textInput.focus()
Examples
Set focus on textInput.
textInput.focus();
textInput.resetValue()
Examples
Reset the current value of textInput.
textInput.resetValue();
textInput.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
textInput.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Examples
Disable textInput.
textInput.setDisabled(true);
Enable textInput.
textInput.setDisabled(false);
textInput.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
textInput.setHidden(hidden)
Parameters
hidden
Whether this object is hidden from view.
Examples
Hide textInput.
textInput.setHidden(true);
Unhide textInput.
textInput.setHidden(false);
textInput.setValue(value)
Parameters
value
The value.
Examples
Set the current value of textInput to userValue.
textInput.setValue(userValue);
textInput.validate()
Examples
Validate the value of textInput.
textInput.validate();
Events
Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.
suffixIconPress
A suffix icon is pressed.