介绍

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

实例演示

引入

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

import { createApp } from 'vue';
import { Area } from 'vant';

const app = createApp();
app.use(Area);

代码演示

基础用法

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

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

areaList 格式

areaList 为对象结构，包含 province_list、city_list、county_list 三个 key。

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

示例数据如下：

const areaList = {
  province_list: {
    110000: '北京市',
    120000: '天津市',
  },
  city_list: {
    110100: '北京市',
    120100: '天津市',
  },
  county_list: {
    110101: '东城区',
    110102: '西城区',
    // ....
  },
};

@vant/area-data

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

yarn add @vant/area-data

import { areaList } from '@vant/area-data';

export default {
  setup() {
    return { areaList };
  },
};

选中省市区

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

<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	当前选中项对应的地区码	string	-
title	顶部栏标题	string	-
confirm-button-text	确认按钮文字	string	确认
cancel-button-text	取消按钮文字	string	取消
area-list	省市区数据，格式见下方	object	-
columns-placeholder	列占位提示文字	string[]	[]
loading	是否显示加载状态	boolean	false
readonly	是否为只读状态，只读状态下无法切换选项	boolean	false
item-height	选项高度，支持 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	根据地区码校验海外地址，海外地址会划分至单独的分类	() => boolean	-

Events

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

ConfirmResult 格式

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

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

Slots

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

方法

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

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

类型定义

通过 AreaInstance 获取 Area 实例的类型定义。

import { ref } from 'vue';
import type { AreaInstance } from 'vant';

const areaRef = ref<AreaInstance>();

areaRef.value?.reset();

常见问题

在桌面端无法操作组件？

参见桌面端适配。