The Text Input component for Retool Apps

An input field to enter a single line of text.

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

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.

autoComplete

boolean

Whether the browser can perform autocomplete on the input field.

autoFill

enum

The data type of the input field for browsers to autofill if autoComplete is true.

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.

hidden

boolean

Whether the component is visible.

hideValidationMessage

boolean

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

iconAfter

enum

The suffix icon to display.

Values

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

iconBefore

enum

The prefix icon to display.

Values

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

id

string

The unique identifier.

inputTooltip

string

The tooltip text to display.

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.

labelAlign

enum

The horizontal alignment of the label.

Values

left	Left of the input field.
top	Above the input field.

labelCaption

string

The additional text to display with the label.

labelPosition

enum

The position of the label relative to the input field or value.

Values

top	Above the input field or value.
left	Left of the input field or value.

labelWidth

number

The label width, in the unit specified in labelWidthUnit.

labelWidthUnit

enum

The specified units for labelWidth, if labelPosition is left.

Values

%	Percent.
px	Pixels.
col	Columns.

labelWrap

boolean

Whether the label can wrap to multiple lines.

loading

boolean

Whether to display a loading indicator.

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.

minLength

number

The minimum number of characters to allow.

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.

readOnly

boolean

Whether user input is read-only.

required

boolean

Whether a value is required to be selected.

showCharacterCount

boolean

Whether to display a character count with the input field.

showClear

boolean

Whether to display a button to clear the value of the input field.

showInEditor

boolean

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

spellCheck

boolean

Whether the browser can perform spellcheck on the input field.

style

object

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

textAfter

string

The suffix text to display.

textBefore

string

The prefix text to display.

tooltipText

string

The tooltip text to display.

validationMessage

string

The validation message to display if invalid is true.

value

string

The value.

Methods

blur

Remove focus from the input field.

textInput.blur()

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()

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

textInput.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

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.

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.