Skip to main content

Phone


Phone fields collect a mobile or landline number from the user. This element includes a country code selector, input validation, and real-time formatting. Use this field to support international input and enforce phone number policies.

Properties

PropertyValueDescription
TypePhoneUI component type
GroupFieldBelongs to the "Field" group in UI catalog
Identifier36Unique element ID
PreviewSee image preview above
ValueYAccepts user-entered phone number
MandatoryYRequired for form submission
ErrorYDisplays validation error for wrong format
MinNo explicit minimum value
MaxNo explicit maximum value
Read-onlyYCan display as static, non-editable
Text, IconYDisplays label and optional icon
EventYTriggers on input or validation
ShadeYUses shaded background
ChildrenNo nested fields
ListNot a list container

Usage Example

<PhoneInput
label="Mobile number"
defaultCountry="IL"
required
onChange={handlePhoneChange}
/>

SDK Integration

The Edit Profile screen uses this element. It connects to the SDK method:

Method: /account/edit

Updates a doctor’s profile. The phone number field is mandatory and supports validation against formatting and country-specific rules.


Example UI Placement

LevelIDTypeValueDescription
1phonePhoneMobile numberEditable user contact number

Notes

  • Includes dropdown for country dialing code selection.
  • Validates length and structure based on selected region.
  • Commonly used in authentication, profile, and contact flows.