Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 4.63 KB

README.md

File metadata and controls

83 lines (62 loc) · 4.63 KB
Raw

IntlTelInput Vue Component

A Vue component wrapper for the intl-tel-input JavaScript plugin. View the source code.

Table of Contents

Demo

Try it for yourself by downloading the project and running npm install and then npm run vue:demo and then copy the given URL into your browser.

Getting Started

<script setup>
  import IntlTelInput from "intl-tel-input/vueWithUtils";
  import "intl-tel-input/styles";
</script>

<template>
  <IntlTelInput
    :options="{
      initialCountry: 'us',
    }"
  />
</template>

See the Validation demo for a more fleshed-out example of how to handle validation. Make sure to change the path in the package.json script to the correct demo if you're running it locally e.g.:

"vue:demo": "vite --config vue/demo/[demo variant]/vite.config.js"

A note on the utils script (~260KB): if you're lazy loading the IntlTelInput chunk (and so less worried about filesize) then you can just import IntlTelInput from "intl-tel-input/vueWithUtils", to include the utils script. Alternatively, if you use the main "intl-tel-input/vue" import, then you should couple this with the utilsScript initialisation option - you will need to host the utils.js file, and then set the utilsScript option to that URL, or alternatively just point it to a CDN hosted version e.g. "https://cdn.jsdelivr.net/npm/[email protected]/build/js/utils.js".

Props

Here's a list of all of the current props you can pass to the IntlTelInput Vue component.

disabled
Type: Boolean, Default: false
Sets the disabled attribute of both the telephone input and selected country button. Note: we recommend using this instead of inputProps.disabled.

inputProps
Type: Object
The props to pass to the input element e.g. id, class, placeholder, required, onBlur etc. Note: we recommend using the separate disabled prop instead of inputProps.disabled.

options
Type: Object
An object containing the initialisation options to pass to the plugin. You can use these exactly the same way as with the main JavaScript plugin.

value
Type: String
The initial value to put in the input. This will get auto-formatted on init (according to formatOnDisplay initialisation option). IntlTelInput is an uncontrolled input, and so will ignore any changes to this value.

Events

Here's a list of all of the current events you can listen to on the IntlTelInput Vue component.

changeCountry
Type: Function
A handler to be called when the selected country changes. It will be passed the new country iso2 code e.g. "gb" for UK.

changeErrorCode
Type: Function
A handler to be called when the number validation error changes. It will be passed the new error code (or null).

changeNumber
Type: Function
A handler to be called when the number changes. It will be passed the new number.

changeValidity
Type: Function
A handler to be called when the number validity changes e.g. to true/false. It will be passed the new isValid boolean.

Accessing Instance Methods

You can access all of the plugin's instance methods (setNumber, setCountry, setPlaceholderNumberType etc) by passing a ref into the IntlTelInput component (using the ref prop), and then calling ref.intlTelInput.instance e.g. ref.intlTelInput.instance.setNumber(...);. See the Set Number demo for a full example. You can also access the input DOM element in a similar way: ref.intlTelInput.input.

Accessing Static Methods

You can access all of the plugin's static methods by importing intlTelInput from the same file as the Vue component e.g. import { intlTelInput } from "intl-tel-input/vue" (note the lower case "i" in "intlTelInput"). You can then use this as you would with the main plugin e.g. intlTelInput.getCountryData() or intlTelInput.utils.numberType etc.