Area 省市区选择

引入

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

基础用法

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

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

areaList 格式

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

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

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

@vant/area-data

Vant 官方提供了一份默认的中国省市区数据，可以通过 引入：

  1. import { areaList } from '@vant/area-data';
  3. export default {
  4.   setup() {
  6.   },
  7. };

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

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

配置显示列

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

配置列占位提示文字

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

Props

Events

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

方法

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

类型定义

组件导出以下类型定义：

AreaInstance 是组件实例的类型，用法如下：

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

在桌面端无法操作组件？