International Telephone Input for Angular Material (ngxMatInputTel)

An Angular Material package for entering and validating international telephone numbers. It adds a flag dropdown to any input, detects the user's country, displays a relevant placeholder and provides formatting/validation methods.

NPM npm bundle size npm

Demo

https://stackblitz.com/~/github.com/rbalet/ngx-mat-input-tel

Caution

This is a fork from the ngx-mat-intl-tel-input library whish does not seems to be maintained anymore. Last commit is over a year

Supports:

Angular >=15
Angular Material >=15
Validation with libphonenumber-js

Installation

Install This Library

$ npm i ngx-mat-input-tel@latest

Install Dependencies Optional

$ npm i libphonenumber-js@latest

Usage

Import

Add NgxMatInputTelComponent to your component file:

imports: [NgxMatInputTelComponent];

Example

Refer to main app in this repository for working example.

<form #f="ngForm" [formGroup]="phoneForm">
  <ngx-mat-input-tel
    [preferredCountries]="['us', 'gb']"
    [enablePlaceholder]="true"
    [enableSearch]="true"
    name="phone"
    describedBy="phoneInput"
    formControlName="phone"
  ></ngx-mat-input-tel>
</form>

<form #f="ngForm" [formGroup]="phoneForm">
  <ngx-mat-input-tel
  [preferredCountries]="['us', 'gb']"
  [enablePlaceholder]="true"
  [enableSearch]="true"
  name="phone"
  autocomplete="tel"
  (countryChanged)="yourComponentMethodToTreatyCountryChangedEvent($event)" // $event is a instance of current select Country
  formControlName="phone"></ngx-mat-input-tel>
</form>

If you want to show the sample number for the country selected or errors , use mat-hint anf mat-error as

<form #f="ngForm" [formGroup]="phoneForm">
  <ngx-mat-input-tel
    [preferredCountries]="['us', 'gb']"
    [onlyCountries]="['us', 'gb', 'es']"
    [enablePlaceholder]="true"
    name="phone"
    autocomplete="tel"
    formControlName="phone"
    #phone
  ></ngx-mat-input-tel>
  <mat-hint>e.g. {{phone.selectedCountry.placeHolder}}</mat-hint>
  <mat-error *ngIf="f.form.controls['phone']?.errors?.required"
    >Required Field</mat-error
  >
  <mat-error *ngIf="f.form.controls['phone']?.errors?.validatePhoneNumber"
    >Invalid Number</mat-error
  >
</form>

Inputs

Options	Type	Default	Description
enablePlaceholder	`boolean`	`false`	Input placeholder text, which adapts to the country selected.
enableSearch	`boolean`	`false`	Whether to display a search bar to help filter down the list of countries
format	`string`	`default`	Format of "as you type" input. Possible values: national, international, default
placeholder	`string`	`undefined`	Placeholder for the input component.
maxLength	`number`	`15`	max length of the input.
onlyCountries	`string[]`	`[]`	List of manually selected country abbreviations, which will appear in the dropdown.
preferredCountries	`string[]`	`[]`	List of country abbreviations, which will appear at the top.
resetOnChange	`boolean`	`false`	Reset input on country change
searchPlaceholder	`string`	`Search ...`	Placeholder for the search input
validation	`isPossible` \| `isValid`	`isValid`	Change the validation type

Outputs

Options	Type	Default	Description
countryChanged	`EventEmitter<Country>`	`undefined`	On country change

Css variable

Name	Default	Explanation
`--ngxMatInputTel-opacity`	`0`	If you wish both, the country flag and the placeholder to be shown by default
`--ngxMatInputTel-selector-opacity`	`0`	If you wish the country flag to be shown by default
`--ngxMatInputTel-placeholder-opacity`	`0`	If you wish the placeholder flag to be shown by default
`--ngxMatInputTel-flag-display`	`inline-block`	If you wish to hide the country flag