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 Settings
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 |
|---|---|
|
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. |
|
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:
|
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 Phone 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 (ON). |
| 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.
Validation
Resources
