https://github.com/dwqs/vue-area-linkage
省市区联动选择: https://dwqs.github.io/vue-area-linkage/
https://github.com/dwqs/vue-area-linkage
area area-linkage area-picker china picker vuejs2
Last synced: 6 months ago
JSON representation
省市区联动选择: https://dwqs.github.io/vue-area-linkage/
- Host: GitHub
- URL: https://github.com/dwqs/vue-area-linkage
- Owner: dwqs
- License: mit
- Archived: true
- Created: 2017-08-10T02:04:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-31T10:32:25.000Z (almost 7 years ago)
- Last Synced: 2025-04-12T19:48:26.990Z (6 months ago)
- Topics: area, area-linkage, area-picker, china, picker, vuejs2
- Language: Vue
- Homepage:
- Size: 4.86 MB
- Stars: 480
- Watchers: 7
- Forks: 95
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
 
# vue-area-linkage
省市区联动选择. 组合数据来源：[area-data](https://github.com/dwqs/area-data)
## Installation
Install the pkg with npm:
```
// v5之前的版本
npm i --save vue-area-linkage
// v5及之后的版本
npm i --save vue-area-linkage area-data
```
or yarn
```
// v5之前的版本
yarn add vue-area-linkage
// v5及之后的版本
yarn add vue-area-linkage area-data
```
## Usage
```
import Vue from 'vue';
import { pca, pcaa } from 'area-data'; // v5 or higher
import 'vue-area-linkage/dist/index.css'; // v2 or higher
import VueAreaLinkage from 'vue-area-linkage';
Vue.use(VueAreaLinkage)
```
```
// v5之前的版本
// v5及之后的版本
// 省市
// 省市区：
// 省市
// 省市区：
//setting
```
More demo to visit [here](https://dwqs.github.io/vue-area-linkage/).
## On Demand Import
> version >= 2.1.2
安装 [babel-plugin-on-demand-import](https://github.com/dwqs/babel-plugin-on-demand-import):
```
npm i babel-plugin-on-demand-import -D
```
修改 `.babelrc`:
```
{
// ...
"plugins": [
["on-demand-import" {
"libraryName": "vue-area-linkage",
"libraryPath": "dist/lib"
}]
]
}
```
```
import 'vue-area-linkage/dist/index.css'; // v2 or higher
import pcaa from 'area-data/pcaa';
// Only import AreaCascader component
import { AreaCascader } from 'vue-area-linkage';
Vue.use(AreaCascader);
// Only import AreaSelect component
import { AreaSelect } from 'vue-area-linkage';
Vue.use(AreaSelect);
```
## 属性
### area-select 组件
| 参数 | 类型 | 可选值 | 默认值 | 说明 |
| :--: | :--: | :--: | :--: | :--: |
| type | String | all/code/text | code | 设置返回的数据格式 |
| placeholders | Array | - | [] | 设置 placeholder text |
| level | Number | 0/1/2 | 1 | 设置联动层级(0-只选省份/1-省市联动/2-省市区联动) |
| size | String | small/medium/large | medium | 设置输入框的大小 |
| disabled | Boolean | - | false | 是否禁用 |
| data | Object | - | - | 地区数据(v5需要传入) |
| icon | String | - | area-select-icon | 自定义下拉小图标 |
| disableLinkage | Boolean | - | true | 地区选择是否进行联动 |
>v4 仅支持省市区联动，即 v4 不再支持 level 的值为 3(省市区街联动)
### area-cascader 组件
| 参数 | 类型 | 可选值 | 默认值 | 说明 |
| :--: | :--: | :--: | :--: | :--: |
| type | String | all/code/text | code | 设置返回的数据格式 |
| placeholder | String | - | '' | 设置 placeholder text |
| level | Number | 0/1 | 0 | 设置联动层级(0-省市联动/1-省市区联动) |
| size | String | small/medium/large | medium | 设置输入框的大小 |
| separator | String | - | '-' | 显示选中文本的分隔符 |
| disabled | Boolean | - | false | 是否禁用 |
| data | Object | - | - | 地区数据(v5需要传入) |
## 事件
| 事件名 | 说明 | 参数 |
| :--: | :--: | :--: |
| change | 选中值发生变化时触发 | 目前选择的值 |
> change 事件在 1.2.5 之后提供
## Related Project
* [react-area-linkage](https://github.com/dwqs/react-area-linkage)
## License
MIT.