Text-area widget
The text-area widget supports the entry of multiple lines of text.
Example
Properties
Property |
Description |
Data type |
---|---|---|
|
ARIA label, which provides additional information about the element's purpose and functionality to assistive technologies, such as screen readers. If this is not provided, assistive technologies use |
string |
|
JSON containing the properties that define the visual appearance of the item, as described in Context properties. |
string (JSON) |
|
Name of event that fires when a user makes any input change. |
string |
|
Tooltip displayed below the input. |
string |
|
Unique identifier of this widget. |
string |
|
Optional label text displayed for text area control. |
string |
|
Implements a Material Design outlined text field, where the label is superimposed over the border, as described and shown in https://m3.material.io/components/text-fields/overview. |
Boolean |
|
Text displayed as input placeholder. |
string |
|
Number of lines visible to user. |
integer |
|
Indicates whether the engine sets focus to this widget. Default is If set to |
Boolean |
type
|
Rich-media type, which is always TextArea . |
string |
Context properties
These are the context
properties.
Context property |
Description |
Data type |
---|---|---|
|
Label color, as a hex color code. |
string (hex color code) |
|
Label alignment, which is one of: |
enum |
|
Label size, in pixels. |
integer |
|
Label style, which is one of: |
enum |
controlContext properties
These are the controlContext
properties.
controlContext property |
Description |
Data type |
---|---|---|
|
Text area border color, as a hex color code. |
string (hex color code) |
|
Text area border radius, in pixels. |
integer |
|
Text area border width, in pixels. |
integer |
|
Text area left margin, in pixels. |
integer |
|
Text area right margin, in pixels. |
integer |
Validation properties
Property |
Description |
Data type |
---|---|---|
|
Maximum length of input, in pixels. |
integer |
|
Minimum length of input, in pixels. |
integer |
|
Indicates whether user input matches the pattern. |
string (regular expression) |
|
Indicates whether user input is required. |
Boolean |
Widget-specific expression evaluation
Property |
Description |
Data type |
---|---|---|
|
Example: |
String |