Text Area Component

 

Estimated Reading Time:  4 minutes

Overview

The Text Area Component is part of the core range of input components that lets the end-user End-users, also known as Express 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, an end-user can enter a paragraph of information 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.

About the Configuration Window

TIP  To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.

Display Panel

Field Text

A static image displaying the Text Area component's Display settings.

Setting

Description

Label Text

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Placeholder Text

A short prompt telling end-users the expected value of an input field. For example: Enter your Social Security Number. Placeholder Text displays inside the input field until the end-user begins an entry.

Contextual Help

Setting

Description

Tooltip

A short hint that displays when an end-user positions their cursor over the Questionmark Icon (Tooltip) icon. Tooltips can display across more than one line.

Helper Text

A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line.

Default State Options

Setting

Description

Hide Label

Setting the Hide Label toggle to (ON) stops Label Text from displaying 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. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. Your Label Text still displays in the Module Builder.

By default, the Hide Label toggle is set to (OFF).

Disable User Input

When set to (ON), end-users cannot interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.

By default, the Disable User Input toggle is set to (OFF).

Read Only View

When set to (ON), the component is display-only. If another component pushes content to the field, the end-user sees that content. Otherwise, end-users see the word None.

By default, the Read Only View toggle is set to (OFF).

Hide Field

Shows or hides the component from view. Setting the Hide Field toggle to (ON) hides the component in Express View. Setting the toggle to (OFF) shows the component. The component is always visible in the Module Builder.

By default, the Hide Field toggle is set to (OFF).

Hide Helper Text

Stops Helper Text from displaying in Express View.

By default, the Hide Helper Text toggle is set to (OFF).

Disable Browser Autocomplete

Setting the toggle to (ON) stops the browser from autofilling the field. When a user clicks the field, they must enter the value instead of having it autofill by the browser. Use this setting in all fields containing sensitive data.

NOTE  Some browsers might not support this setting.

By default, the Disable Browser Autofill toggle is set to (OFF).

Formatting

Setting

Description

Set Input Height

Sets the number of lines shown 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. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View..

Use Input Mask

Setting the Use Input Mask toggle to (ON) makes the Input Mask and Format Data With Mask options available. Setting the toggle to (OFF) hides these options from view.

By default, the Use Input Mask toggle is set to (OFF).

Input Mask

An Input Mask is a string of characters that indicates the format of a valid input. Use an Input Mask when the format of the input value must be consistent. Use "9" to require a number, "a" to require a letter, and "*" to require an alphanumeric character.

Format Data With Mask

Stores your data with the input mask formatting applied. Setting the Format Data With Mask toggle to (ON) activates the feature. Setting the toggle to (OFF) stores your data without the input mask formatting applied.

By default, the Format Data With Mask toggle is set to (OFF).

Adding a Text Area Component

Configure a Text Area component to collect the details of a parent/child relationship.

NOTE  These instructions assume that you have an open module saved with a title.

Configure the Text Area Component

Configuring a Text Area component is as simple as providing it a Property ID, descriptive Label, and allowing for multiple lines of text to be entered by your end-user.

1. In the Module Builder, drag and drop a  Text Area component onto your canvas.
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 us about your relationship with your mother.
4. In the Set Input Height Sets the number of lines shown in Express View. field enter 5. This value determines how many lines of text display in Express View.
5. Click Save Component.
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. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View. to view the following functionality:

Structure of a Text Area Component's Data

The Text Area component's data stores in a key/value format. In the above example, the relationshipMother  Text Area component stores the value entered by the end-user.

A static image displaying the Text Area component's data structure.

NOTE  Currently, Unqork doesn't support values entering or rendering text values greater than 1024 characters in a submission.

Resources