npmpackage.info

ngx-intl-tel-input

Phone number input field to support international numbers, Angular

16.0.0

215

MIT

TypeScript

11.89 kB

5,254,678 3.8

Installations

npm install ngx-intl-tel-input

Developer Guide

BETA

Typescript

No

Module System

ESM

Node Version

20.18.0

NPM Version

10.8.2 Pull Requests

Open

14

Total

270

Closed

82

Merged

174

Issues

Open

93

Total

278

Closed

185

Releases

Move angular support to 14

v3.0.1

Published on 24 Nov 2022

v3.x.x -> Angular 9.x.x - 10.x.x

v3.0.0

Published on 06 Sept 2020

v2.x.x -> Angular 8.x.x - 9.1.x

v2.5.0

Published on 06 Sept 2020

Fixes: Cannot read property 'querySelector' of undefined

2.4.2

Published on 19 Jun 2020

ReadMe update to reflect Angular 9 support.

2.4.1

Published on 08 Jun 2020

[id] name change and support for Angular 9

2.4.0

Published on 08 Jun 2020

View all 6 releases

Contributors

View all 27 contributors

Languages

TypeScript

HTML

CSS

JavaScript

TypeScript (82.1%)

HTML (7.59%)

CSS (5.37%)

JavaScript (4.93%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

webcat12345

Download Statistics

Total Downloads

5,254,678

Last Day

148

Last Week

148

Last Month

60,071

Last Year

1,112,651

GitHub Statistics

215 Stars

425 Commits

343 Forks

13 Watching

8 Branches

27 Contributors

Bundle Size

42.23 kB

Minified

11.89 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

16.0.0

Package Id

ngx-intl-tel-input@16.0.0

Unpacked Size

382.56 kB

Size

94.05 kB

File Count

NPM Version

10.8.2

Node Version

20.18.0

Publised On

03 Feb 2025

Total Downloads

Cumulative downloads

Total Downloads

5,254,678

Last day

148

Compared to previous day

Last week

-98.7%

148

Compared to previous week

Last month

-23.5%

60,071

Compared to previous month

Last year

-23.3%

1,112,651

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

tslib

Peer Dependencies

@angular/core ngx-bootstrap @angular/forms intl-tel-input @angular/common google-libphonenumber

Versions

International Telephone Input for Angular (NgxIntlTelInput)

An Angular 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.

alt

Compatibility:

Validation with google-libphonenumber

ngx-intl-tel-input	Angular	ngx-bootstrap
15.x.x	>= 15.x.x	>= 10.0.0
14.x.x	12.x.x - 14.x.x	>= 6.0.0
13.x.x	12.x.x - 13.x.x	>= 6.0.0
3.2.1	12.x.x - 13.x.x	>= 6.0.0
3.1.3	8.x.x - 11.x.x	6.0.x
2.x.x	8.x.x - 9.1.x	5.6.x

Installation

Install Dependencies

$ npm install intl-tel-input@19 --save

$ npm install google-libphonenumber --save

$ ng add ngx-bootstrap

If you do not wish to use Bootstrap's global CSS, we now package the project with only the relevant bootstrap styling needed for the dropdown. As such, you can remove the bootstrap styling from angular.json.

Further, Angular CLI should tree-shake the rest of Ngx-Boostrap away if you don't utilize other dependencies from the bootstrap package. This should keep this dependency a lean feature-add

Add Dependency Style

Add 'intl-tel-input' style file:

./node_modules/intl-tel-input/build/css/intlTelInput.css

to angular.json styles array:

1
2"styles": [
3  "./node_modules/intl-tel-input/build/css/intlTelInput.css",
4  "src/styles.css"
5],
6

Install This Library

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

Usage

Import

Add NgxIntlTelInputModule to your module file:

1imports: [NgxIntlTelInputModule];

Example

Refer to main app in this repository for working example.

Or this:

Stackblitz Demo (Angular 8)

Stackblitz Demo (Angular 9)

Stackblitz Demo (Angular 10)

Stackblitz Demo (Angular 11)

Stackblitz Demo (Angular 12)

1<form #f="ngForm" [formGroup]="phoneForm">
2  <ngx-intl-tel-input
3    [cssClass]="'custom'"
4    [preferredCountries]="[CountryISO.UnitedStates, CountryISO.UnitedKingdom]"
5    [enableAutoCountrySelect]="false"
6    [enablePlaceholder]="true"
7    [searchCountryFlag]="true"
8    [searchCountryField]="[SearchCountryField.Iso2, SearchCountryField.Name]"
9    [selectFirstCountry]="false"
10    [selectedCountryISO]="CountryISO.India"
11    [maxLength]="15"
12    [phoneValidation]="true"
13    [inputId]="my-input-id"
14    name="phone"
15    formControlName="phone"
16  ></ngx-intl-tel-input>
17</form>

Options

Options	Type	Default	Description
cssClass	`string`	`control-form`	Bootstrap input css class or your own custom one.
preferredCountries	`<CountryISO>[]`	`[]`	List of countries, which will appear at the top.
onlyCountries	`<CountryISO>[]`	`[]`	List of manually selected countries, which will appear in the dropdown.
enableAutoCountrySelect	`boolean`	`true`	Toggle automatic country (flag) selection based on user input.
enablePlaceholder	`boolean`	`true`	Input placeholder text, which adapts to the country selected.
customPlaceholder	`string`	`None`	Custom string to be inserted as a placeholder.
numberFormat	`<PhoneNumberFormat>`	`PhoneNumberFormat.International`	Custom string to be inserted as a placeholder.
searchCountryFlag	`boolean`	`false`	Enables input search box for countries in the flag dropdown.
searchCountryField	`<SearchCountryField>[]`	`[SearchCountryField.All]`	Customize which fields to search in, if `searchCountryFlag` is enabled. Use `SearchCountryField` helper enum.
searchCountryPlaceholder	`string`	`'Search Country'`	Placeholder value for `searchCountryField`
maxLength	`number`	`None`	Add character limit.
selectFirstCountry	`boolean`	`true`	Selects first country from `preferredCountries` if is set. If not then uses main list.
phoneValidation	`boolean`	`true`	Disable phone validation.
inputId	`string`	`phone`	Unique ID for `<input>` element.
selectedCountryISO	`<CountryISO>`	`None`	Set specific country on load.
separateDialCode	`boolean`	`false`	Visually separate dialcode into the drop down element.
countryChange	`<Country>`	`None`	Emits country value when the user selects a country from the dropdown.

Supported Formats

Following formats are supported

NATIONAL // Produces "044 668 18 00"
INTERNATIONAL // Produces "+41 44 668 18 00"
E164 // Produces "+41446681800"

Library Contributions

Fork repo.
Update ./projects/ngx-intl-tel-input
Build / test library.
Update ./src/app 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}}

