Methods

Programmatically close the country selector. Useful for closing it in response to custom events (e.g. a scroll on an ancestor container that the library doesn’t otherwise know about).

iti.closeCountrySelector();

Remove the core library from the input, and unbind any event listeners.

iti.destroy();

Get the extension from the current number. Requires the utils script to be loaded.

const extension = iti.getExtension();

For example, if the input value was "(702) 555-5555 ext. 1234", this would return "1234".

Get the current number in the given NumberFormat (defaults to "E164"). Requires the utils script to be loaded. Note that this is independent of numberDisplayFormat — it always returns the requested format. Also note that this method expects a valid number, and so should only be used after validation.

const number = iti.getNumber(); // defaults to "E164" e.g. "+17024181234"
// or
const number = iti.getNumber("INTERNATIONAL"); // e.g. "+1 702-418-1234"

Get the NumberType (fixed-line/mobile/toll-free, etc) of the current number, or null if it can’t be determined. Requires the utils script to be loaded.

const numberType = iti.getNumberType();
if (numberType === "MOBILE" || numberType === "FIXED_LINE_OR_MOBILE") {
    // is (or could be) a mobile number
}

Get the currently selected Country, or else null if no country is currently selected (e.g. the empty/globe state). Note: previously named getSelectedCountryData.

const country = iti.getSelectedCountry();

Get more information about an invalid number — returns a ValidationError string, or null if it can’t be determined. See Show a user-facing error message for a worked example. Requires the utils script to be loaded.

(Note: only returns true for valid mobile and fixed_line numbers by default - see allowedNumberTypes)
Check if the current number is valid based on its length - see example, which should be sufficient for most use cases. See isValidNumberPrecise (advanced) for more precise validation, but the advantage of isValidNumber is that it is much more future-proof, as while countries around the world regularly update their number rules, they rarely change their number lengths. If this method returns false, you can use getValidationError to get more information. Requires the utils script to be loaded. Note: previously named isPossibleNumber.

const isValid = iti.isValidNumber();

Returns: true/false

⚠️ ADVANCED
(Note: only returns true for valid mobile and fixed_line numbers by default - see allowedNumberTypes)
Check if the current number is valid using precise matching rules for each country/area code, etc - see example. Note that these rules change each month for various countries around the world, so you need to constantly keep the package up-to-date (e.g. via an automated script) else you will start rejecting valid numbers. For a simpler and more future-proof form of validation, see isValidNumber above. If validation fails, you can use getValidationError to get more information. Requires the utils script to be loaded.

const isValid = iti.isValidNumberPrecise();

Returns: true/false

Programmatically open the country selector. Useful for opening it in response to a custom UI event.

iti.openCountrySelector();

Updates the disabled attribute of both the telephone input and the selected country button. Accepts a boolean value. Use this instead of updating the input’s disabled attribute directly, as this disables the country button too.

iti.setDisabled(true);

Insert a number, and update the selected country accordingly. If the utils script is loaded, the inserted value is formatted according to the numberDisplayFormat option.

iti.setNumber("+447733123456");

Change the placeholderNumberType option — see NumberType for the valid values. We strongly recommend sticking to "MOBILE", "FIXED_LINE", or "FIXED_LINE_OR_MOBILE" — these are the only types with an example number for every country (see placeholderNumberType for details).

iti.setPlaceholderNumberType("FIXED_LINE");

Updates the readonly attribute of the telephone input and disables the selected country button. Accepts a boolean value. Use this instead of updating the input’s readonly attribute directly, as this disables the country button too.

iti.setReadonly(true);

Change the selected country by passing the relevant iso2 code, or omit the iso2 code to set it to empty (globe) state. It should be rare, if ever, that you need to do this, as the selected country gets updated automatically when calling setNumber and when passing a number with an international dial code, which is the recommended usage. If the utils script is loaded, the input value is reformatted to the new country according to the numberDisplayFormat option. Note: previously named setCountry.

iti.setSelectedCountry("gb");

An alternative to the loadUtils option (which loads the utils.js script at initialisation time), this method allows you to load the utils at your time of choosing. See Loading The Utils Script for more information. A Promise object is returned so you can await it to know when it’s finished.

const loadUtils = () => import("/dist/js/utils.js");
await intlTelInput.attachUtils(loadUtils);
// you can now call methods that use utils

Retrieve the core library’s full list of countries — either to re-use elsewhere (e.g. to generate your own country selector), or alternatively, you could use it to modify the country data. Note that any modifications must be done before initialising the core library. See Country for the shape of each entry. Note: previously named getCountryData.

const countries = intlTelInput.getAllCountries();

After initialising the core library, you can always access the instance again using this method, by just passing in the relevant input element.

const input = document.querySelector('#phone');
const iti = intlTelInput.getInstance(input);
iti.isValidNumber(); // etc