v-phone-number

Phone number form input visually compatible with Vuetify projects running on Vue 2.x. Allows users to enter in their phone number in their localized, native format while giving your app an E164 formatted string suitable for SMS and VoIP APIs.

Demo

Requirements

Proven with the following minimum versions of Vue and Vuetify.

• vue ^2
• vuetify ^2

Installation

npm i -s v-phone-number

Add the component as normally to use in a single component or view

import VPhoneNumber from 'v-phone-number';
// ...
export default {
  components: {
    VPhoneNumber,
    // ..
  },
};

To add v-phone-number to the entire app, register the component in either plugins/vuetify.js or directly in main.js

import VPhoneNumber from 'v-phone-number';
// ...
Vue.component('v-phone-number', VPhoneNumber);

Usage

<v-phone-number label="Phone Number" v-model="phoneNumber" />

Props

Most v-text-field props but not:

• counter
• counter-value
• hide-spin-buttons
• rules (use landline, mobile, required and strict)
• type (hard-coded to tel for optimal mobile experience)

The following props are enabled, but will make the input look bad unless you turn off the country selector or dig in with some unscoped CSS to support your use case (see "Advanced" below).

• height
• filled, label, placeholder, and persistent-placeholder simulataneously
• prefix
• reverse
• solo-inverted
• suffix

Additionally the following phone-specific properties are available.

Events

All v-text-field events and:

Slots

Most v-text-field slots but not:

• counter
• prepend-inner while disable-country-select is false
• progress

Advanced

This project uses BEM (Block Element Modifier) class hierarchy for its components, allowing for precise control over the appearance of this input should the default Vuetify style defaults be found wanting. The block is v-phone-number, and contains the following elements:

• country-code
• country-code-display
• country-code-search
• country-list
• number-input

There are no modifiers to these classes.