vue-country-region-select
Advanced tools
Comparing version 1.0.3 to 1.0.4
{ | ||
"name": "vue-country-region-select", | ||
"version": "1.0.3", | ||
"version": "1.0.4", | ||
"description": "A Country select component and Region select component for Vue.js. Work together and standalone.", | ||
@@ -5,0 +5,0 @@ "repository": "https://github.com/gehrj/vue-country-region-select", |
@@ -15,6 +15,8 @@ # Vue-Country-Region-Select ![CI status](https://img.shields.io/badge/build-passing-brightgreen.svg) | ||
## 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. | ||
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. | ||
@@ -47,3 +49,4 @@ ```javascript | ||
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'. | ||
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. | ||
@@ -58,2 +61,3 @@ ```<region-select /> ``` | ||
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. | ||
@@ -60,0 +64,0 @@ ## Contributing |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
1305115
31
16841
65