Text Area Component
Estimated Reading Time: 4 minutes
Overview
The Text Area component is part of the core range of input components. A Text Area component lets the end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. enter multiple lines of text. For example, adding supporting notes on any subject. A Text Area component lets the end-user add a paragraph that goes into as much detail as necessary. You can also use a Text Area component to display values passed to it from another component.
You'll find the Text Area component in the Primary Components group to the left of the Module Builder.
What You'll Learn
After completing this article, you’ll know when to use a Text Area component, how to configure its settings, and how to use it in an Unqork application.
About the Configuration Window
Once you drop a component onto the Module Builder canvas, the following settings windows display:
General
Setting |
Description |
---|---|
Property ID |
A Property ID is the unique field ID used by Unqork to track and link components in your module. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls. Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation. |
|
The component is active and visible in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. While active, other components and processes can reference your component. Setting the toggle to By default, the Active toggle is set to |
Notes |
Select this tab to display the component's Notes area. You can use notes to keep your teammates informed. The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component. |
|
Select this tab to manage your component's display settings. |
|
Select this tab to manage your component's data settings. |
|
Select this tab to manage your component's actions settings. |
|
Select this tab to manage your component's validation settings. |
|
Select this tab to manage your component's advanced settings. |
|
Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component. |
|
Assign components one-word labels to help organize, identify, and group the components in your application. Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag. Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component. For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag. Save your Field Tags by pressing Enter (Return) or adding a comma after each entry. |
|
Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:
Additional keyboard shortcuts:
|
|
Select this tab to access the component documentation in Unqork's In-Product Help. |
Cancel |
Click this button to undo any unsaved configuration changes and return to the canvas. |
Save & Close |
Click this button to save all settings as configured and return to the canvas. |
Display Panel
Field Text
|
Contextual Help
|
Default State Options
|
Formatting
|
Data Panel
Data Storage
Setting |
Description |
---|---|
Store Data in Database |
The Store Data in Database setting affects how data persists through your application. When set to
NOTE By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to NOTE When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help. TIP Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to |
Actions Panel
Triggers
Setting |
Description |
---|---|
Trigger |
To set up a trigger, enter the Property ID of your chosen logic component into this field. When the end-user performs an action on the current component, the triggered component fires. |
Trigger on Keypress |
A variation of the trigger setting. With this setting, the triggered component fires on every keystroke made inside the current component. |
Validation Panel
Input Required
Setting |
Description |
---|---|
Required |
When set to By default, the Required toggle is set to |
Required Error Message |
A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field. |
Advanced Panel
Additional Validation Options
Setting |
Description |
---|---|
Regular Expression Pattern |
The Regular Expression pattern that the field's value must match to be valid. TIP To learn about Regular Expression patterns, see our Regex in Unqork article. |
Pattern Error Message |
An error message that displays if the value doesn't meet the Regular Expression pattern. |
Min/Max Length |
Sets the minimum or the maximum number of characters an end-user must enter for valid input. |
Min/Max Length Error Message |
A custom error message that displays below the input field. The error message displays when the entry doesn't meet the minimum or maximum character length rule. |
Show Max Length Countdown |
When set to By default, the Show Maximum Length toggle is set to |
Allow Typing Beyond Maximum Length |
When set to By default, the Allow Typing Beyond Maximum Length toggle is set to |
Additional Styling
Setting |
Description |
---|---|
Custom CSS Class |
Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module. Updated CSS styling applies to all components that reference this custom class name. |
Adding a Text Area Component
Using a Text Area Component, you'll collect the details of a parent/child relationship. These instructions assume that you have an open module saved with a title.
Configure the Text Area Component
Give your component a Property ID, a descriptive Label, and allow for multiple lines.
1. | In the Module Builder, drag and drop a ![]() |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter relationshipMother. |
3. | In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Tell me about your relationship with your mother. |
4. | Adjust the Set Input Height Sets the number of lines shown in Express View. to 5 lines. |
5. | Click Save & Close. |
6. | Save your module. |
Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. You'll see the following functionality:
Structure of a Text Area Component's Data
A Text Area component stores its data as a string when viewed in the developer console.
NOTE Currently, Unqork doesn't support values entering or rendering text values greater than 1024 characters in a submission.
Resources