Phone Number Formatting

Use Cases

The number of digits, combination mode, and display mode of phone numbers vary according to countries and regions. Besides, the dialing mode and number format may also differ under different situations. For example, to make a cross-area call in Chinese mainland, you usually need to type 0 and then dial the area code plus an 8-digit phone number. To make a call in Hong Kong or Macao, you need to dial the number in a different way.

Through phone number formatting, your application will be able to present phone numbers to users in their expected format.

How to Develop

Phone number formatting is implemented through the format API of the PhoneNumberFormat class.

Phone Number Formatting Options

The following uses the phone number 158****2312 and the country code CN as an example to show the values of PhoneNumberFormatOptions and corresponding display effects.

Table 1 Phone number formatting type (type)

Value	Display Effect
E164	+86 158****2312
INTERNATIONAL	+86 158 **** 2312
NATIONAL	158 **** 2312
RFC3966	tel:+86-158-****-2312
TYPING	158 ***

Development Example

// Import the i18n module.
import { i18n } from '@kit.LocalizationKit';

// Format the phone number.
let phoneNumberFormat: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN');
let formattedPhoneNumber: string = phoneNumberFormat.format('158****2312'); // formattedPhoneNumber = '158 **** 2312'

// Set the format type of the phone number to RFC3966.
let RFC3966Format: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN', { type: 'RFC3966' });
formattedPhoneNumber = RFC3966Format.format('158****2312'); // formattedPhoneNumber = 'tel:+86-158-****-2312'

// Check whether the phone number is valid.
let isValid: boolean = phoneNumberFormat.isValidNumber('158****2312'); // isValid = true

// Display the home area of the phone number in the specified language.
let locationName: string = phoneNumberFormat.getLocationName('158****2312', 'en-GB'); // locationName = 'XiAn, Shanxi'

// Format the phone number being dialed.
let typingFormat: i18n.PhoneNumberFormat = new i18n.PhoneNumberFormat('CN', { type: 'TYPING' });
let phoneNumber: string = '0755453';
let formatResult: string = ''; // Format the dialed number as follows: formatResult = '0755 453'
for (let i = 0; i < phoneNumber.length; i++) {
  formatResult += phoneNumber.charAt(i);
  formatResult = typingFormat.format(formatResult);
}