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.
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. |
autoComplete
Whether the browser can perform autocomplete on the input field.
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
.
Values
You can select an icon or dynamically set one with a valid icon key.
iconBefore
The prefix icon to display.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The unique identifier.
inputTooltip
The tooltip text to display.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelAlign
The horizontal alignment of the label.
Values
left | Left of the input field. |
top | Above the input field. |
labelCaption
The additional text to display with the label.
labelPosition
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
The label width, in the unit specified in labelWidthUnit
.
labelWidthUnit
The specified units for labelWidth
, if labelPosition
is left
.
Values
% | Percent. |
px | Pixels. |
col | Columns. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
patternType
The pattern with which to validate the input.
Values
email | Email address. |
regex | Regular expression statement. |
url | URL. |
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
showCharacterCount
Whether to display a character count with the input field.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
spellCheck
Whether the browser can perform spellcheck on the input field.
textBefore
The prefix text to display.
tooltipText
The tooltip text to display.
validationMessage
The validation message to display if invalid
is true
.