-
Notifications
You must be signed in to change notification settings - Fork 343
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #286 from pasevin/master
v 2.4.0 [id] name change and support for Angular 9
- Loading branch information
Showing
22 changed files
with
17,717 additions
and
12,973 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "indent_inner_html": true, | ||
| "indent_with_tabs": true, | ||
| "tab_size": 2, | ||
| "wrap_attributes": "force" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| # International Telephone Input for Angular (NgxIntlTelInput) | ||
|
|
||
| [](#contributors) | ||
|
|
||
| [](https://travis-ci.org/webcat12345/ngx-intl-tel-input) [](https://badge.fury.io/js/ngx-intl-tel-input) [](https://www.npmjs.com/package/ngx-intl-tel-input) | ||
|
|
@@ -18,17 +19,17 @@ An Angular package for entering and validating international telephone numbers. | |
|
|
||
| ### Install Dependencies | ||
|
|
||
| ```$ npm install [email protected] --save``` | ||
| `$ npm install [email protected] --save` | ||
|
|
||
| ```$ npm install google-libphonenumber --save``` | ||
| `$ npm install google-libphonenumber --save` | ||
|
|
||
| ```$ ng add ngx-bootstrap``` | ||
| `$ ng add ngx-bootstrap` | ||
|
|
||
| ### Add Dependency Style | ||
|
|
||
| Add *'intl-tel-input'* style file: | ||
| Add _'intl-tel-input'_ style file: | ||
|
|
||
| ```./node_modules/intl-tel-input/build/css/intlTelInput.css``` | ||
| `./node_modules/intl-tel-input/build/css/intlTelInput.css` | ||
|
|
||
| to **angular.json** styles array: | ||
|
|
||
|
|
@@ -45,21 +46,16 @@ to **angular.json** styles array: | |
|
|
||
| ### Install This Library | ||
|
|
||
| ```$ npm install ngx-intl-tel-input --save``` | ||
| `$ npm install ngx-intl-tel-input --save` | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Import | ||
|
|
||
| Add ```BsDropDownModule``` and ```NgxIntlTelInputModule``` to your module file: | ||
| Add `BsDropDownModule` and `NgxIntlTelInputModule` to your module file: | ||
|
|
||
| ```javascript | ||
|
|
||
| imports: [ | ||
| BsDropdownModule.forRoot(), | ||
| NgxIntlTelInputModule, | ||
| ] | ||
|
|
||
| imports: [BsDropdownModule.forRoot(), NgxIntlTelInputModule]; | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
@@ -69,78 +65,78 @@ Refer to main app in this repository for working example. | |
| Or this [Stackblitz Demo](https://stackblitz.com/edit/ngx-intl-tel-input-demo). | ||
|
|
||
| ```html | ||
|
|
||
| <form #f="ngForm" [formGroup]="phoneForm"> | ||
| <ngx-intl-tel-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" | ||
| [tooltipField]="TooltipLabel.Name" | ||
| [phoneValidation]="true" | ||
| [id]="my-input-id" | ||
| name="phone" | ||
| formControlName="phone"></ngx-intl-tel-input> | ||
| </form> | ||
|
|
||
| <ngx-intl-tel-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" | ||
| [tooltipField]="TooltipLabel.Name" | ||
| [phoneValidation]="true" | ||
| [inputId]="my-input-id" | ||
| name="phone" | ||
| formControlName="phone" | ||
| ></ngx-intl-tel-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``` | ```false``` | Toggle automatic country (flag) selection based on user input. | | ||
| | enablePlaceholder | ```boolean``` | ```true``` | Input placeholder text, which addapts to the country selected. | | ||
| | 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.| | ||
| | tooltipField | ```<TooltipLabel>``` | ```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. | | ||
| | id | ```string``` | ```phone``` | Unique ID for input. | | ||
| | 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. | | ||
| | 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` | `false` | Toggle automatic country (flag) selection based on user input. | | ||
| | enablePlaceholder | `boolean` | `true` | Input placeholder text, which addapts to the country selected. | | ||
| | 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. | | ||
| | tooltipField | `<TooltipLabel>` | `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 `<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``` | ||
| - Update `./projects/ngx-intl-tel-input` | ||
| - Build / test library. | ||
| - Update ```./src/app``` with new functionality. | ||
| - 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``` | ||
| - 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 localy | ||
|
|
||
| After building and creating package, you can use it localy too. | ||
|
|
||
| In your project run: | ||
|
|
||
| ```$ npm install --save {{path to your local '*.tgz' package file}}``` | ||
| `$ npm install --save {{path to your local '*.tgz' package file}}` | ||
|
|
||
| ## Contributors | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.