Text Area Component

The Text Area component is part of the core range of input components that lets the end-user 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.

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.

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 Hide Label to  (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder.

By default, this setting is set to (OFF).

Hide Field

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

By default, Hide Field 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.

Some browsers might not support this setting.

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

Formatting

Setting

Description

Autocomplete

Autocomplete detects end-user data saved in a browser and uses it to fill relevant fields. For example, in Express View, if there is a field labeled First Name, and an end-user clicks into the field, the end-user's browser autofill function suggests first names saved to the browser.

By default, Autocomplete is set to  (ON).

Autocomplete Value

When Autocomplete is set to  (ON), the Autocomplete Value drop-down displays. Use this drop-down to select an ARIA role to better direct the autocomplete feature when an end-user clicks on a field. For example, selecting address-line1 helps the browser determine that the field should autofill with the first line of an address.

To learn more about supported ARIA values in Unqork, view our Autocomplete reference guide.

Set Input Height

Sets the number of lines shown 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).

Input Behavior

Setting Description

Input Behavior

Controls how end-users interact with the component. Choose from the following options:

  • Enable User Input: Allow end-users to view and enter data in this field.

  • Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.

  • Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

  • Read Only - Accessible: Makes the field non-editable and applies the readonly HTML attribute, which notifies screen readers that the field cannot be modified.

Configure a Text Area component to 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

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 Icon Text Area component onto your canvas.
2. In the Property ID field, enter relationshipMother.
3. In the Label Text field, enter Tell us about your relationship with your mother.
4. In the Set Input Height 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 to view the following functionality:

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

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

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