Text Input component
Text Input handles text input types and supports the maxlength attribute to limit the number of characters entered.
Overview
Add Text Input components into a page to capture user input and data in a flow. This input can then be used in any way required, such as to trigger further events in the flow, determine the path of the flow, or simply to capture user data.
General settings
Configure the general settings for the component.
| Setting | Description |
|---|---|
| Name | Enter a name for the Text Input component. |
| Label | Enter a label for the Text Input 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. |
| Editable | Specify if the component can accept user input. |
| Autocomplete Tokens | You can specify autocomplete tokens for Text Input and textarea components. When you configure tokens for the autocomplete attribute, the browser suggests saved information—such as email addresses and first or last names—for those components when you run a Flow. Use valid token values such as “on”, “off”, or a space-separated list of tokens that describe the type of information the browser should suggest. You can find the full list of valid tokens at MDN Web Docs. |
| Placeholder text | Enter a short hint to display in the field, such as an example of the expected value or format. |
| Help information about this component | Display help text directly below the component, for example to provide further information on how to use 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.
The type of Text Input component presented to a user is determined by the content kind of the value selected in this field. Refer to Value content kinds for more information.
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 |
|---|---|
| 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. 1. 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. 2. 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. |
| Type | Select the type of validation to apply to the component. 1. Minimum number: A user must enter more than this value into the field. 2. Maximum number: A user is unable to enter more than this value into the field. 3. Regular expression pattern: Apply Regular Expression (Regex) validation to the component. |
| Value | Enter the validation criteria. 1. Minimum number: Enter a minimum number or character limit for the component. 2. Maximum number: Enter a maximum number or character limit for the component. 3. Regular expression pattern: Enter a valid Regular Expression (Regex) to validate the component. |
| 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. |
Styles
Apply additional CSS styling to the component.
Enter space-delimited CSS classes or selectors in the CSS Classes field. When you run the Flow, these classes are appended to the main component class.
