Package Exports

vue-country-region-select

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-country-region-select) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Vue-Country-Region-Select

Vue-Country-Region-Select provides a pair of Vue components that will allow you to easily put a country and region dropdown in your project that will work together or standalone.

Installation

npm install vue-country-region-select --save

Dependencies

Being that these are Vue components you will need to use them inside of Vue.

The Data for the countries and regions are being used from the country-region-data npm package. It can be found here: https://www.npmjs.com/package/country-region-data

Usage

Here is a sample use case of how you would use vue-country-region-select in your vue project. You can alternatively store the data in a store somewhere. Country and Region values will be returned in their short code values by default.

Ex. country: 'US' and region: 'IL'

There is a prop that will allow for country to be returned in full instead of in short code version.

The library registers the components globally so only need to import the library once in order to make the components be available throughout your project.

import Vue from 'vue'
import 'vue-country-region-select'

export default Vue.extend({
  data: () => ({
    country: '',
    region: ''
  })
})

<template>
  <country-select v-model="country" :country="country" topCountry="US" />
  <region-select v-model="region" :country="country" :region="region" />
</template>

Options

Here are the available attributes that can be used with the provided components.

<country-select />

Parameter	Required?	Default	Type	Description
v-model	yes	''	string	The data binding for your component
country	yes	''	string	Make this tied to the same piece of data as v-model
topCountry	no	''	string	By providing this value you will tell component what country to put at the top of the dropdown list for easy selection. Make sure to use country short code. So for United states you would provide 'US'. However, if you set countryName to true make sure to also write out full country name when setting a topCountry. In this scenerio United States would be 'United States'.
countryName	no	false	boolean	By setting this value to true, country names will be output in full instead of using the abbreviated short codes. Make sure to set this true for both country and region if you are using.

<region-select />

Parameter	Required?	Default	Type	Description
v-model	yes	''	string	The data binding for your component
region	yes	''	string	Make this tied to the same piece of data as v-model
country	no	''	string	This tells the component what country to grab the list of displayed regions from. To have it work in tandem with country component provide it the variable that is tied to the v-model of the country-select component.
defaultRegion	no	'US'	string	This allows you to set a default region when choosing not to use the country attribute. It will be set to regions of the United States if not provided.
countryName	no	false	boolean	Set this to true if you are setting it to true while using Country Select. This is just to help keep the data values in sync.
copiedCountry	no	''	string	Setting a country value here will cause region to not reset when it is switched via any method in which this kind of event may occur.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT