vant/docs/examples-docs/en-US/area.md

Area

Install

import { Area } from 'vant';

Vue.component(Area.name, Area);

Usage

Basic Usage

要初始化一个Area组件，你需要传入一个areaList属性，areaListData Structure具体可看下面Data Structure章节。

:::demo Basic Usage

<van-area :area-list="areaList"></van-area>

<script>
import AreaList from '../../mock/area.json';

export default {
  data() {
    return {
      areaList: AreaList
    }
  }
};
</script>

:::

选中省市县

如果想选中某个省市县，需要传入一个value属性，绑定对应的省市县code。

:::demo 选中省市县

<van-area :area-list="areaList" value="110101"></van-area>

:::

配置显示列

可以通过columnsNum属性配置省市县显示的列数，默认情况下会显示省市县，当你设置为2，则只会显示省市选择。

:::demo 配置显示列

<van-area :area-list="areaList" :columns-num="2"></van-area>

:::

API

Attribute	Description	Type	Default	Accepted Values
value	当前选中的省市区code	String	-	-
areaList	省市县数据，必须与province_list、city_list和county_list为key	Object	-	-
columnsNum	省市县显示列数，3-省市县，2-省市，1-省	String,Number	3	-

Event

Event	Description	Arguments
confirm	点击右上方完成按钮	一个数组参数，具体格式看下方Data Structure章节
cancel	点击取消按钮时	-

Data Structure

省市县列表Data Structure

整体是一个Object，包含 province_list, city_list, county_list 三个key。

每项以省市区编码作为key，省市区名字作为value。编码为6位数字，前两位代表省份，中间两位代表城市，后两位代表区县，以0补足6位。如北京编码为 11，以零补足6位，为 110000。

AreaList具体格式如下：

{
  province_list: {
    110000: '北京市',
    120000: '天津市'
  },
  city_list: {
    110100: '北京市',
    110200: '县',
    120100: '天津市',
    120200: '县'
  },
  county_list: {
    110101: '东城区',
    110102: '西城区',
    110105: '朝阳区',
    110106: '丰台区'
    120101: '和平区',
    120102: '河东区',
    120103: '河西区',
    120104: '南开区',
    120105: '河北区',
    // ....
  }
}

完整数据见 Area.json

点击完成时返回的Data Structure

返回的数据整体为一个数组，数组内包含 columnsNum 个数据， 每个数据对应一列选项中被选中的数据。

code 代表被选中的地区编码， name 代表被选中的地区名称

[{
  code: '110000',
  name: '北京市'
}, {
  code: '110100',
  name: '北京市'
},{
  code: '110101',
  name: '东城区'
}]