更新记录

1.0.0(2025-07-05)

版本发布


平台兼容性

uni-app(4.05)

Vue2 Vue3 Chrome Safari app-vue app-nvue Android iOS 鸿蒙
- - - - - - - - -
微信小程序 支付宝小程序 抖音小程序 百度小程序 快手小程序 京东小程序 鸿蒙元服务 QQ小程序 飞书小程序 快应用-华为 快应用-联盟
- - - - - - - - - - -

其他

多语言 暗黑模式 宽屏模式
× ×

vshare-area-stepper-picker 组件文档

组件简介

vshare-area-stepper-picker 是一个支持多级联动、分组、步骤条、主题自定义的高颜值地区选择弹窗组件,适用于省市区/街道等多级地址选择场景。


属性 Props

属性名 类型 默认值 说明
areaData Array - 地区数据,四级嵌套
value Array [] 已选 value 数组(回显)
themeColor String '#ff7e00' 主题色(高亮色)
radius String '32rpx' 弹窗圆角
stepFontSize String '28rpx' 步骤条文字字号
itemFontSize String '30rpx' 选项文字字号
steps Array ['省份/地区','城市','区县','街道/镇'] 步骤条内容(自定义级数/文本)

事件 Events

事件名 说明 回调参数
confirm 选择完成,返回所有选中项 选中对象数组
close 点击关闭按钮/遮罩关闭弹窗 -

用法示例 Usage

1. 基本用法

<vshare-area-stepper-picker
  :areaData="areaData"
  @confirm="onConfirm"
  @close="onClose"
/>

2. 回显已选内容

<vshare-area-stepper-picker
  :areaData="areaData"
  :value="['gd','gz','th','sp']"
/>

3. 自定义主题色/圆角/字号

<vshare-area-stepper-picker
  :areaData="areaData"
  themeColor="#007aff"
  radius="16rpx"
  stepFontSize="32rpx"
  itemFontSize="34rpx"
/>

4. 自定义步骤条内容

<vshare-area-stepper-picker
  :areaData="areaData"
  :steps="['大区','省份','城市']"
/>

主题自定义说明

  • 通过 themeColor 设置高亮色(如 #007aff 蓝色)。
  • 通过 radius 设置弹窗圆角。
  • 通过 stepFontSizeitemFontSize 分别设置步骤条和选项字号。

步骤条自定义说明

  • 通过 steps 传递字符串数组,决定步骤条的级数和每一级的名称。
  • 例如:['大区','省份','城市'] 支持三级联动。

数据结构说明

[
  {
    label: '广东省', value: 'gd', pinyin: 'G', children: [
      {
        label: '广州市', value: 'gz', pinyin: 'G', children: [
          {
            label: '天河区', value: 'th', pinyin: 'T', children: [
              { label: '石牌街道', value: 'sp', pinyin: 'S' },
              { label: '五山街道', value: 'ws', pinyin: 'W' }
            ]
          }
        ]
      }
    ]
  }
]
  • label:显示文本
  • value:唯一标识
  • pinyin:首字母分组用(可选)
  • children:下一级数组

常见问题 FAQ

Q: 如何实现回显? A: 只需传入 value 数组(如 ['gd','gz','th','sp']),组件会自动回显。

Q: 如何自定义主题色? A: 传递 themeColor 属性即可,如 themeColor="#007aff"。

Q: 如何自定义步骤条内容? A: 传递 steps 属性,如 :steps="['大区','省份','城市']"。

Q: 支持几级联动? A: 支持任意级数,steps 和 areaData 保持一致即可。


如有更多问题,欢迎提 issue 或联系开发者。

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

暂无用户评论。

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问