更新记录

1.0.0(2025-12-07) 下载此版本

appx-badge 是基于 uni-app x 开发的通用角标组件,支持数值展示、圆点模式、自定义样式及位置偏移等功能,可灵活挂载在任意元素上,适用于消息提醒、数量标识等业务场景。


平台兼容性

uni-app x(4.87)

Chrome Safari Android iOS 鸿蒙 微信小程序

appx-badge 角标组件帮助文档

组件介绍

appx-badge 是基于 uni-app x 开发的通用角标组件,支持数值展示、圆点模式、自定义样式及位置偏移等功能,可灵活挂载在任意元素上,适用于消息提醒、数量标识等业务场景。

组件特性

  1. 支持数值模式(超过阈值显示 阈值+)和圆点模式(无数字);
  2. 自定义角标背景色、文字色、尺寸、圆角、字体大小;
  3. 支持四个方位(左上/右上/左下/右下)定位,且可配置偏移量;
  4. 支持点击事件、溢出行为控制;
  5. 样式隔离,适配 inline-block 布局,垂直居中对齐。

使用方式

基础引入

<template>
  <view>
    <!-- 数值角标 -->
    <appx-badge value="12">
      <button>消息</button>
    </appx-badge>

    <!-- 圆点角标 -->
    <appx-badge isDot>
      <button>通知</button>
    </appx-badge>
  </view>
</template>

<script lang="uts" setup>
</script>

完整示例

<template>
  <view>
    <!-- 自定义样式+点击事件 -->
    <appx-badge 
      value="120"
      maxCount="999"
      bgColor="#409eff"
      color="#fff"
      size="18px"
      position="top-left"
      offsetX="-2px"
      offsetY="-2px"
      clickable
      @click="handleBadgeClick"
    >
      <image src="/static/icon.png" style="width: 40px; height: 40px;" />
    </appx-badge>
  </view>
</template>

<script lang="uts" setup>
import appxBadge from '@/components/appx-badge/appx-badge.vue';

const handleBadgeClick = () => {
  console.log('角标被点击');
};
</script>

属性说明

属性名 类型 默认值 说明
value number / string '' 角标数值,0/空/undefined/null 时数值模式不显示角标
isDot boolean false 是否为圆点模式(无数字,仅显示圆点)
maxCount number / string 99 最大显示数值,超过则显示 ${maxCount}+,兼容字符串类型(如"999")
bgColor string #f56c6c 角标背景色
color string #ffffff 角标文字颜色
fontSize number / string 10px 角标文字大小,支持数字(自动补px)或字符串(如"12rpx")
size number / string 16px 角标尺寸(宽高),圆点模式为直径,支持数字/字符串
borderRadius number / string 8px 角标圆角(非圆点模式生效),支持数字/字符串
position top-left/top-right/bottom-left/bottom-right top-right 角标定位位置
offsetX number / string 0px 水平偏移量,正数向右,负数向左,支持数字/字符串
offsetY number / string 0px 垂直偏移量,正数向下,负数向上,支持数字/字符串
customStyle object {} 自定义角标样式(覆盖内置样式)
clickable boolean false 是否可点击
overflow visible/hidden/auto visible 容器溢出行为控制

事件说明

事件名 说明 回调参数
click 角标点击时触发(需开启 clickable)

样式说明

  1. 组件容器为 inline-block 布局,垂直居中对齐,默认相对定位;
  2. 角标默认使用 CSS 变量控制样式,优先级:customStyle > 内置属性 > 默认值;
  3. 圆点模式下,角标宽高强制等于 size,无内边距,圆角为 50%;
  4. 角标文字默认不换行,超出 80px 时显示省略号。

注意事项

  1. value 为非数字类型时,数值模式角标不显示;
  2. maxCount 为非数字类型时,默认按 99 处理;
  3. 偏移量建议使用 px/rpx 单位,无单位时默认补 px;
  4. 若角标被遮挡,可调整 z-index(通过 customStyle 设置);
  5. 容器 overflow 设置为 hidden 时,可能导致角标超出部分被裁剪。

隐私、权限声明

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

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

插件不采集任何数据

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

许可协议

MIT协议

暂无用户评论。