Skip to main content

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
Mutability
ControlUsage
Retool UI Inspector > Interaction > Advanced > Capitalize
Allowed Values
ValueDescription
none

No capitalization.

sentences

Capitalize sentences.

words

Capitalize words.

characters

Capitalize characters.

Default
none
Examples
"words"

autoComplete

Whether the browser can perform autocomplete on the input field.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector
Default
false
Examples
true

autoCorrect

Whether to automatically correct the input.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector
Default
false
Examples
true

autoResize

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector
Default
true
Examples
true

disabled

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Disabled
MethodsetDisabled()
Default
false
Examples
true

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Hidden
MethodsetHidden()
Default
false
Examples
true

iconAfter

The suffix icon to display.

Type string
Format Icon Key
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Suffix icon
Default
null
Examples
/icon:bold/shopping-gift

iconBefore

The prefix icon to display.

Type string
Format Icon Key
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Prefix icon
Default
null
Examples
/icon:bold/shopping-gift

label

The text label to display.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Label > Label
Default
null
Examples
"Label"

labelCaption

The additional text to display with the label.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Label > Caption

maxLength

The maximum number of characters to allow.

Type number
Format Integer
Mutability
ControlUsage
Retool UI Inspector > Interaction > Validation rules > Max length
Default
null
Examples
100

maxLines

The maximum number of lines to show.

Type number
Mutability
ControlUsage
Retool UI Inspector

minLength

The minimum number of characters to allow.

Type number
Format Integer
Mutability
ControlUsage
Retool UI Inspector > Interaction > Validation rules > Min length
Default
null
Examples
20

minLines

The minimum number of lines.

Type number
Mutability
ControlUsage
Retool UI Inspector > Interaction > Validation rules > Min lines

pattern

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

Type string
Format Regular Expression
Mutability
ControlUsage
Retool UI Inspector > Interaction > Validation rules > Regex
Default
null
Examples
^[a-zA-Z0-9]+$

patternType

The pattern with which to validate the input.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector
Allowed Values
ValueDescription
email

Email address.

regex

Regular expression statement.

url

URL.

Default
null

placeholder

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

Type string
Formatstring
Mutability
ControlUsage
Retool UI Inspector > Content > Placeholder
Default
Enter a value
Examples
Enter a value

value

The value.

Type string | number | boolean | object | array
Mutability Read-only

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

EventDescription