Area 省市县选择组件

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

使用指南

  1. import { Area } from 'vant';
  3. Vue.use(Area);

代码演示

基础用法

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

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

选中省市县

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

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

配置显示列

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

  1. <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 3
loading 是否显示加载状态 Boolean false
item-height 选项高度 Number 44
visible-item-count 可见的选项个数 Number 5

Event

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

数据格式

省市县列表数据格式

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

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

AreaList具体格式如下：

  1. {
  2.   province_list: {
  3.     110000: '北京市',
  4.     120000: '天津市'
  5.   },
  6.   city_list: {
  7.     110100: '北京市',
  8.     110200: '县',
  9.     120100: '天津市',
  10.     120200: '县'
  11.   },
  12.   county_list: {
  13.     110101: '东城区',
  14.     110102: '西城区',
  15.     110105: '朝阳区',
  16.     110106: '丰台区'
  17.     120101: '和平区',
  18.     120102: '河东区',
  19.     120103: '河西区',
  20.     120104: '南开区',
  21.     120105: '河北区',
  22.     // ....
  23.   }
  24. }

完整数据见 Area.json

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

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

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

  1. [
  2.   {
  3.     code: '110000',
  4.     name: '北京市'
  5.   },
  6.   {
  7.     code: '110100',
  8.     name: '北京市'
  9.   },
  10.   {
  11.     code: '110101',
  12.     name: '东城区'
  13.   }
  14. ];

原文:

https://youzan.github.io/vant/#/zh-CN/area