1.0.2 • Published 5 years ago

vue-tel-mini-input v1.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

vue-tel-mini-input

International Telephone Input (this is minified version of package vue-tel-input by Steven)

preview

Installation

  • yarn:
      yarn add vue-tel-mini-input
  • npm:
      npm i --save vue-tel-mini-input

Usage

  • Install as a global component:

    import Vue from 'vue'
    import VueTelMiniInput from 'vue-tel-mini-input'
    
    Vue.use(VueTelMiniInput)
  • In your component:

    <template>
    ...
       <vue-tel-input v-model="phone"
                      @onInput="onInput"
                      <!-- optional -->
                      :preferredCountries="['us', 'gb', 'ua']">
       </vue-tel-input>
    ...
    <template>
    <script>
    export default {
      data() {
        return {
          phone: '',
        };
      },
      methods: {
        /**
         * @param {string} number
         * the phone number inputted by user, will be formatted along with country code
         * // Ex: inputted: (AU) 0432 432 432
         * // number = '+61432421546'
         *
         * @param {Boolean} isValid
         * @param {string} country
         */
         onInput({ number, isValid, country }) {
           console.log(number, isValid, country);
         },
      },
    }
    </script>

Props

Property valueTypeDefault valueDescription
defaultCountrystring''Default country, will override the country fetched from IP address of user
disabledFetchingCountryBooleanfalseDisable fetching current country based on IP address of user
preferredCountriesArray[]Preferred countries list, will be on top of the dropdown. ie ['AU', 'BR']
disabledBooleanfalseDisable input field
placeholderstringEnter a phone numberPlaceholder for the input
requiredBooleanfalseRequired property for HTML5 required attribute

Events

Property valueArgumentsDescription
onInputObjectFires when the input changes with the argument is the object includes { number, isValid, country }
onBlurFires on blur event

Highlights & Credits

Demo Usage

# install dependencies
$ yarn/npm install

# compile demo for development
$ yarn/npm dev

# open Browser and start serve in demo
$ yarn/npm demo:open

# compile dist demo
$ yarn/npm dist:demo

# compile dist
$ yarn/npm dist

Contributors

made with by Steven and Sergey.