field.textarea

Box for entering multi-line text. Use in tasks that require an extended response. For single-line responses, use the field.text component.

The size of the box does not automatically adjust to the length of the text. Users can change the height by dragging the lower-right corner. To change the default size of the box, use the rows property.

Note that formatting is not available in the text box.

View example in the sandbox.

Component properties

NameTypeDescription
type*"field.textarea"

Set component type

data*writable

Data with values that will be processed or changed.

labelstring

Label above the component.

disabledboolean

If true, editing is not available.

hintstring

Hint text.

placeholderstring

A semi-transparent label that is shown when the box is empty. Use it to provide an example or a hint for the response.

requiredMarkboolean

Show "*" next to the label

resizableboolean

Changing the box size. When set to true (the default value), the user can change the height. To prevent resizing, set the value to false.

rowsnumber

The height of the text box in lines.

rtlobject

In some languages, like Arabic or Hebrew, text is written from right to left. Use this property to set up the correct display mode for the component.

View example in the sandbox.

Learn more about RTL languages.

rtl.modestring

Display mode:

  • ltr — left to right.
  • rtl — right to left.

The chosen value will be added to the dir attribute in the component's HTML code. Learn more about dir.

validationcondition

Validation based on condition.

NameTypeDescription
type*"field.textarea"

Set component type

data*writable

Data with values that will be processed or changed.

labelstring

Label above the component.

disabledboolean

If true, editing is not available.

hintstring

Hint text.

placeholderstring

A semi-transparent label that is shown when the box is empty. Use it to provide an example or a hint for the response.

requiredMarkboolean

Show "*" next to the label

resizableboolean

Changing the box size. When set to true (the default value), the user can change the height. To prevent resizing, set the value to false.

rowsnumber

The height of the text box in lines.

rtlobject

In some languages, like Arabic or Hebrew, text is written from right to left. Use this property to set up the correct display mode for the component.

View example in the sandbox.

Learn more about RTL languages.

rtl.modestring

Display mode:

  • ltr — left to right.
  • rtl — right to left.

The chosen value will be added to the dir attribute in the component's HTML code. Learn more about dir.

validationcondition

Validation based on condition.