ngx-phonenumbers
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

ngx-phonenumbers

Directive validator and service to handle phone numbers with Google libphonenumber library.

This library was generated with Angular CLI version 17.3.0.

Features

  • Standalone validator directive
  • Easy to integrate with the Angular template-driven forms
  • Parse and format phone numbers with Google libphonenumber library
  • When the phone number is valid, replace it with the formatted international number or country code plus national number. When invalid, set the 'phoneNumber' error.

Demo

View the live demo

Installation

npm install ngx-phonenumbers

Usage

1. Import the standalone directive

Add the NgxPhonenumbersDirective to your component imports. If not imported yet, add CommonModule and FormsModule.

import { CommonModule } from '@angular/common';
import { FormsModule } from '@angular/forms';
import { NgxPhonenumbersDirective } from 'ngx-phonenumbers';

@Component({
  selector: 'app-ngx-phonenumbers-page',
  standalone: true,
  template: ``,
  styles: ``,
  imports: [CommonModule, FormsModule, NgxPhonenumbersDirective],
})

2. Add the directive to your input field

You can use a single input for the full phone number:

<input type="tel" placeholder="Phone number" id="phone" name="phone" [(ngModel)]="demo.phone" ngxPhonenumber defaultCountryCode="57" type="text" #phone="ngModel" />

Or use two inputs, one for the national part of the number an other for the country code (binding it with the countryCodeControl input).

<input type="text" placeholder="+57" id="countryCode" name="countryCode" [(ngModel)]="demo.countryCode" #countryCode="ngModel" />
<input type="text" placeholder="Phone number" id="phoneWithCountry" name="phoneWithCountry" [(ngModel)]="demo.phoneWithCountry" ngxPhonenumber defaultCountryCode="+57" [countryCodeControl]="countryCode.control" #phoneWithCountry="ngModel" />

The defaultCountryCode should be the 2 letter ISO code. You can include or not the '+'.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Package Sidebar

Install

npm i ngx-phonenumbers

Weekly Downloads

7

Version

3.0.1

License

MIT

Unpacked Size

43.2 kB

Total Files

14

Last publish

Collaborators

  • quedicesebas