Phone Number Component

Overview

The Phone Number component is a specialized input used for entering phone numbers. By default, this component includes an input mask of (999) 999-9999, ensuring end-users input this predefined format. As an end-user enters their phone number, the input mask formats the value in the submission data.

You'll find the Phone Number component under the Secondary Fields group to the left of the Module Builder.

About the Configuration Window

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

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 calls. Property IDs must use camel case (stylized as camelCase) without spaces or punctuation.
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.
Prefix	Alphanumeric characters append to the start of the value entered in the field. If called by another component, the prefix stores with the value.
Suffix	Alphanumeric characters that append to the end of the value entered in the field. If called by another component, the suffix stores with the value.

Contextual Help

Setting	Description
Tooltip	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
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, Disable User Input is set to (OFF).
Read Only View	When set to (ON), the component is display-only. If another component sends content to the field, the end-user can view that content. Otherwise, end-users see the word None. By default, the Read Only View toggle 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).
Disable Browser Autofill	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
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. By default, the Phone Number component has an Input Mask of (999) 999-9999. Note that phone numbers store in the submission data without formatting.
Mask Error Message	The error message that displays to the end-user if they input the incorrect number of digits.

Setting

Description

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.

By default, the Phone Number component has an Input Mask of (999) 999-9999. Note that phone numbers store in the submission data without formatting.

Mask Error Message

The error message that displays to the end-user if they input the incorrect number of digits.

Setting	Description
Store Data in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. 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 (OFF) when you don’t want to store the values from this field in the database. 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. 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 (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked. By default, this toggle is set to (ON).

Validation Panel

User Input

Setting	Description
Required	When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required is set to (OFF).
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.

Setting

Description

Required

When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.

By default, Required is set to (OFF).

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
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.
Regular Expression Pattern	The Regular Expression pattern that the field's value must match to be valid. To learn about Regular Expression patterns, view our Regex in Unqork article.
Pattern Error Message	An error message that displays if the value does not meet the Regular Expression pattern.

Additional Styling

Setting	Description
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.

Setting

Description

Custom CSS Class

Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.

Adding a Phone Number Component

Let's configure a Phone Number component that accepts a standard United States phone number. Setting the field to required ensures that the end-user enters a value before moving on.

In the Module Builder, drag and drop a

Phone Number component onto your canvas.

In the Property ID field, enter phone.

In the Label Text field, enter Phone Number.

Navigate to the component's Validation settings.

Under User Input, set Required to (ON).

Click Save Component.

Save your module.

Preview your module in Express View and enter a United States phone number. Notice how an error message displays if you do not have the correct number of digits.

Phone Number Component

Overview

About the Configuration Window

Display Panel

Field Text

Contextual Help

Default State Options

Formatting

Data Panel

Data Storage

Validation Panel

User Input

Advanced Panel

Additional Validation Options

Additional Styling

Adding a Phone Number Component

Resources

Overview

What You'll Learn

About the Configuration Window

Display Panel

Field Text

Default State Options

Contextual Help

Formatting

Data Panel

Data Storage

Validation Panel

User Input

Advanced Panel

Additional Validation Options

Additional Styling

Adding a Phone Number Component

Resources

Feedback

Sorry about that

Great!

Looking for more help?