2.0.8 • Published 2 years ago

vue-country-dropdown v2.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

This is a forked repository. The original repo is here. I'm just added some new features.

Vue Country Dropdown

Country selection dropdown for vue 2.

Demo

https://vue-country-dropdown.deta.dev/

Installation

  • yarn:
      yarn add vue-country-dropdown
  • npm:
      npm i --save vue-country-dropdown

Usage

  • Install as a global component:

    import Vue from "vue";
    import VueCountryDropdown from "vue-country-dropdown";
    
    Vue.use(VueCountryDropdown);
  • Or use in a specific component

    import VueCountryDropdown from 'vue-country-dropdown'
    
    export default {
      components: {
        VueCountryDropdown
      }
    }
  • In your component:

    <template>
    ...
      <vue-country-dropdown
        @onSelect="onSelect"
        <!-- example props -->
        :preferredCountries="['TR', 'US', 'GB']">
        :disabledFetchingCountry="true"
        :defaultCountryByAreaCode="90"
        :immediateCallSelectEvent="true"
        :enabledFlags="true"
        :enabledCountryCode="true"
        :showNameInput="true"
        :showNotSelectedOption="true"
        :notSelectedOptionText="'Not Selected'"
      </vue-country-dropdown>
    ...
    <template>
    <script>
    export default {
      methods: {
         onSelect({name, iso2, dialCode}) {
           console.log(name, iso2, dialCode);
         },
      },
    }
    </script>
  • Manual Trigger:

    <template>
    ...
      <vue-country-dropdown
        ref="vcd"
        @onSelect="onSelect"
      </vue-country-dropdown>
      <button @click="manualTrigger">Manual Trigger</button>
    ...
    <template>
    <script>
    export default {
      methods: {
         onSelect({name, iso2, dialCode}) {
           console.log(name, iso2, dialCode);
         },
         manualTrigger() {
           this.$refs.vcd.manualDropdown();
         }
      },
    }
    </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
enabledFlagsBooleantrueEnable flags in the input
enabledCountryCodeBooleanfalseEnable country code in the input
showNameInputBooleanfalseShows the name of the selected country
preferredCountriesArray[]Preferred countries list, will be on top of the dropdown. ie ['AU', 'BR']
onlyCountriesArray[]List of countries will be shown on the dropdown. ie ['AU', 'BR']
ignoredCountriesArray[]List of countries will NOT be shown on the dropdown. ie ['AU', 'BR']
dropdownOptionsObject{ disabledDialCode: false }Options for dropdown, supporting disabledDialCode
defaultCountryByAreaCodeNumber0Same as default country option. finds the default country from list by area code.
showNotSelectedOptionBooleanfalseThe Not Selected option is added to the top of the list. The Iso2 and area code value are empty.
notSelectedOptionTextStringNot SelectedReplace Not Selected text with another string.
immediateCallSelectEventBooleantrueCall the onSelect event when the component is mounted.

Events

Property valueArgumentsDescription
onSelectObjectFires when the input changes with the argument is the object includes { name, iso2, dialCode }

Highlights & Credits

Demo Usage

# install dependencies
$ yarn/npm install

# compile demo and start serve for development
$ yarn/npm dev

# build
$ yarn/npm build

Made by Mon. Forked and updated by Ahmet ALTUN.