npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mat-tel-input

v19.0.5-0

Published

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.

Downloads

624

Readme

International Telephone Input for Angular Material (mat-tel-input)

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.

npm version NPM npm bundle size npm

Caution

This is a fork from the ngx-mat-intl-tel-input library whish does not seems to be maintained anymore. Last commit is over a year

Supports:

  • Angular v19
  • Angular Material v19
  • ReactiveFormsModule
  • FormsModule
  • Validation with libphonenumber-js

Installation

Install This Library

$ npm i mat-tel-input@latest

Install Dependencies Optional

$ npm i libphonenumber-js@latest

Usage

Import

Add MatTelInput to your component file:

imports: [MatTelInput];

Example

Refer to main app in this repository for working example.

<mat-form-field [floatLabel]="'always'">
  <mat-label>Phone</mat-label>
  <mat-tel-input [preferredCountries]="['us', 'tz']" [enablePlaceholder]="true" [enableSearch]="true" name="phone" describedBy="phoneInput" formControlName="phone" />
</mat-form-field>

<mat-form-field [floatLabel]="'always'">
  <mat-label>Phone</mat-label>
  <mat-tel-input
    [preferredCountries]="['us', 'gb']"
    [enablePlaceholder]="true"
    [enableSearch]="true"
    name="phone"
    autocomplete="tel"
    (countryChanged)="yourComponentMethodToTreatyCountryChangedEvent($event)" // $event is a instance of current select Country
    formControlName="phone"
  />
</mat-form-field>

If you want to show the sample number for the country selected or errors , use mat-hint anf mat-error as

<mat-form-field [floatLabel]="'always'">
  <mat-label>Phone</mat-label>
  <mat-tel-input [preferredCountries]="['us', 'tz']" [enablePlaceholder]="true" [enableSearch]="true" name="phone" describedBy="phoneInput" formControlName="phone" />
  <mat-hint>e.g. {{phone.selectedCountry.placeHolder}}</mat-hint>
  <mat-error *ngIf="f.form.controls['phone']?.errors?.required">Required Field</mat-error>
  <mat-error *ngIf="f.form.controls['phone']?.errors?.validatePhoneNumber">Invalid Number</mat-error>
</mat-form-field>

Inputs

| Options | Type | Default | Description | | ------------------ | ---------- | ------------ | ----------------------------------------------------------------------------------- | | enablePlaceholder | boolean | false | Input placeholder text, which adapts to the country selected. | | enableSearch | boolean | false | Whether to display a search bar to help filter down the list of countries | | format | string | default | Format of "as you type" input. Possible values: national, international, default | | placeholder | string | undefined | Placeholder for the input component. | | maxLength | number | 15 | max length of the input. | | onlyCountries | string[] | [] | List of manually selected country abbreviations, which will appear in the dropdown. | | preferredCountries | string[] | [] | List of country abbreviations, which will appear at the top. | | resetOnChange | boolean | false | Reset input on country change | | searchPlaceholder | string | Search ... | Placeholder for the search input |

Outputs

| Options | Type | Default | Description | | -------------- | ----------------------- | ----------- | ----------------- | | countryChanged | EventEmitter<Country> | undefined | On country change |

Css variable

| Name | Default | Explanation | | ------------------------------------- | -------------- | ----------------------------------------------------------------------------- | | --mat-tel-input-opacity | 1 | If you wish both, the country flag and the placeholder to be shown by default | | --mat-tel-input-selector-opacity | 1 | If you wish the country flag to be shown by default | | --mat-tel-input-placeholder-opacity | 1 | If you wish the placeholder flag to be shown by default | | --mat-tel-input-flag-display | inline-block | If you wish to hide the country flag |

Validator

In case you had to manually remove the validator, the library exported it so you could add it back again.

| Name | Description | Example | | ---------------------- | ----------------------------------------------- | ---------------------------------------------------- | | matTelInputValidator | The actual phone validator used for the control | phoneControl.addValidators([matTelInputValidator]) |

Library Contributions

  • Fork repo.
  • Go to ./libs/mat-tel-input
  • Update ./src/lib with new functionality.
  • Update README.md
  • Pull request.

Helpful commands

  • Copy license and readme files: $ npm run copy-files
  • Publish package: $ npm run publish

Authors and acknowledgment