---
title: "Phone Number Component"
slug: "phone-number-component"
updated: 2025-12-04T19:17:23Z
published: 2025-12-04T19:17:23Z
canonical: "docs.unqork.io/phone-number-component"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Phone Number Component

UDesignerClassic Designer

The **Phone Number component** is a specialized input used for entering phone numbers. By default, this [component](/v1/docs/module-builder-component-library) 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](/v1/docs/submission-data).

You'll find the Phone Number component under the [Secondary Fields](/v1/docs/secondary-fields) group to the left of the [Module Builder](/v1/docs/introduction-to-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](/v1/docs/general-component-settings) article.

## Display Settings

### Field Text

| Setting | Description |
| --- | --- |
| Property ID | A Property ID is the unique field ID used by Unqork to track and link [components](/v1/docs/module-builder-component-library) 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. |

[![A static image displaying the Phone Number's Display settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/display_thumb_0_0(7).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/display(7).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

### Default State Options

| Setting | Description |
| --- | --- |
| **Disable User Input** | When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**. |
| **Read Only View** | When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**. |
| **Hide Field** | Displays or hides the component from view. Setting Hide Field to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)** hides the component in Express View. Setting it to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)** displays the component. The component is always visible in the Module Builder. By default, Hide Field is set to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**. |
| **Disable Browser Autofill** | Setting the toggle to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**. |
| **Autocomplete Value** | When Autocomplete is set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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](/v1/docs/autocomplete-reference-guide) reference guide. |
| **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. |

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

## 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 ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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. > [!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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)** when you don’t want to store the values from this field in the database. > [!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. > [!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 ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)** in Module Settings, only values from fields with Store Data in Database enabled are tracked. By default, this toggle is set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**. |

[![A static image displaying the Phone Number's Data settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/data_thumb_0_0(6).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/data(6).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

## Validation Settings

### User Input

| Setting | Description |
| --- | --- |
| **Required** | When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**, the end-user must enter a value in the component's visible fields. When set to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**, the input is optional. By default, Required is set to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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. |

[![A static image displaying the Phone Number's Validation settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/validation_thumb_0_0(5).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/validation(5).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

## Advanced Settings

### 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](/v1/docs/using-regex-in-unqork) article. |
| **Pattern Error Message** | An error message that displays if the value does not meet the Regular Expression pattern. |

[![A static image displaying the Phone Number's Advanced settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/advanced_thumb_0_0(6).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/advanced(6).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

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

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

1. In the Module Builder, drag and drop a **P****hone Number** component onto your canvas.
2. In the Property ID field, enter **phone**.
3. In the Label Text field, enter `Phone Number`.
4. Navigate to the component's **Validation** settings.
5. Under **User Input**, set **Required** to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**.

[![A static image displaying the Required setting toggled to ON.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/UD_PhoneNumber_Comp_ValRequired_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/UD%20PhoneNumber%20Comp%20ValRequired.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)
6. Click **Save Component**.
7. **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.

[Video](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber_Express.webm?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

The **Phone Number component** is a specialized input used for entering phone numbers. By default, this [component](/v1/docs/module-builder-component-library) 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](/v1/docs/submission-data).

Unqork offers a Phone Number and an [Intl (International) Phone Number](/v1/docs/intl-phone-number-component) component. The Phone Number component works best with United States phone numbers. The Intl Phone Number component lets you set an international, country-specific input mask.

You'll find the Phone Number component under the [Secondary Fields](/v1/docs/secondary-fields) group to the left of the [Module Builder](/v1/docs/introduction-to-the-module-builder).

## Learning Objectives

## 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](/v1/docs/general-component-settings) article.

## Display Panel

[![A static image displaying the Phone Number component's Display settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/classic_Display_thumb_0_0(1).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/classic%20Display(1).jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

### 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. |
| **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 Browser Autofill** | Setting the toggle to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**. |
| **Disable User Input** | When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF**). |
| **Read Only View** | When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**. |
| **Hide Field** | Displays or hides the component from view. Setting Hide Field to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)** hides the component in Express View. Setting it to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)** displays the component. The component is always visible in the Module Builder. By default, Hide Field is set to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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. |

### Autocomplete

| 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 ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**. |
| **Autocomplete Value** | When Autocomplete is set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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](/v1/docs/autocomplete-reference-guide) reference guide. |

## Data Panel

[![A static image displaying the Phone Number component's Data settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber_Data_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber%20Data.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

### Data Storage

| Setting | Description |
| --- | --- |
| **Store Data in Database** | The Store Data in Database setting affects how data persists through your application. When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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. > [!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 ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)** when you don’t want to store the values from this field in the database. > [!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. > [!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 ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)** in Module Settings, only values from fields with Store Data in Database enabled are tracked. By default, this toggle is set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**. |

## Validation Panel

[![A static image displaying the Phone Number component's Validation settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber_Validation_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber%20Validation.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

### User Input

| Setting | Description |
| --- | --- |
| **Required** | When set to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**, the end-user must enter a value in the component's visible fields. When set to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(OFF)**, the input is optional. By default, Required is set to ![A toggle switch in the 'on' position, indicating an active setting or feature.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 2(1).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(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

[![A static image displaying the Phone Number component's Advanced settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber_Advanced_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber%20Advanced.jpg?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

### 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](/v1/docs/using-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. |

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

1. In the Module Builder, drag and drop a **P****hone Number** component onto your canvas.
2. In the Property ID field, enter **phone**.
3. In the Label Text field, enter `Phone Number`.
4. In the component's configuration menu, select **![Validation Icon](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/validation_teal_icon(6).png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) Validation**.
5. Set **Required** to ![A toggle switch indicating an on/off state for a user interface element.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Group 1.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D) **(ON)**.

[![A static image displaying the Required setting toggled to ON.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber_Required_thumb_0_0.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber%20Required.png?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)
6. Click **Save & Close**.
7. **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.

[Video](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/PhoneNumber_Express.webm?sv=2026-02-06&spr=https&st=2026-11-07T17%3A57%3A49Z&se=2026-11-07T18%3A57%3A49Z&sr=c&sp=r&sig=P4%2FfzGFDQx3KnxEveHTu3B13K%2F5UpBtJoMqALYHZJjU%3D)

## Resources

- [Modify the Checkpoint component using the toolbar settings](/v1/docs/component-toolbar-settings).
- [Intl Phone Number Component](/v1/docs/intl-phone-number-component).
- [Text Field Component](/v1/docs/text-field-component).
- [Submission Data](/v1/docs/submission-data).

An input mask is a string expression that constrains an end-user's input. For example, constraining a phone number input to 10 integers.

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.

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.

A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton.

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.

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.

HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages.

Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

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