Skip to content

Badge 徽标

在右上角展示徽标数字或小红点。

引入

通过 easycom 自动引入,无需手动注册。

代码演示

基础用法

设置 value 属性后,Badge 会在子元素的右上角显示对应的徽标。

html
<zq-badge :value="5">
  <zq-button type="primary" text="按钮" />
</zq-badge>

小红点

通过 dot 属性设置为小红点模式。

html
<zq-badge dot>
  <zq-button type="primary" text="按钮" />
</zq-badge>

最大值

通过 max 属性设置最大值,超过最大值时会显示 {max}+

html
<zq-badge :value="120" :max="99">
  <zq-button type="primary" text="按钮" />
</zq-badge>
<!-- 显示为 99+ -->

显示零值

默认情况下,当 value 为 0 时不显示徽标。通过 show-zero 属性可以在值为 0 时也显示。

html
<zq-badge :value="0" show-zero>
  <zq-button type="primary" text="按钮" />
</zq-badge>

徽标类型

支持 primarysuccesswarningdangerinfo 五种类型,默认为 danger

html
<zq-badge :value="5" type="primary">
  <zq-button text="主要" />
</zq-badge>
<zq-badge :value="5" type="success">
  <zq-button text="成功" />
</zq-badge>

自定义偏移

通过 offset 属性设置徽标的偏移量,格式为 [top, right],单位为 rpx。

html
<zq-badge :value="5" :offset="[-10, -10]">
  <zq-button type="primary" text="按钮" />
</zq-badge>

独立使用

不包裹子元素时,Badge 作为独立元素使用。

html
<zq-badge :value="20" />
<zq-badge :value="200" :max="99" />

API

Props

参数说明类型默认值
value徽标内容number | string''
max最大值,超过最大值会显示 {max}+,仅当 value 为数字时有效number99
dot是否显示为小红点booleanfalse
show-zero当 value 为 0 时是否显示booleanfalse
type徽标类型'primary' | 'success' | 'warning' | 'danger' | 'info''danger'
offset徽标偏移量 [top, right],单位 rpxnumber[][]

Slots

名称说明
default徽标包裹的子元素

主题定制

变量名说明
--color-errordanger 类型背景色
--color-primaryprimary 类型背景色
--color-successsuccess 类型背景色
--color-warningwarning 类型背景色
--color-infoinfo 类型背景色

Released under the MIT License.