Need help with ngx-intl-tel-input?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

webcat12345
136 Stars 147 Forks MIT License 270 Commits 31 Opened issues

Description

Phone number input field to support international numbers, Angular

Services available

!
?

Need anything else?

Contributors list

# 159,164
Swift
HTML
datetim...
Angular
120 commits
# 9,140
reasonm...
Svelte
kcd-edu
fish-sh...
10 commits
# 414,228
HTML
CSS
calenda...
Angular
2 commits
# 155,518
docker-...
Maven
Gradle
HTML
2 commits
# 12,574
TypeScr...
ionic
aot
natives...
1 commit
# 43,079
sqlite3
SQL
Sass
hot-rel...
1 commit
# 400,672
in-app-...
Objecti...
Shell
Angular
1 commit
# 207,729
service...
Angular
Heroku
faceboo...
1 commit
# 80,473
Swift
Shell
viewcon...
messeng...
1 commit

International Telephone Input for Angular (NgxIntlTelInput)

All Contributors

Build Status npm version npm

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 | | ------------------ | -------------- | ------------- | | 3.x.x | 9.x.x - 10.x.x | 6.0.0 | | 2.x.x | 8.x.x - 9.1.x | 5.6.x |

Installation

Install Dependencies

$ npm install [email protected] --save

$ npm install google-libphonenumber --save

$ ng add ngx-bootstrap

Add Dependency Style

Add 'intl-tel-input' style file:

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

to angular.json styles array:

"styles": [
  "./node_modules/bootstrap/dist/css/bootstrap.min.css",
  "./node_modules/intl-tel-input/build/css/intlTelInput.css",
  "src/styles.css"
],

Install This Library

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

Usage

Import

Add

NgxIntlTelInputModule
to your module file:
imports: [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)


    


Options

| Options | Type | Default | Description | | ------------------------ | ------------------------ | --------------------------------- | ------------------------------------------------------------------------------------------------------------- | | cssClass |

string
|
control-form
| Bootstrap input css class or your own custom one. | | preferredCountries |
[]
|
[]
| List of countries, which will appear at the top. | | onlyCountries |
[]
|
[]
| List of manually selected countries, which will appear in the dropdown. | | enableAutoCountrySelect |
boolean
|
false
| 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.International
| Custom string to be inserted as a placeholder. | | searchCountryFlag |
boolean
|
false
| Enables input search box for countries in the flag dropdown. | | 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. | | tooltipField |
         | 
None
| Set tooltip on flag hover. Use
TooltipLabel
helper enum for label type options. | | 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
 element.                                                                              |
| selectedCountryISO       | 
           | 
None
| Set specific country on load. | | separateDialCode |
boolean
|
false
| Visually separate dialcode into the drop down element. | | countryChange |
              | 
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

🎨 💻 📖 🤔 💬 🚇 💡 🚧 👀 ⚠️

Aleksandr Pasevin

💻 📖 🐛 📦 🔌 💬 🚇 💡 🚧 👀 ⚠️

Dviejo

💻 🐛 💡 ⚠️ 💬 🚧 👀

Jens Wagner

💻

Kino Roy

💻

Nathan Walker

🚧 💻

Jiarong Xu

💻

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.