betsol-ng-intl-tel-input
This module for Angular.js (
^1.2.29
) provides integration
for the great intl-tel-inputintl-tel-input jQuery plugin (version 7-8 are supported).Please feel free to investigate the original pluginintl-tel-input for mode details, featuresintl-tel-input-features and configurationintl-tel-input-options.
—» DEMOdemo «—
Installation
Install integration library with npm
or Bower
npm i --save betsol-ng-intl-tel-input
bower install --save betsol-ng-intl-tel-input
Add integration library to your page
Make sure, that module is added to your page either as a part of automatically built bundle or manually using the code like this:<script src="../betsol-ng-intl-tel-input/dist/betsol-ng-intl-tel-input.js"></script>
You should use minified version (
betsol-ng-intl-tel-input.min.js
) in production.Add dependency in your application's module definition
var application = angular.module('application', [
// ...
'betsol.intlTelInput'
]);
Introduce the directive
To add the plugin to any input field please use theintl-tel-input
directive:<input type="tel" ng-model="user.phoneNumber" intl-tel-input>
Original plugin
This module depends on intl-tel-inputintl-tel-input plugin to operate. If you installed the module using npm or Bower, then the dependency will be installed automatically, and if your are using some automated build tool, it will probably be added to your bundle.In other cases make sure to install it manually using the following guideintl-tel-input-install.
Configuration
Global
You can configure the plugin by changing the global objectintlTelInputOptions
.
This will apply specified changes across all plugin instances in your application.
All configuration options could be found in the original plugin documentationintl-tel-input-options.Global Configuration Example
angular
.module('app', ['betsol.intlTelInput'])
.config(function (intlTelInputOptions) {
angular.extend(intlTelInputOptions, {
nationalMode: false,
utilsScript: '/vendor/intl-tel-input/utils.js',
defaultCountry: 'auto',
preferredCountries: ['ru', 'kz'],
autoFormat: true,
autoPlaceholder: true
});
})
;
Custom instance configuration
You can configure each input field individually by specifying the configuration options viaintl-tel-input-options
attribute.Instance Configuration Example
<input
type="tel"
ng-model="user.phoneNumber"
intl-tel-input
intl-tel-input-options="{ excludeCountries: ['us', 'de'] }"
>
API
You can useintl-tel-input-controller
attribute to specify an object
that will be populated with the directive's API functions.API Usage Example
angular
.module('app', ['betsol.intlTelInput'])
.controller('MyCtrl', function ($scope) {
$scope.myIntlTelInputCtrl;
$scope.changeCountryToRussia = function () {
$scope.myIntlTelInputCtrl.setCountry('ru');
};
})
;
<input
type="tel"
ng-model="user.phoneNumber"
intl-tel-input
intl-tel-input-controller="myIntlTelInputCtrl"
>
<button ng-click="changeCountryToRussia()">
Change Country to Russia
</button>
List of Supported API Functions:
setCountry({string} countryCode)
Phone number validator
This directive will addphoneNumber
validator to the underlying model controller.
You can use it to display validation errors.Validation Example
<span ng-show="formName.inputName.$error.phoneNumber">
Please enter a correct phone number!
</span>
Changelog
Please see the changelogchangelog for list of changes.Feedback
If you have found a bug or have another issue with the library — please create an issuenew-issue.If you have a question regarding the library or it's integration with your project — consider asking a question at StackOverflowso-ask and sending me a link via E-Mailemail. I will be glad to help.
Have any ideas or propositions? Feel free to contact me by E-Mailemail.
Cheers!
FAQ
@todoDeveloper guide
Fork, clone, create a feature branch, implement your feature, cover it with tests, commit, create a PR.Run:
npm i
to initialize the projectnpm i -g gulp
to install Gulpgulp build
to re-build the dist filesgulp test
orkarma start
to test the codegulp start
to run demo server and watchesgulp demo:deploy
to deploy the demo on GitHub Pages
Do not add dist files to the PR itself. We will re-compile the module manually each time before releasing.
Support
If you like this library consider to add star on GitHub repositoryrepo-gh.Thank you!
License
The MIT License (MIT)Copyright (c) 2016 Slava Fomin II, BETTER SOLUTIONS
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
changelog: CHANGELOG.md so-ask: http://stackoverflow.com/questions/ask?tags=angularjs,javascript email: mailto:s.fomin@betsol.ru new-issue: https://github.com/betsol/ng-intl-tel-input/issues/new gulp: http://gulpjs.com/ repo-gh: https://github.com/betsol/ng-intl-tel-input
intl-tel-input: https://github.com/jackocnr/intl-tel-input intl-tel-input-features: https://github.com/jackocnr/intl-tel-input#features intl-tel-input-options: https://github.com/jackocnr/intl-tel-input#options intl-tel-input-install: https://github.com/jackocnr/intl-tel-input#getting-started demo: http://betsol.github.io/ng-intl-tel-input/