jquery.phone v1.0.4

jQuery.phone

A general purpose library for validating and formatting phone numbers.

Basic Example:

$('#phone').phone();

You can bind to an event when the user changes the country of the phone number:

$('#phone').bind('phone.country', function(e, country) {
  console.log('The new country code:', country);
});

This library is a fork from Stripe's outdated plugin.

API

$.fn.phone()

Enables phone number formatting.

$.fn.phone(options)

Enables phone number formatting, with the given options.

Available options:

• defaultPrefix: Set the default prefix, default is +1
• value: Set the default value of the input.

Example:

$('#phone').phone({
    defaultPrefix: '+44',
    value: '7700900680'
});

$.fn.phone('val')

Returns the phone number value with prefix, but without other formatting.

Example:

//=> '+1 (415) 123-5554'
$('#phone').phone('val'); //=> '+14151235554'

$.fn.phone('validate')

Returns whether the phone number is valid.

Note: this implementation is very naive; it only validates that the phone number is longer than its prefix.

Example:

//=> '+1 (415) 123-5554'
$('#phone').phone('validate'); //=> true

//=> '+43'
$('#phone').phone('validate'); //=> false

$.fn.phone('country')

Returns the two-letter country code of the phone number.

Example:

$('#phone').phone('country'); //=> 'BE'

$.fn.phone('prefix')

Returns the prefix of the phone number.

Example:

$('#phone').val(); //=> '+32 495 12 34 56'
$('#phone').phone('prefix'); //=> '+32'

$.formatPhone(phone)

Returns the formatted phone number.

Example:

$.phone.formatPhone('14151235554'); //=> '+1 (415) 123-5554'

Events

country.phone

Triggered when the country has changed.

Example:

$('#phone').bind('phone.country', function(e, country) {
  console.log('The new country code:', country);
})

// Simulate user input
$('#phone').val('+32495123456').keyup();
//=> The new country code: BE

Building

Run grunt

Mobile recommendations

We recommend you set the pattern, type, and x-autocompletetype attributes, which will trigger autocompletion and a numeric keypad to display on touch devices:

<input class="phone-num" type="tel" pattern="\d*" x-autocompletetype="tel">

You may have to turn off HTML5 validation (using the novalidate form attribute) when using this pattern, since it won't permit spaces and other characters that appear in the formatted version of the phone number.