Area 省市区选择

介绍

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

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

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

代码演示

基础用法

初始化省市区组件时,需要通过 area-list 属性传入省市区数据。

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

areaList 格式

areaList 为对象结构,包含 province_listcity_listcounty_list 三个 key。

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

示例数据如下:

  1. const areaList = {
  2. province_list: {
  3. 110000: '北京市',
  4. 120000: '天津市',
  5. },
  6. city_list: {
  7. 110100: '北京市',
  8. 120100: '天津市',
  9. },
  10. county_list: {
  11. 110101: '东城区',
  12. 110102: '西城区',
  13. // ....
  14. },
  15. };

@vant/area-data

Vant 官方提供了一份默认的中国省市区数据,可以通过 @vant/area-data 引入:

  1. # 通过 npm
  2. npm i @vant/area-data
  3. # 通过 yarn
  4. yarn add @vant/area-data
  5. # 通过 pnpm
  6. pnpm add @vant/area-data
  1. import { areaList } from '@vant/area-data';
  2. export default {
  3. setup() {
  4. return { areaList };
  5. },
  6. };

Tips: 中国的行政区划每年都会有变动,如果发现省市区数据未及时更新,欢迎提 Pull Request 帮助我们更新。

选中省市区

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

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

配置显示列

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

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

配置列占位提示文字

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

  1. <van-area
  2. title="标题"
  3. :area-list="areaList"
  4. :columns-placeholder="['请选择', '请选择', '请选择']"
  5. />

API

Props

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

Events

事件说明回调参数
confirm点击完成按钮时触发result: ConfirmResult
cancel点击取消按钮时触发-
change选项改变时触发所有列选中值,当前列对应的索引

ConfirmResult 格式

confirm 事件返回的数据整体为一个数组,数组每一项对应一列选项中被选中的数据。

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

Slots

名称说明参数
toolbar v3.1.2自定义整个顶部栏的内容-
title自定义标题内容-
confirm v3.1.2自定义确认按钮内容-
cancel v3.1.2自定义取消按钮内容-
columns-top自定义选项上方内容-
columns-bottom自定义选项下方内容-

方法

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

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

类型定义

组件导出以下类型定义:

  1. import type { AreaProps, AreaList, AreaInstance, AreaColumnOption } from 'vant';

AreaInstance 是组件实例的类型,用法如下:

  1. import { ref } from 'vue';
  2. import type { AreaInstance } from 'vant';
  3. const areaRef = ref<AreaInstance>();
  4. areaRef.value?.reset();

常见问题

在桌面端无法操作组件?

参见桌面端适配

Area 省市区选择 - 图1