Intl Phone Number Component

Overview

The Intl (International) Phone Number component is a Centauri (v1.0) The Centauri (v 1.0.0) runtime is the first-generation foundation of the Unqork Designer Platform. Centauri provides Creators a codeless experience for developing applications. specialized input component for use with international phone numbers.

You'll see many similarities when comparing it to the Phone Number component, but the critical features include the following:

Built-in validation for global phone numbers, including the United States.
End-users 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. can select a phone number's country of origin, making the component ideal when expecting submission data from various countries.

You'll find the Intl 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, view our General Component Settings article.

Display Settings

Field Text

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.

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.

Default State Options

Setting	Description
Hide Label	Setting Hide Label to (ON) hides Label Text from displaying in Express View Express View is how your end-user views your 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, 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).

Setting

Description

Hide Label

Setting Hide Label to (ON) hides Label Text from displaying in Express View Express View is how your end-user views your 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, 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).

Formatting

Setting	Description
Input Behavior	Controls how end-users 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. 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 HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages. attribute, which notifies screen readers that the field cannot be modified.
Hide Country Option	When set to (ON), end-users cannot select their phone number's country of origin. Instead, their number validates based on the Default Country setting. If set to (OFF), a new field displays to the left of the Intl Phone Number component field in Express View. Here, the end-user can select their phone number's country of origin. By default, the Hide Country Option is set to (ON).
Phone Number Types	Sets the specific phone line type (mobile, fixed line, or both) for validation. All: Validation of both landline and mobile phone numbers. Fixed Line: Validation of landline phone numbers only. Mobile: Validation of mobile phone numbers only.
Default Country	Different countries use different phone number formats and standards. Your end-user's input validates and formats based on the country you select from this drop-down.

Data Settings

Data Storage

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).

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 Settings

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 Settings

Valid Phone Number Group

Setting	Description
Validate Phone Number	When set to (ON), the component checks that the phone number entered is valid. The phone number must meet all rules and conventions for its country of origin. When set to (OFF), no validation takes place. By default, Validate Phone Number is set to (ON).
Phone Number Error Message	Displays as a custom error message under the field on entry of an invalid phone number by the end-user. Once corrected, the error message clears.

Setting

Description

Validate Phone Number

When set to (ON), the component checks that the phone number entered is valid. The phone number must meet all rules and conventions for its country of origin. When set to (OFF), no validation takes place.

By default, Validate Phone Number is set to (ON).

Phone Number Error Message

Displays as a custom error message under the field on entry of an invalid phone number by the end-user. Once corrected, the error message clears.

Additional Styling

Setting	Description
Custom CSS Styling	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. 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 Styling

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. 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 an Intl Phone Number Component

Let's configure an Intl Phone Number component to accept phone numbers from Spain. These instructions assume that you have an open module saved with a title.

In the Module Builder, drag and drop an Intl Phone Number component onto your canvas.

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 intlPhone.

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 Phone Number.

From the Default Country drop-down, enter or select Spain.

Click Save Component.

Save your module.

Preview your module in Express View Express View is how your end-user views your 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. and enter a phone number. Notice how the component formats the number in the specified Spain format.

You do not need to enter the country code at the beginning of the number. The component already knows the country code based on the Default Country drop-down selection. If you do enter the country code manually, the component deletes it once you've entered the full number.

For this example, the Validate Phone Number is set to (OFF) to test the configuration without having to enter a valid phone number. With this setting set to (ON), this example phone number is invalid.

Overview

You'll see many similarities when comparing it to the Phone Number component, but the critical features include the following:

Built-in validation for global phone numbers, including the United States.
End-users 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. can select a phone number's country of origin, making the component ideal when expecting submission data from various countries.

You'll find the Intl 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, view our General Component Settings article.