@tanzhenxing/zx-area v1.0.2

zx-area 省市区选择器

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

平台兼容性

本组件理论上支持 uni-app 全平台，但主要在 H5、微信小程序、App 端进行了测试和优化。

引入方式

<template>
  <zx-area
    :show="showAreaPicker"
    v-model="selectedAreaCode"
    :area-list="areaListData"
    title="选择所在地区"
    @confirm="handleAreaConfirm"
    @cancel="handleAreaCancel"
    @change="handleAreaChange"
  />
</template>

<script setup>
import { ref } from 'vue';
import zxArea from '@/components/zx-area/zx-area.vue'; // 请根据实际路径修改
// 如果您没有全局安装 @vant/area-data，可以在这里引入或自行准备数据
// import { areaList } from '@vant/area-data'; // npm i @vant/area-data

const showAreaPicker = ref(false);
const selectedAreaCode = ref(''); // 选中的地区码，例如：'330102'

// 示例省市区数据 (areaList 格式)
// 建议从 @vant/area-data 获取最新数据，或自行维护
const areaListData = ref({
  province_list: {
    110000: '北京市',
    120000: '天津市',
    310000: '上海市',
    330000: '浙江省',
  },
  city_list: {
    110100: '北京市',
    120100: '天津市',
    310100: '上海市',
    330100: '杭州市',
    330200: '宁波市',
  },
  county_list: {
    110101: '东城区',
    110102: '西城区',
    310101: '黄浦区',
    330102: '上城区',
    330103: '下城区',
    330203: '海曙区',
  },
});

const handleAreaConfirm = (data) => {
  console.log('Area confirmed:', data);
  // data: { selectedValues, selectedOptions, selectedIndexes }
  // selectedValues: ['110000', '110100', '110101'] (地区码数组)
  // selectedOptions: [{text: '北京市', value: '110000'}, ...] (选中项对象数组)
  // selectedIndexes: [0, 0, 0] (各列选中索引)
  selectedAreaCode.value = data.selectedValues[data.selectedValues.length - 1];
  showAreaPicker.value = false;
};

const handleAreaCancel = (data) => {
  console.log('Area canceled:', data);
  showAreaPicker.value = false;
};

const handleAreaChange = (data) => {
  console.log('Area changed:', data);
  // data: { selectedValues, selectedOptions, selectedIndexes, columnIndex }
  // columnIndex: 发生改变的列的索引
};

const openAreaPicker = () => {
  showAreaPicker.value = true;
};
</script>

API

Props

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 包来获取最新的中国省市区数据：

# 通过 npm
npm i @vant/area-data

# 通过 yarn
yarn add @vant/area-data

# 通过 pnpm
pnpm add @vant/area-data

然后在代码中引入：

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

Events

回调参数说明

• selectedValues: 选中项的地区码数组，例如 ['330000', '330100', '330102']
• selectedOptions: 选中项的对象数组，例如 [{ text: '浙江省', value: '330000' }, { text: '杭州市', value: '330100' }, { text: '上城区', value: '330102' }]
• selectedIndexes: 各列选中项的索引数组，例如 [2, 0, 1]

Methods

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

<template>
  <zx-area ref="areaRef" ... />
  <button @click="getOpts">获取选中项</button>
</template>

<script setup>
import { ref } from 'vue';
const areaRef = ref(null);

const getOpts = () => {
  const options = areaRef.value?.getSelectedOptions();
  console.log(options);
};
</script>

注意事项

• 本组件依赖 zx-popup 组件，请确保已正确引入或全局注册 zx-popup。
• 省市区数据 (areaList) 需要用户自行提供，推荐使用 @vant/area-data。如果数据量较大，请注意小程序的包体积限制。
• picker-view 在不同平台的表现可能存在细微差异，样式调整可能需要针对性处理。
• loading 和 visible-item-count 属性目前为预留，其在 picker-view 上的直接控制较为复杂，后续可能会进一步完善。