The Text Input component for Retool Mobile
An input field to enter a single line of text.
Settings
Text Input includes the following configurable options when building apps in the IDE.
Show 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
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
Whether the input field expands to accommodate larger amounts of content.
customValidation
The custom validation message to display if the invalid
is true
.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData
, and to construct the form.data
property.
Whether to hide the validation message if the invalid
is true
.
iconBefore
The prefix icon to display.
Values
You can select an icon or dynamically set one with a valid icon key.
iconByIndex
A list of icons for each item, by index.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The unique identifier.