Contributors

Thanks goes to these wonderful people (emoji key):

_{webcat_black} 🎨 💻 📖 🤔 💬 🚇 💡 🚧 👀 ⚠️	_{Chris McKnight} 💬 💻 📖 🤔 🚇 🔌 👀 🔧	_{Aleksandr Pasevin} 💻 📖 🐛 📦 🔌 💬 🚇 💡 🚧 👀 ⚠️	_Dviejo 💻 🐛 💡 ⚠️ 💬 🚧 👀	_{Kino Roy} 💻	_{Nathan Walker} 🚧 💻	_{Jiarong Xu} 💻
_{Corbin Crutchley} 💻	_{Nayeli Beckham} 💻 📦 💬 🚧	_{Rushabh Vora} 💻	_{Karim Tayie} 💻	_{Adil Khalil} 💻	_{Alice Zhao} 💻	_{Felipe Céspedes} 💻
_bb-sonam 💻	_{Alex Kulagin} 💻	_{Subodh Kumar Yadav} 💻	_{harshalganbote} 💻	_{christianopaets} 💻	_{Victor Velechovsky} 💻	_Heo 💻
_{Martin DONADIEU} 💻 📓	_Nico 💻 📖 📦 📓	_zaizac 💻 👀	_nicolasleb 💻 🚧 📦 👀 📓	_jlj 💻 📓 🐛	_{Ahmed Asif} 🐛 💻	_snmhinge 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.8

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to ngx-intl-tel-input

@andela-dev/ngx-intl-tel-input

2.0.7

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)

ngx-mat-intl-tel-input

5.0.0

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.

ngx-intl-tel-input-gg

1.0.12

Forked from https://github.com/webcat12345/ngx-intl-tel-input

ngx-mat-input-tel

19.0.0