Multiline Text component icon Multiline Text

The Multiline Text component is very similar to the Text component. It is intended for longer text, e.g., the description of a defect. It expands as the text becomes longer. Naturally, this component’s validation is more limited since longer text usually does not follow a specific pattern.

For short text, you may consider using the Text component. For numbers, there are the two components: Number and Decimal.

Appearance

Design Rendered
Multiline Text component rendered
Multiline Text component design

Attributes

Group Name Description

General

ID

This is a unique id for the component.

Label

The label attribute adds a label to the component, if not empty.

Label position

The position of the label, you can choose between Left or Top.

Label tooltip

When it is defined, a question mark icon appears in the component label. When the user hovers over it, it shows this text in a tooltip.

Value

The binding for the component. Use an appropriate expression to bind the component to its value and thus specify where the value is saved read. For example, use {{myVariableName}} to store the value of the component in a variable named myVariableName. Use prefixes to define the scope of the value, e.g., root. for referencing the root case to store the value in or parent. to store the value in the parent work item of the current one. For instance {{root.foo}} stores the value in the root case using a variable named foo. For more information please refer to the Flowable Forms section.

Default value

If a value is not set, the default value is used. Use an appropriate value; e.g., a text, a number, an id or a comma-separated list.

Description

The description attribute additionally adds a description to the component.

Visible

Boolean value or expression specifies whether the component is visible or hidden. This expression might include another value in the same form, for instance, use a checkbox bound to {{showAdditionalFields}} and use the very same expression as the visible attribute to show or hide the component according to the checked state of the checkbox. If you want only to show the component, if the form is not used as the init-form, you can use the expression {{root.id}} which evaluates to true only, if there is a current id which is not the id in a start form.

Ignored

If true the component is hidden and the value is not part of the payload.

Enabled

A Boolean value or expression specifies whether component is enabled or disabled.

Placeholder

The text that appears in the widget when there is no value.

Details

Minimum rows

Specifies the initial number of rows of text.

Maximum rows

Specifies the maximum number of rows of the text before scrolling.

Validation

Required

The required flag specifies whether entering a value for the component is mandatory or not.

Minimum length

Specifies the minimum length of the text. By default, there is no minimum length.

Maximum length

Specifies the maximum length of the text. By default, there is no maximum length.

Error messages

Minimum length

Specifies the message shown if the defined minimum length is not reached.

Maximum length

Specifies the message shown if the defined maximum length is exceeded.

Documentation

Documentation

Documentation intended to explain concepts of its use for future reference.

Customization

Style class

Stylesheet class name. Add any style classes to be applied to the component for the desired styling and rendering.