Area 省市区选择

介绍

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

引入

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

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 引入：

# 通过 npm
npm i @vant/area-data
# 通过 yarn
yarn add @vant/area-data
# 通过 pnpm
pnpm add @vant/area-data

import { areaList } from '@vant/area-data';
export default {
  setup() {
    return { areaList };
  },
};

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

选中省市区

如果想选中某个省市区，需要传入一个 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

Events

ConfirmResult 格式

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

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

Slots

方法

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

类型定义

组件导出以下类型定义：

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

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

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

常见问题

在桌面端无法操作组件？

参见桌面端适配。