The Text Area component for Retool Mobile
An input field to enter multiple lines of text.
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 | ||||||||||
| Configurability | Inspector > Interaction > Advanced > Capitalize | ||||||||||
| Allowed Values |
| ||||||||||
| Default | none |
Examples
false"words"
autoComplete
Whether the browser can perform autocomplete on the input field.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector |
| Default | false |
Examples
falsetrue
autoCorrect
Whether to automatically correct the input.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector |
| Default | false |
Examples
falsetrue
autoResize
Whether the input field expands to accommodate larger amounts of content.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector |
| Default | true |
Examples
falsetrue
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
falsetrue
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
falsetrue
iconAfter
The suffix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Suffix icon |
| Default | null |
Examples
false/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string |
| Format | Icon Key |
| Configurability | Inspector > Content > Add-ons > Prefix icon |
| Default | null |
Examples
false/icon:bold/shopping-gift
label
The text label to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Label |
| Default | null |
Examples
false"Label"
labelCaption
The additional text to display with the label.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Caption |
| Default | null |
maxLength
The maximum number of characters to allow.
| Type | number |
| Format | Integer |
| Configurability | Inspector > Interaction > Validation rules > Max length |
| Default | null |
Examples
false100
minLength
The minimum number of characters to allow.
| Type | number |
| Format | Integer |
| Configurability | Inspector > Interaction > Validation rules > Min length |
| Default | null |
Examples
false20
minLines
The minimum number of lines.
| Type | number |
| Configurability | Inspector > Interaction > Validation rules > Min lines |
| Default | null |
pattern
A regular expression (regex), without forward slashes around the pattern, to validate input if patternType is regex.
| Type | string |
| Format | Regular Expression |
| Configurability | Inspector > Interaction > Validation rules > Regex |
| Default | null |
Examples
false^[a-zA-Z0-9]+$
patternType
The pattern with which to validate the input.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Configurability | Inspector | ||||||||
| Allowed Values |
| ||||||||
| Default | null |
placeholder
The text to display within the input field when there is no value.
| Type | string |
| Format | string |
| Configurability | Inspector > Content > Placeholder |
| Default | Enter a value |
Examples
falseEnter a value
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 |
|---|