Text Area

An input field to enter multiple lines of text.

Version: Cloud and 3.207 Edge

Demo

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	Control Usage Retool UI Inspector > Interaction > Advanced > Capitalize
Allowed Values	Value Description 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	Control Usage Retool UI Inspector
Default	false

Examples

true

---

autoFill

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

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description off Disable browser autofill. additional-name Additional name. address-line1 Address line 1. address-line2 Address line 2. birthdate-day Birthdate day. birthdate-full Full birthdate. birthdate-month Birthdate month. birthdate-year Birthdate year. cc-csc Credit card security code. cc-exp Credit card expiration date. cc-exp-day Credit card expiration day. cc-exp-month Credit card expiration month. cc-exp-year Credit card expiration year. cc-number Credit card number. country Country. current-password Current password. email Email address. family-name Family name. gender Gender. given-name Given name. honorific-prefix Honorific prefix. honorific-suffix Honorific suffix. name Full name. new-password New password. one-time-code One-time code. postal-code Postal code. street-address Street address. tel Telephone number. username Username.
Default	off

Examples

"email"

---

autoResize

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector
Default	true

Examples

true

---

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

enforceMaxLength

Whether to enforce the maximum length.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Enforce max length
Default	false

Examples

true

---

events

A list of configured event handlers that trigger actions or queries.

Type	array
Array values	object
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Event

---

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Mutability	Control Usage Retool UI Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).

---

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	textArea1

Examples

query1

button1

---

inputTooltip

The tooltip helper text to display below the input on focus.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	`Shift+Enter` to save, `Esc` to cancel

Examples

`Shift+Enter` to save, `Esc` to cancel

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

labelPosition

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

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Position
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

top

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Loading
Default	false

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

maxLength

The maximum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Max length
Default	null

Examples

100

---

maxLines

The maximum number of lines to show.

Type	number
Mutability	Control Usage Retool UI Inspector

---

minLength

The minimum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Min length
Default	null

Examples

20

---

minLines

The minimum number of lines.

Type	number
Mutability	Control Usage 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	Control Usage Retool UI Inspector > Interaction > Validation rules > Regex
Default	null

Examples

^[a-zA-Z0-9]+$

---

placeholder

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

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Read only
Default	false

Examples

true

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Required
Default	false

Examples

true

---

showCharacterCount

Whether to display a character count with the input field.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

spellCheck

Whether the browser can perform spellcheck on the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Enable spell check
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	string
Mutability	Read-only

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

textArea.clearValidation()

Clear the validation message from the input field.

Definition

textArea.clearValidation()

Examples

Clear the validation message from textArea.

textArea.clearValidation();

---

textArea.clearValue()

Clear the current values.

Definition

textArea.clearValue()

Examples

Clear the current value of textArea.

textArea.clearValue();

---

textArea.focus()

Set focus on the input field.

Definition

textArea.focus()

Examples

Set focus on textArea.

textArea.focus();

---

textArea.resetValue()

Reset the current value to the default value.

Definition

textArea.resetValue()

Examples

Reset the current value of textArea.

textArea.resetValue();

---

textArea.scrollIntoView()

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

Definition

textArea.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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.

---

---

Examples

Scroll the minimum amount to immediately bring textArea into view.

textArea.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

textArea.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

textArea.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable textArea.

textArea.setDisabled(true);

Enable textArea.

textArea.setDisabled(false);

---

textArea.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

textArea.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide textArea.

textArea.setHidden(true);

Unhide textArea.

textArea.setHidden(false);

---

textArea.setValue()

Set the current value.

Definition

textArea.setValue(id, pluginType, isHiddenOnDesktop, isHiddenOnMobile, style, maintainSpaceWhenHidden, showInEditor, margin, value)

Parameters

id

(No description available)

Type

unknown

---

pluginType

(No description available)

Type

unknown

---

isHiddenOnDesktop

(No description available)

Type

unknown

---

isHiddenOnMobile

(No description available)

Type

unknown

---

style

(No description available)

Type

unknown

---

maintainSpaceWhenHidden

(No description available)

Type

unknown

---

showInEditor

(No description available)

Type

unknown

---

margin

(No description available)

Type

unknown

---

value

(No description available)

Type

unknown

---

Examples

Set the current value of textArea to userValue.

textArea.setValue(userValue);

---

textArea.validate()

Validates the value of the input field.

Definition

textArea.validate()

Examples

Validate the value of textArea.

textArea.validate();

---

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
Blur	The input field is deselected.
Change	The value is changed.
Focus	The input field is selected.