Area 省市区选择

引入

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

基础用法

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

    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.     110000: '北京市',
    4.     120000: '天津市',
    5.   },
    6.   city_list: {
    7.     110100: '北京市',
    8.     120100: '天津市',
    9.   },
    10.   county_list: {
    11.     110101: '东城区',
    12.     110102: '西城区',
    13.     // ....
    14.   },
    15. };

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

    3.   setup() {
    4.     return { areaList };
    5.   },
    6. };

    控制选中项

    通过 v-model 绑定当前选中的地区码。

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

    配置显示列

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

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

    配置列占位提示文字

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

    Events

    Slots

    方法

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

    组件导出以下类型定义：

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

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

    在桌面端无法操作组件？

    参见。