Skip to content

Badge 徽标

徽标数组件,用于显示未读消息数量、提示用户等场景。支持圆点形式和包含文字形式,拥有多种展示模式和丰富的自定义选项。

平台差异说明

App(vue)App(nvue)H5小程序

基本使用

  • 通过 value 设置徽标显示的内容,可以是数字或文本。
html
<see-badge value="5">
  <view class="box">消息</view>
</see-badge>

<see-badge value="new">
  <view class="box">通知</view>
</see-badge>

主题类型

  • 通过 type 设置徽标主题类型,默认为 error
html
<see-badge value="5" type="primary">
  <view class="box">主要</view>
</see-badge>
<see-badge value="5" type="success">
  <view class="box">成功</view>
</see-badge>
<see-badge value="5" type="warning">
  <view class="box">警告</view>
</see-badge>
<see-badge value="5" type="info">
  <view class="box">信息</view>
</see-badge>
<see-badge value="5" type="error">
  <view class="box">错误</view>
</see-badge>

圆点徽标

  • 设置 isDottrue,可只显示圆点,不显示数字。
html
<see-badge is-dot type="primary">
  <view class="box">消息</view>
</see-badge>
<see-badge is-dot type="success">
  <view class="box">通知</view>
</see-badge>

最大值

  • 通过 max 设置最大值,超过最大值会显示 {max}+,默认为 99
html
<see-badge :value="100" :max="99">
  <view class="box">消息</view>
</see-badge>
<see-badge :value="50" :max="99">
  <view class="box">消息</view>
</see-badge>

数字显示方式

  • 通过 numberType 设置数字显示方式。
  • overflow:超过最大值显示 {max}+(默认)。
  • ellipsis:超过最大值显示 {max}...
  • limit:按 1000、10000 格式化显示(如 1.5k2.3w)。
html
<see-badge :value="1500" number-type="overflow">
  <view class="box">overflow</view>
</see-badge>
<see-badge :value="1500" number-type="ellipsis">
  <view class="box">ellipsis</view>
</see-badge>
<see-badge :value="1500" number-type="limit">
  <view class="box">limit</view>
</see-badge>

徽标形状

  • 通过 shape 设置徽标形状,支持 circle(圆角)和 horn(左下角直角)两种形状。
html
<see-badge value="5" shape="circle">
  <view class="box">圆角</view>
</see-badge>
<see-badge value="5" shape="horn">
  <view class="box">角形</view>
</see-badge>

显示与隐藏

  • 通过 show 控制徽标的显示与隐藏。
  • 通过 showZero 设置数值为 0 时是否显示,默认为 false
html
<see-badge value="5" :show="true">
  <view class="box">显示</view>
</see-badge>
<see-badge value="5" :show="false">
  <view class="box">隐藏</view>
</see-badge>
<see-badge :value="0" :show-zero="true">
  <view class="box">显示零</view>
</see-badge>

位置偏移

  • 通过 offset 设置徽标位置偏移,格式为 [top, right],单位 rpx。
  • 需要配合 absolute 使用。
html
<see-badge value="5" absolute :offset="[-10, -10]">
  <view class="box">偏移</view>
</see-badge>

反转样式

  • 设置 invertedtrue,可反转徽标的背景和文字颜色。
html
<see-badge value="5" type="primary">
  <view class="box">默认</view>
</see-badge>
<see-badge value="5" type="primary" inverted>
  <view class="box">反转</view>
</see-badge>

自定义颜色

  • 通过 color 自定义文字颜色。
  • 通过 bgColor 自定义背景颜色。
html
<see-badge value="5" color="#fff" bg-color="#7232dd">
  <view class="box">自定义</view>
</see-badge>

注意

自定义颜色为硬编码色值,不会随深色/浅色主题自动切换。

自定义大小

  • 通过 size 设置字体大小,单位 px。
  • 通过 dotSize 设置圆点大小,单位 rpx。
html
<see-badge value="5" :size="10">
  <view class="box">小号</view>
</see-badge>
<see-badge value="5" :size="14">
  <view class="box">大号</view>
</see-badge>
<see-badge is-dot :dot-size="24">
  <view class="box">大圆点</view>
</see-badge>

Props

属性说明类型默认值可选值
value展示的数字或文本内容String | Number''-
type徽标主题类型String'error''info' 'primary' 'error' 'warning' 'success'
color自定义文字颜色String''-
bgColor自定义背景颜色String''-
max最大值,超过显示 {max}+String | Number99-
isDot是否只显示圆点Booleanfalse-
show是否显示徽标Booleantrue-
showZero数值为0时是否显示Booleanfalse-
shape徽标形状String'circle''circle' 'horn'
numberType数字显示方式String'overflow''overflow' 'ellipsis' 'limit'
offset徽标位置偏移 [top, right],单位 rpxArray[0, 0]-
absolute是否使用绝对定位Booleanfalse-
inverted是否反转背景和文字颜色Booleanfalse-
size字体大小,单位 pxNumber8-
dotSize圆点大小,单位 rpxNumber18-

Events

事件名说明回调参数
onClick点击徽标时触发-

Slots

插槽名说明
default徽标包裹的内容

Methods

方法名说明参数
getValue获取徽标的原始值-
getDisplayValue获取徽标显示的值(经过格式化处理)-

辽 ICP 备 2025070134 号