ngx-lib-phone-input
Version:
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0. NgxPhoneNumberInput is an Angular library for easy integration of phone number input fields in your Angular applications.
101 lines (67 loc) • 2.29 kB
Markdown
# ngx-lib-phone-input
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0.
NgxPhoneNumberInput is an Angular library for easy integration of phone number input fields in your Angular applications.
# Live Demo
See a live example of NgxPhoneNumberInput in action on Stackblitz: [DEMO](https://stackblitz.com/~/github.com/SaqibIqbal9090/NgxPhoneNumberInput_Example)
# Installation
To install NgxPhoneNumberInput in your Angular project, you can use npm:
```sh
$ npm install ngx-lib-phone-input
```
# Dependencies
This library requires the following additional dependencies:
- country-list-json
- primeng
You can install them using npm:
```sh
$ npm install country-list-json
$ npm install primeng
```
# Style.css
The library includes styles based on PrimeNG's md-light-indigo theme. You can import it in your styles.css file:
```css
@import 'primeng/resources/themes/md-light-indigo/theme.css';
```
# Usage
### Import
1. Import the NgxPhoneNumberInputModule into your Angular module:
```ts
import { NgxPhoneNumberInputModule } from "ngx-lib-phone-input";
@NgModule({
imports: [
// ... other imports
NgxPhoneNumberInputModule
],
// ...
})
export class AppModule { }
```
2. In your component template, use the ngx-lib-phone-input component within a reactive form:
```html
<ngx-lib-phone-input formControlName="phone"></ngx-lib-phone-input>
```
# Example
### TypeScript
```ts
constructor(){ }
number:any
MyForm = new FormGroup({
phoneNumber : new FormControl('')
})
submit(){
this.number =this.MyForm.value.phoneNumber || "";
}
```
### HTML
```html
<form [formGroup]="MyForm" (submit)="submit()">
<ngx-lib-phone-input formControlName="phoneNumber"></ngx-lib-phone-input>
<button >Get Number</button>
</form>
```
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
# License
This library is licensed under the MIT License.
# Keywords
Angular, phone number input, ngx-lib-phone-input, phone input field, reactive forms