Text

Enter and edit text values.

Provides a simple text field. Use it to input or edit textual data when there is no other more specific input component. Specific input components are:

• Date
• Number
• Radio
• Checkbox
• Checkbox group
• Select

When the amount of text expected is more than 1 line, consider using a Textarea component. See multiline text.

Examples

Basic

Loading...

Validating Regular Expressions

Loading...

Validating Mask

Loading...

Properties

General

Attribute	Type	Description	Category
Model Id	String	This is a unique id for the component.	Every field on a form model needs a unique ID, which is automatically generated but can be changed if needed (e.g. to reference in expressions or for debugging purposes). If the field type supports rendering a label, and most types do, it can be configured here. This label is a displayed on the form to the end user and typically indicates what value is expected in the field. The documentation property holds free-form text that can be used to give more details about this text field, like its purpose, usage in other models, etc.
Label	Text	The label attribute adds a label to the component.
Label position	Selection: Left Top	The position of the label, you can choose between left or top.
Label tooltip	Text	When it is defined, a question mark icon will appear in the component label. When the user hovers over it it will show this text in a tooltip.
Documentation	Multiline Text	A free-form text to explain the use cases for this form field.
Value	Text	The binding for the form field. Use an appropriate expression to bind the component to its value and specify where the value is written/read. For example, use '{{myVariableName}}' to store the value of the field in a variable named 'myVariableName'. Use prefixes to define the scope of the value, for example, 'root.' for referencing the root case/process to store the value in. Please refer to the section 'Frontend expressions' in the Flowable guide for more information.	The purpose of a form is to either display some value or to have users provide values for the various fields of a form. In both situations, this value needs to be bound to an identifier using the {{myValue}} notation, and the value provided by the user will be stored in a variable with that identifier. If there already was a value bound to the identifier before, for example because another form had a field bound to the same identifier, it will be displayed.
Default value	Text	If the value is not set, the default value will be used.
Placeholder	Text	A text that appears in the input box when it has no value.
Tab Index	Integer	Determine their relative ordering for sequential focus navigation. Tab index will be ignored if the component is inside a subform.

Validation

Validation

Attribute	Type	Description	Category
Required	Boolean	The required flag specifies if entering a value for the component is mandatory.	Providing proper data in form fields is important, especially when in process, case, decision or any other models the values provided in the form fields are used in subsequent steps. To make sure that the data is correct, validation is crucial. For this reason, a form can only be submitted when all fields are valid and thus all validation properties configured on the left apply. Check the tooltips on the properties for more information.
Validation regex	Text	Specifies the validation pattern with a regular expression to match the entered value against in order to be valid (e.g., '[ab]+' for any character combinations including 'a' and 'b' characters like 'aaa', 'ab' or 'bbaa'). Consult any regular expression help to find out about how to specify your regular expression.
Minimum length	Integer	The minimum number of characters required.
Maximum length	Integer	The maximum number of characters allowed.
Validation mask	Text	Creates a mask for the input, only allowing input in the predefined format. use 'a' for lowercase alphabetic characters (a-z). use 'A' for uppercase alphabetic characters (A-Z). use '9' for digits (numerical characters, 0-9) use '*' for alphanumeric characters (a-z, A-Z, 0-9) any other character must occur in the input at that position. Examples: mask '99-999' accepts values like '12-345', mask '99-aaa' accepts values like '12-abc', mask '99-AAA' accepts values like '12-ABC', mask '(99)-999' accepts values like '(12)-123', a mask '99 aa **' accepts values like '12 ab 1a'. Use backslash (\\) as escape character, the escape character works to define as 'non mask' a maskable character or the escape character itself.
Validation Panel Display	Selection: Show Only message Hide	Display at validation panel and validation tooltip.
Custom validations	List	List of additional validations to apply.	The text field can have custom validation rules beyond the standard set of validations. Such a rule is written as a frontend expression in the form of {{myExpression}}. If this expression evaluates to false, the submission of the form won't be possible.

Validation messages

Attribute	Type	Description	Category
Minimum length	Text	Specify the message to display if the minimum length defined is not reached.	If there any validation rules configured for this text field, an error message will be displayed to the user when the field is deemed invalid. This error message can be customized. Make sure to choose the matching error message property for the particular validation rule property you want to customize the message for.
Maximum length	Text	Specify the message to be displayed if the maximum length defined is exceeded.
Validation regex	Text	Specifies the error message to be shown if the value does not match the regular expression validation pattern.
Validation mask	Text	Specifies the error message to be shown if the value does not match the validation mask.

Rendering

Attribute	Type	Description	Category
Description	Text	The description attribute adds a description to the component.	Some field types have an extra line of text displayed to give the user more details about the field.
Ignored	Boolean	If true the component will be hidden and the value will not be part of any payload.	Fields can also be shown or hidden based on the visible condition. This can be a frontend expression in the form of {{myExpression}} which can reference other form field values by their IDs. Fields can also be enabled or disabled, and similarly this can be made dynamic based on a frontend expression. Some field types can be ignored (the property is shown here if that's the case), which means that its value won't be taken into account.
Visible	Boolean	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 the checked state of the checkbox. If you want to only 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 case id which is not the case in an initialization form.
Enabled	Boolean	Boolean value or expression specifies whether component is enabled or disabled.
Style class	Text	Stylesheet class name. Add any style classes to be applied to the component for the desired styling and rendering.	The text field can get customized CSS classes to customize the default styling. Note that the CSS files needed for the customizations must be available on the runtime system.

Advanced

Attribute	Type	Description	Category
Events	List		The text field emits low-level events on which can be reacted with a frontend expression to implement various use cases that are not possible with regular modeling. If the expression produces a value, it can be stored in a new variable using the Result variable property.

List Attribute Details

Custom validations

Attribute	Type	Description
Expression	Text	Validation passes when this expression is true.
Error message	Text	Message to display when the validation fails.

Events

Attribute	Type	Description
Event label	Text	This is a unique id for the component.
Event type	Selection: On value change	The type of event emitted by the form field.
Expression	Text	Validation passes when this expression is true.
Result variable	Text	Capture the result of the expression in a result variable.