vue-tel-input

International Telephone Input with Vue.

Documentation and Demo

Visit the website

Vue 3 Support

vue-tel-input@next: Guide

Changelog

Go to Github Releases

Getting started

• Install the plugin:

  npm install vue-tel-input

• Add the plugin into your app:

  import Vue from 'vue';
  import VueTelInput from 'vue-tel-input';
  import 'vue-tel-input/dist/vue-tel-input.css';
  
  Vue.use(VueTelInput);

  More info on installation

• Use the vue-tel-input component:

  <template>
    <vue-tel-input v-model="phone"></vue-tel-input>
  </template>

Installation

npm

  npm install vue-tel-input

Install the plugin into Vue:

import Vue from 'vue';
import VueTelInput from 'vue-tel-input';
import 'vue-tel-input/dist/vue-tel-input.css';

Vue.use(VueTelInput, options); // Define default global options here (optional)

View all available options in Props.

Or use the component directly:

<!-- your-component.vue-->
<template>
  <vue-tel-input v-model="value"></vue-tel-input>
</template>
<script>
  import { VueTelInput } from 'vue-tel-input';

  export default {
    components: {
      VueTelInput,
    },
  };
</script>

<style src="vue-tel-input/dist/vue-tel-input.css"></style>

Browser

<script src="https://unpkg.com/vue-tel-input"></script>
<link rel="stylesheet" href="https://unpkg.com/vue-tel-input/dist/vue-tel-input.css" />

If Vue is detected in the Page, the plugin is installed automatically.

** Otherwise, manually install the plugin into Vue:

Vue.use(window['vue-tel-input']);

Use as a custom field of vue-form-generator

• Add a component using vue-form-generator's abstractField mixin

  <!-- tel-input.vue -->
  <template>
    <vue-tel-input v-model="value"></vue-tel-input>
  </template>
  
  <script>
    import { abstractField } from 'vue-form-generator';
  
    export default {
      name: 'TelephoneInput',
      mixins: [abstractField],
    };
  </script>

• Register the new field as a global component

  import Vue from 'vue';
  import TelInput from '<path>/tel-input.vue';
  
  Vue.component('field-tel-input', TelInput);

• Now it can be used as tel-input in schema of vue-form-generator

  var schema: {
    fields: [
      {
        type: 'tel-input',
        label: 'Awesome (tel input)',
        model: 'telephone',
      },
    ],
  };

  Read more on vue-form-generator's instruction page

Component lazy loading

Since the library is about 200kb of JavaScript and 100kb of CSS in order to improve initial page loading time you might consider importing it asynchronously only when user navigates to the page where the library is actually needed. The technique is called Lazy Load and you can use it in some modern bundlers like Webpack and Rollup.

<!-- your-component.vue-->
<template>
  <vue-tel-input v-model="value"></vue-tel-input>
</template>
<script>
  const VueTelInput = () =>
    Promise.all([
      import(/* webpackChunkName: "chunk-vue-tel-input" */ 'vue-tel-input'),
      import(/* webpackChunkName: "chunk-vue-tel-input" */ 'vue-tel-input/dist/vue-tel-input.css'),
    ]).then(([{ VueTelInput }]) => VueTelInput);

  export default {
    components: {
      VueTelInput,
    },
  };
</script>

As you see, we don't use Vue SFC <style></style> tag here to import component's css as it would result in CSS going to the main/vendors bundle instead of being downloaded on demand.

Development

Clone the project

  git clone https://github.com/iamstevendao/vue-tel-input.git

Go to the project directory

  cd vue-tel-input

Install dependencies

  npm install
  cd docs && npm ci

Start the server

  npm run serve

License

Copyright (c) 2018 Steven Dao. Released under the MIT License.

made with ❤ by Steven.