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 |
|---|---|---|
| Label | Text shown above the field, or beside it when Layout is horizontal. | Text. Default: Description |
| Extra | Help text shown under the field. A validation message replaces it while the value is not valid. | Text |
| Tooltip | Text shown from an info icon after the label. | Text |
| Layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | vertical, horizontal. Default: vertical |
| Value | The text the field starts with. | Text |
| Placeholder | Hint text shown while the field is empty. | Text. Default: Enter a description |
| Min rows | Height of the field in rows when it's empty or short. | Number. Default: 3 |
| Max rows | Number of rows the field grows to before it scrolls. 0 lets it grow without a limit. | Number. Default: 8 |
| Allow clear | Shows a clear icon in the field once it has text. | On or off. Default: Off |
| Max length | Most characters the user can type. 0 sets no limit. | Number. Default: 0 |
| Show count | Shows the number of characters typed, and the limit when Max length is set. | On or off. Default: Off |
| Variant | Border 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 |
| Size | Height 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 |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets 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 desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows 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 change | Triggers when the text changes. |
| On press enter | Triggers when the user presses Enter without Shift. Shift+Enter adds a new line. |
| On focus | Triggers when the field gets keyboard focus. |
| On blur | Triggers 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 value | Sets the text to the given Value. | components.textarea1.setFieldValue("") |
| Reset field | Sets the field back to the Value property. | components.textarea1.resetFields() |
| Focus | Moves keyboard focus to the field. | components.textarea1.focus() |
| Blur | Removes keyboard focus from the field. | components.textarea1.blur() |
| Set visibility | Shows the component when true, hides it when false. | components.textarea1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.textarea1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.textarea1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the field, or beside it when Layout is horizontal. | {{components.textarea1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is not valid. | {{components.textarea1.extra}} |
tooltip | Text shown from an info icon after the label. | {{components.textarea1.tooltip}} |
layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | {{components.textarea1.layout}} |
value | The text the field starts with. | {{components.textarea1.value}} |
placeholder | Hint text shown while the field is empty. | {{components.textarea1.placeholder}} |
minRows | Height of the field in rows when it's empty or short. | {{components.textarea1.minRows}} |
maxRows | Number of rows the field grows to before it scrolls. 0 lets it grow without a limit. | {{components.textarea1.maxRows}} |
allowClear | Shows a clear icon in the field once it has text. | {{components.textarea1.allowClear}} |
maxLength | Most characters the user can type. 0 sets no limit. | {{components.textarea1.maxLength}} |
showCount | Shows the number of characters typed, and the limit when Max length is set. | {{components.textarea1.showCount}} |
variant | Border style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line. | {{components.textarea1.variant}} |
size | Height and text size of the field. | {{components.textarea1.size}} |
isVisible | Whether the component is visible. | {{components.textarea1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.textarea1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.textarea1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 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.