Textarea component
Add a text input field to a page to accept multi-line text user input.
Overview
Add a textarea components to a page to capture multi-line text input using a textarea input type. For example, if you want your flow users to provide further information or comments in response to a question or statement.
-
The text input field only accepts unformatted text. If you require a user to be able to enter rich text content, use a Rich Text component.
-
Text data should be stored in values of the 'string' content kind. See Value content kinds.
General settings
Configure the general settings for the component.
| Setting | Description |
|---|---|
| Help information about this component | Display help text directly below the component, for example to provide further information on how to use the component. |
| Label | Enter a label for the text component. The label is displayed above the component by default. Do not enter a label if you do not require this text to be shown. |
| Name | Enter a name for the component. |
| Placeholder text | Enter a short hint to display in the field, such as an example of the expected value or format. |
| Editable | 1. Select the checkbox to allow the component to accept input from a user. 2. De-select the checkbox to prevent a user from being able to input or interact with the component. |
State
Select the value that you wish to save the user input data into.
- Save the component state into: Click Select or create a new value to select an existing value or create a new value.
Values must be of the 'string' content kind. See Value content kinds.
Validation
Add client-side page validation to the component. You cannot add validation if you are saving state data into a boolean or object value.
- Click Add Validation.
- Select the validation Type.
- Enter a valid Value for the validation type.
- Enter a feedback Message to show to the user if the validation criteria is not met.
- Click Update to add the validation item.
| Setting | Description |
|---|---|
| Message | Enter a message to show to the user if the validation criteria is not met. For example, if the user has entered a numeric value that exceeds the Maximum number value you have set. |
| Value | Enter the validation criteria. • Minimum number: Enter a minimum number or character limit for the component. • Maximum number: Enter a maximum number or character limit for the component. • Regular expression pattern: Enter a valid Regular Expression (Regex) to validate the component. |
| Type | Select the type of validation to apply to the component. • Minimum number: A user must enter more than this value into the field. • Maximum number: A user is unable to enter more than this value into the field. • Regular expression pattern: Apply Regular Expression (Regex) validation to the component. |
| Required | Specify if the component requires user input before the next step in the flow can be navigated to. For example, a user must complete the input for this field before they are allowed to progress in the flow. • Switch on the toggle to set the component as requiring input from a user before they can progress in the flow, such as to the next page for example. A red asterisk is displayed next to the field name to indicate it is required. • Switch off the toggle to allow a user to progress in the flow even if they have not entered any input into the component, for example if the field is optional. |
Styles
Apply additional CSS styling to the component.
- Enter space-delimited CSS classes/selectors into the CSS Classes field.
When you run the flow, these classes are appended to the main component class.