The Text Input component for Retool Mobile

An input field to enter a single line of text.

Version: Self-hosted 3.148 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.

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	Control Usage Retool UI Inspector > Interaction > Advanced > Capitalize
Allowed Values	Value Description none No capitalization. sentences Capitalize sentences. words Capitalize words. characters Capitalize characters.
Default	none

Examples

"words"

---

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled 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 > Hidden 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 > Suffix icon
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 > Prefix icon
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 > 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 > Caption

---

maxLength

The maximum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Max length
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 > Min length
Default	null

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	Control Usage Retool UI Inspector > Interaction > Validation rules > Regex
Default	null

Examples

^[a-zA-Z0-9]+$

---

patternType

The pattern with which to validate the input.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description email Email address. regex Regular expression statement. url URL.
Default	null

---

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 > Placeholder
Default	Enter a value

Examples

Enter a value

---

showCharacterCount

Whether to display a character count with the input field.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

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.

textInput.clearValidation()

Clear the validation message from the input field.

Definition

textInput.clearValidation()

Examples

Clear the validation message from textInput.

textInput.clearValidation();

---

textInput.clearValue()

Clear the current values.

Definition

textInput.clearValue()

Examples

Clear the current value of textInput.

textInput.clearValue();

---

textInput.focus()

Set focus on the input field.

Definition

textInput.focus()

Examples

Set focus on textInput.

textInput.focus();

---

textInput.resetValue()

Reset the current value to the default value.

Definition

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.

Definition

textInput.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

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.

Definition

textInput.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide textInput.

textInput.setHidden(true);

Unhide textInput.

textInput.setHidden(false);

---

textInput.setValue()

Set the current value.

Definition

textInput.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of textInput to userValue.

textInput.setValue(userValue);

---

textInput.validate()

Validates the value of the input field.

Definition

textInput.validate()

Examples

Validate the value of textInput.

textInput.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
Blur	The input field is deselected.
Change	The value is changed.
Focus	The input field is selected.
Submit	The value is submitted.
Suffix Icon Press	A suffix icon is pressed.