Area 省市区选择

介绍

省市区三级联动选择，通常与弹出层组件配合使用。

引入

import { createApp } from 'vue';
import { Area } from 'vant';
const app = createApp();
app.use(Area);

代码演示

基础用法

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

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

选中省市区

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

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

配置显示列

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

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

配置列占位提示文字

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

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

API

Props

参数	说明	类型	默认值
value	当前选中的省市区`code`	string	-
title	顶部栏标题	string	-
confirm-button-text	确认按钮文字	string	`确认`
cancel-button-text	取消按钮文字	string	`取消`
area-list	省市区数据，格式见下方	object	-
columns-placeholder	列占位提示文字	string[]	`[]`
loading	是否显示加载状态	boolean	`false`
readonly `v2.10.5`	是否为只读状态，只读状态下无法切换选项	boolean	`false`
item-height `v2.8.6`	选项高度，支持 `px` `vw` `vh` `rem` 单位，默认 `px`	number \| string	`44`
columns-num	显示列数，3-省市区，2-省市，1-省	number \| string	`3`
visible-item-count	可见的选项个数	number \| string	`6`
swipe-duration	快速滑动时惯性滚动的时长，单位`ms`	number \| string	`1000`
is-oversea-code	根据`code`校验海外地址，海外地址会划分至单独的分类	() => boolean	-

Events

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

Slots

名称	说明
title `v2.5.3`	自定义标题内容
columns-top `v2.5.3`	自定义选项上方内容
columns-bottom `v2.5.3`	自定义选项下方内容

方法

通过 ref 可以获取到 Area 实例并调用实例方法，详见组件实例方法。

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

省市区列表数据格式

整体是一个 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: '东城区',
  },
];

常见问题

在桌面端无法操作组件？

参见桌面端适配。