README.md
# ARCHIVED - angular-libphonenumber - [AngularJS](http://angularjs.org/) input masks for phone numbers
ARCHIVAL NOTE - This library was written for Angular 1, which goes EOL at the end of this year. Also, I've been so out of the UI programming game for so long, I wouldn't know if this worked anyways.
| Info | Badges |
| ------------- | ------------- |
| Version | [![Bower version][bower-image]][bower-url] [![NPM version][npm-image]][npm-url] |
| License | [![Apache license][license-image]][license-url] |
| Testing | [![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url] |
| Quality | [![Dependencies status][dep-status-image]][dep-status-url] [![Code Climate][code-climate-image]][code-climate-url] |
[](https://saucelabs.com/u/alibphonenumber)
## Description
angular-libphonenumber is an angular directive that can be used as an input mask.
By default, all numbers are formatted in US format, but the format can be set with
the `country-code` descriptor. It uses
[nathanhammond/libphonenumber](https://github.com/nathanhammond/libphonenumber) as a formatter
for phone number's, which calls
[Google's libphonenumber](https://github.com/googlei18n/libphonenumber)
to format numbers as you type them.
View a [demo here](https://run.plnkr.co/plunks/k32xZLSRS47w6TW3auAF/)
## Installation
Using [Bower](http://bower.io/):
```
bower install --save angular-libphonenumber
```
You then must decide what version of libphonenumber you want. There are two included, and you must
include _one_ of them in your application *before* angular-libphonenumber:
- dist/libphonenumber.js - only includes the libphonenumber code needed for typeahead to work
- dist/libphonenumber.full.js - includes all libphonenumber functionality _including_ typeahead
```html
<!-- Use either -->
<script src="./<path_to_bower_components>/angular-libphonenumber/dist/libphonenumber.full.js" />
<!-- OR -->
<script src="./<path_to_bower_components>/angular-libphonenumber/dist/libphonenumber.js" />
<!-- THEN -->
<script src="./<path_to_bower_components>/angular-libphonenumber/dist/angular-libphonenumber.min.js" />
```
Then include it in your angular application:
```javascript
angular.module('myModule', ['cwill747.phonenumber']);
```
## How to Use
- You need to get the user's country code from somewhere. Where you do that is up to you (setting,
local storage, angular-translate, or just another input box):
```html
<input type="text" ng-model="countrycode" />
```
- Then you just apply the input mask to any input box:
```html
<input type="text" ng-model="phoneNumber" phone-number country-code="countrycode" />
```
## Support
If you are having any questions or issues getting things to work, you can:
* Ask a question in [stackoverflow](http://stackoverflow.com/) under the [angular-libphonenumber](http://stackoverflow.com/questions/tagged/angular-libphonenumber) tag.
Project's issue on GitHub should be used discuss bugs and features.
## Contributing to the project
We welcome any contributions to the project. Please check the [CONTRIBUTING.md](.github/CONTRIBUTING.md) for contribution guidelines.
Check out our contributors [here](https://github.com/cwill747/angular-libphonenumber/graphs/contributors)
### Development
#### Prepare your environment
* Install [Node.js](http://nodejs.org/) and NPM (should come with)
* Install global dev dependencies: `npm install -g gulp karma`
* Install local dev dependencies: `npm install` while current directory is angular-libphonenumber repo
#### Build
* Build the whole project: `gulp` - this will run `jshint`, `test`, and `build` targets
### Release
* Use GitHub's release tool to draft and publish a release. I like the format better than
changelogs.
[bower-image]: https://img.shields.io/bower/v/angular-libphonenumber.svg?style=flat-square
[bower-url]: http://bower.io/search/?q=angular-libphonenumber
[npm-image]: https://img.shields.io/npm/v/angular-libphonenumber.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/angular-libphonenumber
[build-image]: http://img.shields.io/travis/cwill747/angular-libphonenumber.svg?style=flat-square
[build-url]: https://travis-ci.org/cwill747/angular-libphonenumber
[dep-status-image]: https://img.shields.io/david/cwill747/angular-libphonenumber.svg?style=flat-square
[dep-status-url]: https://david-dm.org/cwill747/angular-libphonenumber
[coverage-image]: https://img.shields.io/coveralls/cwill747/angular-libphonenumber.svg?style=flat-square
[coverage-url]: https://coveralls.io/r/cwill747/angular-libphonenumber?branch=master
[code-climate-image]: https://img.shields.io/codeclimate/github/cwill747/angular-libphonenumber.svg?style=flat-square
[code-climate-url]: https://codeclimate.com/github/cwill747/angular-libphonenumber
[license-image]: http://img.shields.io/badge/license-Apachev2-blue.svg?style=flat-square
[license-url]: http://www.apache.org/licenses/LICENSE-2.0