Area 省市区选择

介绍

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

引入

在app.json或index.json中引入组件，详细介绍见快速上手

  1. "usingComponents": {
  2.   "van-area": "path/to/@vant/weapp/dist/area/index"
  3. }

代码演示

基础用法

要初始化一个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="标题" />

配置列占位提示文字

可以通过columns-placeholder属性配置每一列的占位提示文字

<van-area
  area-list="{{ areaList }}"
  columns-placeholder="{{ ['请选择', '请选择', '请选择'] }}"
  title="标题"
/>

云开发示例

使用云开发获取省市区数据

实际项目中，可以通过小程序云开发的能力，将省市区数据保存在云开发的数据库中，并在小程序中使用云开发的接口异步获取数据。

在小程序中使用云能力之前需要先调用wx.could.init方法完成云能力的初始化。

const db = wx.cloud.database();

db.collection('region').limit(1).get()
.then(res => {
  if (res.data && res.data.length > 0) {
    this.setData({
      areaList: res.data[0]
    });
  }
})
.catch(err => {
  console.log(err);
});

API

Props

参数说明类型默认值版本
value当前选中的省市区codestring--
title顶部栏标题string--
area-list省市区数据，格式见下方object--
columns-num省市区显示列数，3-省市区，2-省市，1-省string | number3-
columns-placeholder列占位提示文字string[][]-
loading是否显示加载状态booleanfalse-
item-height选项高度number44-
visible-item-count可见的选项个数number5-
confirm-button-text确认按钮文字string确认-
cancel-button-text取消按钮文字string取消-

Events

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

方法

通过 selectComponent 可以获取到 Area 实例并调用实例方法

方法名参数返回值介绍
resetcode: string-根据 code 重置所有选项，若不传 code，则重置到第一项

省市区列表数据格式

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

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

返回的数据整体为一个 Object，包含 values, indexs 两个 key

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

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

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

indexs 为一个数组，数组内包含 columnsNum 个数据， 每个数据对应一列选项中被选中项的序号。

Area 省市区选择 - 图1