vant/packages/area/zh-CN.md

Area 省市区选择

省市取选择组件通常与 弹出层 组件配合使用

使用指南

import { Area } from 'vant';

Vue.use(Area);

代码演示

基础用法

要初始化一个Area组件，你需要传入一个area-list属性，数据格式具体可看下面数据格式章节

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

选中省市区

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

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

配置显示列

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

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

API

参数	说明	类型	默认值
value	当前选中的省市区code	String	-
title	顶部栏标题	String	-
area-list	省市区数据，格式见下方	Object	-
columns-num	省市区显示列数，3-省市区，2-省市，1-省	`String	Number`
loading	是否显示加载状态	Boolean	false
item-height	选项高度	Number	44
visible-item-count	可见的选项个数	Number	5

Event

事件	说明	回调参数
confirm	点击右上方完成按钮	一个数组参数，具体格式看下方数据格式章节
cancel	点击取消按钮时	-
change	选项改变时触发	Picker 实例，所有列选中值，当前列对应的索引

方法

通过 ref 可以获取到 area 实例并调用实例方法

方法名	参数	返回值	介绍
reset	-	-	重置所有选项到第一项

数据格式

省市区列表数据格式

整体是一个 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

点击完成时返回的数据格式

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

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

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

更新日志

版本	类型	内容
1.1.12	feature	新增 reset 方法
1.1.11	bugfix	修复 city_list 为空时报错的问题
1.1.8	improvement	优化默认选项
1.1.2	feature	新增 change 事件
0.12.14	bugfix	修复 area-list 更新时未正确选中省市区的问题
0.12.7	feature	新增 item-height、visible-item-count 属性
0.12.5	bugfix	修复未选中省份时市区展示错误的问题
0.12.3	bugfix	修复传空 area-list 时报错的问题
0.12.3	bugfix	修复 setCode 方法失效的问题
0.11.14	improvement	优化性能
0.11.13	feature	新增 title 属性
0.11.11	feature	新增 focus、change-area、select-search 事件
0.9.2	feature	新增组件