mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
134 lines
3.0 KiB
Markdown
134 lines
3.0 KiB
Markdown
<script>
|
||
import AreaList from '../mock/area.json';
|
||
|
||
export default {
|
||
data() {
|
||
return {
|
||
areaList: AreaList
|
||
}
|
||
}
|
||
};
|
||
</script>
|
||
|
||
## Area 省市县选择组件
|
||
|
||
### 使用指南
|
||
|
||
``` javascript
|
||
import { Area } from 'vant';
|
||
|
||
Vue.component(Area.name, Area);
|
||
```
|
||
|
||
### 代码演示
|
||
|
||
#### 基础用法
|
||
|
||
要初始化一个`Area`组件，你需要传入一个`areaList`属性，`areaList`数据格式具体可看下面数据格式章节。
|
||
|
||
:::demo 基础用法
|
||
```html
|
||
<van-area :area-list="areaList"></van-area>
|
||
|
||
<script>
|
||
import AreaList from '../mock/area.json';
|
||
|
||
export default {
|
||
data() {
|
||
return {
|
||
areaList: AreaList
|
||
}
|
||
}
|
||
};
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
#### 选中省市县
|
||
|
||
如果想选中某个省市县，需要传入一个`value`属性，绑定对应的省市县`code`。
|
||
|
||
:::demo 选中省市县
|
||
```html
|
||
<van-area :area-list="areaList" value="110101"></van-area>
|
||
```
|
||
:::
|
||
|
||
#### 配置显示列
|
||
|
||
可以通过`columnsNum`属性配置省市县显示的列数，默认情况下会显示省市县，当你设置为`2`，则只会显示省市选择。
|
||
|
||
:::demo 配置显示列
|
||
```html
|
||
<van-area :area-list="areaList" :columns-num="2"></van-area>
|
||
```
|
||
:::
|
||
|
||
### API
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|
||
|-----------|-----------|-----------|-------------|-------------|
|
||
| value | 当前选中的省市区`code` | `String` | - | |
|
||
| areaList | 省市县数据，必须与`province_list`、`city_list`和`county_list`为key | `Object` | | |
|
||
| columnsNum | 省市县显示列数，3-省市县，2-省市，1-省 | `String`,`Number` | 3 | |
|
||
|
||
### Event
|
||
|
||
| 事件名称 | 说明 | 回调参数 |
|
||
|-----------|-----------|-----------|
|
||
| confirm | 点击右上方完成按钮 | 一个数组参数，具体格式看下方数据格式章节 |
|
||
| cancel | 点击取消按钮时 | - |
|
||
|
||
### 数据格式
|
||
|
||
#### 省市县列表数据格式
|
||
|
||
整体是一个Object，包含 `province_list`, `city_list`, `county_list` 三个key。
|
||
|
||
每项以省市区编码作为key，省市区名字作为value。编码为6位数字，前两位代表省份，中间两位代表城市，后两位代表区县，以0补足6位。如北京编码为 `11`，以零补足6位，为 `110000`。
|
||
|
||
`AreaList`具体格式如下：
|
||
```javascript
|
||
{
|
||
province_list: {
|
||
110000: '北京市',
|
||
120000: '天津市'
|
||
},
|
||
city_list: {
|
||
110100: '北京市',
|
||
110200: '县',
|
||
120100: '天津市',
|
||
120200: '县'
|
||
},
|
||
county_list: {
|
||
110101: '东城区',
|
||
110102: '西城区',
|
||
110105: '朝阳区',
|
||
110106: '丰台区'
|
||
120101: '和平区',
|
||
120102: '河东区',
|
||
120103: '河西区',
|
||
120104: '南开区',
|
||
120105: '河北区',
|
||
// ....
|
||
}
|
||
}
|
||
```
|
||
|
||
#### 点击完成时返回的数据格式
|
||
返回的数据整体为一个数组，数组内包含 `columnsNum` 个数据， 每个数据对应一列选项中被选中的数据。
|
||
|
||
`code` 代表被选中的地区编码， `name` 代表被选中的地区名称
|
||
```javascript
|
||
[{
|
||
code: '110000',
|
||
name: '北京市'
|
||
}, {
|
||
code: '110100',
|
||
name: '北京市'
|
||
},{
|
||
code: '110101',
|
||
name: '东城区'
|
||
}]
|
||
```
|