Angular-international-phone-input NPM

International Phone Input for Angular (angularInternationalPhoneInput)

This is a fork of the original ngx-intl-tel-input by webcat12345 created to upgrade to angular 17 version due to dependency issues as the repo seemed to be unmaintained)

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.

Compatibility:

Validation with google-libphonenumber

angular-international-phone-input	Angular	ngx-bootstrap
1.x.x	14.x.x - 17.x.x	>= 12.0.0

Installation

Install Dependencies

$ npm install int-phone-input --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 'int-phone-input' style file:

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

to angular.json styles array:

"styles": [
  "./node_modules/intl-tel-input/build/css/intPhoneInput.css",
  "src/styles.css"
],

Install This Library

$ npm i angular-international-phone-input --save

Usage

Import

Add AngularInternationalPhoneModule to your module file:

imports: [
  AngularInternationalPhoneModule
]

Example

<form #f="ngForm" [formGroup]="phoneForm">
	<angular-international-phone-input
		[cssClass]="'custom'"
		[preferredCountries]="[CountryISO.UnitedStates, CountryISO.UnitedKingdom]"
		[enableAutoCountrySelect]="false"
		[enablePlaceholder]="true"
		[searchCountryFlag]="true"
		[searchCountryField]="[SearchCountryField.Iso2, SearchCountryField.Name]"
		[selectFirstCountry]="false"
		[selectedCountryISO]="CountryISO.India"
		[maxLength]="15"
		[phoneValidation]="true"
		[inputId]="my-input-id"
		name="phone"
		formControlName="phone"
	></angular-international-phone-input>
</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.