Skip to content

Text Area

A text area is a component for entering a multi-line string of text.

Property

NoItemInput ValueDefault ValueAction PropertyTypeAction Default ValueDescription
1IDStringAuto-generatedidstringAuto-generatedThe [id] property cannot be set by actions.
2Label LStringText ArealabelstringText AreaComponent label
3WidthString222widthstring222Component width
4HeightString125heightstring125Component height
5XStringxstringX coordinate position
6YStringystringY coordinate position
7LockBooleanOFFlockbooleanfalseWhen ON, the component stays fixed even when the screen is scrolled.
When OFF, the component moves along with the screen scroll.
Added in v4.1.0.
8VariantSelection
1. Outlined
2. Filled
3. Standard
OutlinedvariantstringoutlinedComponent style
9Legacy DesignBooleanOFFThis is only effective when the Variant is set to Standard.
When ON, the component is displayed with the legacy design.
When OFF, the component is displayed with the new design.
Added in v4.1.0
10ColorString
Color Picker
colorstringComponent color
11Background ColorString
Color Picker
backgroundColorstringBackground color
12Label ColorString
Color Picker
labelColorstringLabel text color
13Input ColorString
Color Picker
inputColorstringInput text color
14DisabledBooleanOFFdisabledbooleanfalseComponent disabled/enabled state
15Read OnlyBooleanOFFreadOnlybooleanfalseRead-only mode
16RequiredBooleanOFFrequiredbooleanfalseRequired input field specification
17VisibilityBooleanONvisibilitybooleantrueComponent show/hide
18PlaceholderStringplaceholderstringPlaceholder text
19Helper TextStringhelperTextstringHelper text
20Change EventSelection
1. None
2. Action
3. Detached Action
NoneEvent setting for value changes
Detached Action became selectable in v4.1.0.
21ValueStringvaluestringText area value
22ErrorerrorbooleanfalseError state
23Detached ActionSelection
1. [Detached Action ID]
detachedActionstringSet a detached action
Added in v4.1.0.
24Tab FocusSelection
1.[Component ID]
tabFocusstringNext focus component specification
Added in v3.3.0

Event

Event nameDescription
onchangeOccurs when a value change is made and the cursor is moved out of the way.