Skip to main content

Text Area

Ant Design

The Text Area component is Ant Design's multi-line text input, for notes, comments and descriptions. It grows with its text between a minimum and a maximum number of rows.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Description
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
ValueThe text the field starts with.Text
PlaceholderHint text shown while the field is empty.Text. Default: Enter a description
Min rowsHeight of the field in rows when it's empty or short.Number. Default: 3
Max rowsNumber of rows the field grows to before it scrolls. 0 lets it grow without a limit.Number. Default: 8
Allow clearShows a clear icon in the field once it has text.On or off. Default: Off
Max lengthMost characters the user can type. 0 sets no limit.Number. Default: 0
Show countShows the number of characters typed, and the limit when Max length is set.On or off. Default: Off
VariantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the text changes.
On press enterTriggers when the user presses Enter without Shift. Shift+Enter adds a new line.
On focusTriggers when the field gets keyboard focus.
On blurTriggers when the field loses keyboard focus.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set field valueSets the text to the given Value.components.textarea1.setFieldValue("")
Reset fieldSets the field back to the Value property.components.textarea1.resetFields()
FocusMoves keyboard focus to the field.components.textarea1.focus()
BlurRemoves keyboard focus from the field.components.textarea1.blur()
Set visibilityShows the component when true, hides it when false.components.textarea1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.textarea1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.textarea1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.textarea1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.textarea1.extra}}
tooltipText shown from an info icon after the label.{{components.textarea1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.textarea1.layout}}
valueThe text the field starts with.{{components.textarea1.value}}
placeholderHint text shown while the field is empty.{{components.textarea1.placeholder}}
minRowsHeight of the field in rows when it's empty or short.{{components.textarea1.minRows}}
maxRowsNumber of rows the field grows to before it scrolls. 0 lets it grow without a limit.{{components.textarea1.maxRows}}
allowClearShows a clear icon in the field once it has text.{{components.textarea1.allowClear}}
maxLengthMost characters the user can type. 0 sets no limit.{{components.textarea1.maxLength}}
showCountShows the number of characters typed, and the limit when Max length is set.{{components.textarea1.showCount}}
variantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.{{components.textarea1.variant}}
sizeHeight and text size of the field.{{components.textarea1.size}}
isVisibleWhether the component is visible.{{components.textarea1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.textarea1.isLoading}}
isDisabledWhether the component is disabled.{{components.textarea1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.