Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Intl Phone Number Component

Prev Next

The Intl Phone Number component captures an international phone number with built-in country code selection and format validation. It supports all phone types or can be restricted to fixed line or mobile numbers only.

How to read settings tables

The tables below describe each configurable option as it displays in the UnqorkAI platform. Values are formatted as follows: inline code — a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

General Settings

Setting

Field

Type

Default

Description

Property ID

key

Text input

phonenumber

The unique identifier for this component instance.

Display Settings

Field Text

Setting

Field

Type

Default

Description

Label Text

label

Text input

—

Identifies the component on the canvas and informs end-users what information is requested.

Default State Options

Setting

Field

Type

Default

Description

Hide Label

hideComponentLabel

Toggle

OFF

Hides the label. The label remains visible in the Module Builder.

Hide Field

hidden

Toggle

OFF

Hides the component from end-users but always displays in the Module Builder.

Formatting

Setting

Field

Type

Default

Description

Behavior

—

Drop-down

Enable User Input

Sets how end-users can interact with the field.

  • Enable User Input (default): End-users can type directly into the field.

  • Display as Text (readOnlyView): Displays the stored value as plain text without the input element. Shows None when empty.

  • Read Only (htmlReadOnly): Makes the field non-editable while still letting end-users view, select, and copy its content.

  • Disable User Input (disabled): Prevents end-users from editing the field. The field displays with an altered appearance to indicate it is not editable.

Setting

Field

Type

Default

Description

Hide Country Option

hideCountry

Toggle

OFF

Hides the country selector. Phone numbers are validated for the default country only.

Phone Number Types

phoneType

Choice chip

All

Restricts the accepted phone number types. Options include: All, Fixed Line, or Mobile.

Default

selectedCountry

Country selector

US

The default country code pre-selected in the country drop-down.

Data Settings

Data Storage

Setting

Field

Type

Default

Description

Store Data in Database

persistent

Toggle

ON

When set to ON, this setting this setting stores field values to the database when the module saves, end-users navigate between Panel components, or end-users navigate between workflow screens. Set to OFF to exclude this field from server-side submissions.

Fields with Store Data in Database set to OFF are excluded from Plug-In component's API responses and Unqork's built-in tracker. When using a Plug-In component to remote-execute a module, any component whose value must be included in the API response requires Store Data in Database set to ON.

Validation Settings

User Input

Setting

Field

Type

Default

Description

Required

validate.required

Toggle

OFF

Requires a value before the module can be submitted.

Required Error Message

errors.required

Text input

is required

Displays when the required field is left empty.

Advanced Settings

Valid Phone Number

Setting

Field

Type

Default

Description

Validate Phone Number

validatePhoneNumber

Toggle

ON

Requires the entered number to be a valid phone number for the selected country.

Phone Number Error Message

errors.isValidPhone

Text input

Must be a valid phone number

Displays when the entered value is not a valid phone number.

Additional Styling

Setting

Field

Type

Default

Description

Custom CSS Class

customClass

Text input

—

A CSS class applied to the component for custom styling.

Operations Builder

This component supports the Operations Builder in Vega modules. When the module or panel runtime is set to Vega (2.0), an Event Handlers section displays in the settings panel for configuring event-driven operations.


Changelog

Date

Change

—

Initial publication.