International Telephone Input for Angular Material (NgxMatIntlTelInput)

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.

Supports:

• Angular 17
• Angular Material 17
• ReactiveFormsModule
• FormsModule
• Validation with libphonenumber-js

Installation

Install Dependencies

$ npm install libphonenumber-js --save

Install This Library

$ npm install ngx-mat-intl-tel-input-v16 --save

Usage

Import

Add NgxMatIntlTelInputComponent to your component file:

1imports: [NgxMatIntlTelInputComponent];

Example

Refer to main app in this repository for working example.

1<form #f="ngForm" [formGroup]="phoneForm">
2  <ngx-mat-intl-tel-input
3    [preferredCountries]="['us', 'gb']"
4    [enablePlaceholder]="true"
5    [enableSearch]="true"
6    name="phone"
7    describedBy="phoneInput"
8    formControlName="phone"
9  ></ngx-mat-intl-tel-input>
10</form>

1
2<form #f="ngForm" [formGroup]="phoneForm">
3  <ngx-mat-intl-tel-input
4  [preferredCountries]="['us', 'gb']"
5  [enablePlaceholder]="true"
6  [enableSearch]="true"
7  name="phone"
8  (countryChanged)="yourComponentMethodToTreatyCountryChangedEvent($event)" // $event is a instance of current select Country
9  formControlName="phone"></ngx-mat-intl-tel-input>
10</form>
11

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

1<form #f="ngForm" [formGroup]="phoneForm">
2  <ngx-mat-intl-tel-input
3    [preferredCountries]="['us', 'gb']"
4    [onlyCountries]="['us', 'gb', 'es']"
5    [enablePlaceholder]="true"
6    name="phone"
7    formControlName="phone"
8    #phone
9  ></ngx-mat-intl-tel-input>
10  <mat-hint>e.g. {{phone.selectedCountry.placeHolder}}</mat-hint>
11  <mat-error *ngIf="f.form.controls['phone']?.errors?.required"
12    >Required Field</mat-error
13  >
14  <mat-error *ngIf="f.form.controls['phone']?.errors?.validatePhoneNumber"
15    >Invalid Number</mat-error
16  >
17</form>

Options

| Options | Type | Default | Description | | ------------------ | ---------- | ----------- | ----------------------------------------------------------------------------------- | --- | | preferredCountries | string[] | [] | List of country abbreviations, which will appear at the top. | | onlyCountries | string[] | [] | List of manually selected country abbreviations, which will appear in the dropdown. | | | inputPlaceholder | string | undefined | Placeholder for the input component. | | enablePlaceholder | boolean | true | 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 | | describedBy | string | undefined | Use aria-described by with the input field |

Library Contributions

• Fork repo.
• Go to ./projects/ngx-mat-intl-tel-input
• Update ./src/lib with new functionality.
• Update README.md
• Pull request.

Helpful commands

• Build lib: $ npm run build_lib
• Copy license and readme files: $ npm run copy-files
• Create package: $ npm run npm_pack
• Build lib and create package: $ npm run package

Use locally

After building and creating package, you can use it locally too.

In your project run:

$ npm install --save {{path to your local '*.tgz' package file}}