The Text Input component for Retool Mobile

An input field to enter a single line of text.

Demo

Settings

Text Input includes the following configurable options when building apps in the IDE.

HiddenShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

CapitalizeAuto-grow with contentCustom ruleDisabledEvent handlersForm data keyHiddenHide validation messagePrefix iconShow on desktopShow on mobileLabelLabelsMaintain space when hiddenMarginMax lengthMax linesMin lengthMin linesRegexPatternPlaceholderRequiredAlways show in edit modeStylesValue

Demo

Properties

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

autoCapitalize

enum

The type of automatic capitalization that the browser can automatically perform when using virtual or on-screen keyboards.

Values

none	No capitalization.
sentences	Capitalize sentences.
words	Capitalize words.
characters	Capitalize characters.

---

autoResize

boolean

Whether the input field expands to accommodate larger amounts of content.

---

customValidation

string

The custom validation message to display if the invalid is true.

---

disabled

boolean

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

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

formDataKey

string

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

hideValidationMessage

boolean

Whether to hide the validation message if the invalid is true.

---

iconBefore

enum

The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconByIndex

enum[]

A list of icons for each item, by index.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

id

string

The unique identifier.

---

invalid

boolean

Whether the value has failed any validation rules.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

label

string

The text label to display.

---

labelCaption

string[]

The label for the node.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

maxLength

number

The maximum number of characters to allow.

---

maxLines

number

The maximum number of lines to show.

---

minLength

number

The minimum number of characters to allow.

---

minLines

number

The minimum number of lines.

---

pattern

string

A JavaScript regular expression, without forward slashes around the pattern, to validate input if patternType is regex.

---

patternType

enum

The pattern with which to validate the input.

Values

email	Email address.
regex	Regular expression statement.
url	URL.

---

placeholder

string

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

---

pluginType

string

The plugin type.

---

required

boolean

Whether a value is required.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

validationMessage

string

The validation message to display if invalid is true.

---

value

string

The value.

---

Methods

JavaScript API methods for interacting with Text Input. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValidation

Clear the validation message from the input field.

textInput.clearValidation()

---

clearValue

Clear the current values.

textInput.clearValue()

---

focus

Set focus on the input field.

textInput.focus()

---

resetValue

Reset the current value to the default value.

textInput.resetValue()

---

setDisabled

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

textInput.setDisabled(disabled)

Parameters

disabled

boolean

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

---

---

setHidden

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

textInput.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

textInput.setValue(value)

Parameters

value

string

The value.

---

---

validate

Validates the value of the input field.

textInput.validate()

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

blur

The input field is blurred.

---

change

The value is changed.

---

focus

The input field is focused.

---

submit

Input values are submitted.

---

suffixIconPress

A suffix icon is clicked or pressed

---