field typesphone

Phone Number

A phone number input with optional country code and format validation.

Overview

The Phone Number field provides a dedicated input for telephone numbers. On mobile it triggers a numeric keyboard. You can configure it to accept international format (with country code prefix) or a specific national format using the pattern validation.

DynamicFormBuilder also supports Nepali number input via the nepali flag, which renders a Nepali-script numeral input widget for deployments targeting Nepali-speaking users.

Properties

PropertyTypeDefaultDescription
idstringUnique field identifier (UUID in the builder).
typestringphoneMust be "phone".
labelstringHuman-readable label shown above the field or step heading.
requiredbooleanfalseWhen true, the form cannot submit without a value.
isHiddenbooleanfalseHides the field from respondents (may still store defaults).
isDisabledbooleanfalseRenders the field read-only.
instructionstringundefinedHelp text shown below the label (not the same as placeholder).
placeholderstringundefinedGhost text inside the control when empty.
validation.minnumberundefinedMinimum length (text) or minimum numeric value (number) or digit count (phone).
validation.maxnumberundefinedMaximum length, numeric bound, or digit count (phone).
validation.patternstringundefinedRegex the value must match.
validation.messagestringundefinedCustom error when validation fails.
conditionalRulesarrayundefinedShow this field when any rule matches another field's value.
logicobjectundefinedSimple visibility: depends_on + show_if_value.
reportingobjectundefinedAdmin submissions table: includeInTable, labelOverride, sortable, filterable.
integrationKeystringundefinedStable alias for external integrations instead of id.
defaultCountrystringundefinedDefault ISO country code (e.g. NP, US).

JSON Schema

{
  "type": "phone",
  "label": "Mobile Number",
  "name": "mobile_number",
  "required": true,
  "placeholder": "+1 (555) 000-0000",
  "validation": {
    "pattern": "^\+?[1-9]\d{7,14}$",
    "patternMessage": "Please enter a valid phone number"
  }
}

Common Use Cases

  • SMS or OTP verification and two-factor workflows
  • Delivery, callback, or support contact numbers
  • Emergency contacts and next-of-kin details
  • Sales or scheduling follow-up where voice or text is preferred
  • Localized deployments using Nepali numeral mode where applicable