Skip to content

Badge 徽标数

该组件一般用于图标右上角显示未读的消息数量,该组件有多种模式,具体查看下方的文档。
为了用户更好的自定义布局,该组件默认未开启 absolute 模式。

基础使用

通过 value 属性设置显示的数字/文字。

vue
<hi-badge :value="10" />

边框

通过 border 属性设置是否显示边框。

vue
<hi-badge :value="10" border />
  • 边框默认宽度:1px
  • 边框默认颜色:currentColor

主题

通过 theme 属性设置组件主题。

vue
<hi-badge :value="10" theme="primary" />
<hi-badge :value="10" theme="success" />
<hi-badge :value="10" theme="warning" />
<hi-badge :value="10" theme="error" />
<hi-badge :value="10" theme="info" />

提示

设置主题后,文本颜色会自动设置为 #ffffff,如果需要修改,可以通过 color 属性设置。

镂空

通过 plain 属性设置为镂空。
设置为镂空后,背景会自动设置为 transparent,如果需要修改,可以通过 bg 属性设置。
同时镂空时会默认显示边框。

vue
<hi-badge :value="10" plain />
<hi-badge :value="10" plain theme="primary" />

浅化

通过 tint 属性设置浅化背景。
浅化背景即是:为组件的背景设置透明度,默认为 0.2 透明度。

vue
<hi-badge :value="10" tint />
<hi-badge :value="10" tint theme="primary" />

圆点模式

通过将 mode 属性设置为 dot 开启圆点模式。

vue
<hi-badge :value="10" mode="dot" theme="primary" />
  • 圆点模式下,内容不显示。
  • 圆点模式下,默认大小为 8px,可以通过 dotSizeheight 属性调整大小。

overflow 模式

通过将 mode 属性设置为 overflow 开启 overflow 模式。

overflow 下,除了需要设置 value 外,还需要设置 max 属性,max 表示显示的最大值,超过这个值会显示为 {max}+max 默认为 99

vue
<hi-badge :value="108" mode="overflow" :limit="99" theme="primary" />

ellipsis 模式

通过将 mode 属性设置为 ellipsis 开启 ellipsis 模式。ellipsis 下,除了需要设置 value 外,还需要设置 max 属性,max 表示显示的最大值,超过这个值会显示为 {max}...max 默认为 99

vue
<hi-badge :value="108" mode="ellipsis" :limit="99" theme="primary" />

limit 模式

通过将 mode 属性设置为 limit 开启 limit 模式。limit 下,除了需要设置 value 外,还需要设置 limitsuffix 属性,以 limit 属性的值作为判断条件,值大于 limit 时显示 ${value / limit} + ${suffix}

  • limit 默认值:1000
  • suffix 默认值:k
vue
<hi-badge :value="1568" mode="limit" theme="primary" />
<hi-badge :value="15688" mode="limit" :limit="10000" suffix="w" theme="success" />

Props

属性名说明类型默认值可选值版本
hover指定按下去的样式类String``--
value显示的数字/文字String---
zerovalue0 时,是否显示Booleanfalsetrue-
mode显示模式String-参考上方的模式说明-
max最大值[Number, String]99参考上方的模式说明-
limit分割值[Number, String]1000参考上方的模式说明-
suffix分割值后缀Stringk参考上方的模式说明-
decimalslimit 后要保留的小数位数Number2--
discardLastZerolimit 后是否舍弃末尾为 0 的小数位数Booleantruefalse-
absolute是否开启绝对定位模式Booleanfalsetrue-
top组件的 top 样式属性的值String---
bottom组件的 bottom 样式属性的值String---
left组件的 left 样式属性的值String---
right组件的 right 样式属性的值String---
transform组件的 transform 样式属性的值String---
theme组件的主题String-参考-
plain是否镂空Booleanfalsetrue-
tint是否浅化背景Booleanfalsetrue-
tintOpacity背景透明度[Number, String]0.2--
bg背景String---
color文本颜色String---
fontSize文本大小String---
radius圆角大小String---
width宽度String---
height高度String---
dotSize圆点大小String---
border是否显示边框Booleanfalsetrue-
borderWidth边框宽度String---
borderColor边框颜色String---
borderStyle边框类型String---

Event

事件名说明回调参数版本
click组件点击事件--

样式变量

组件提供了以下样式变量,可以在使用时设置这些变量来修改组件的样式。

变量名默认值版本
--hi-badge-backgroundvar(--hi-background-default, none)-
--hi-badge-colorinherit-
--hi-badge-border-radius100px / 50%-
--hi-badge-padding0 10px / 0-
--hi-badge-positionrelative / absolute-
--hi-badge-displayinline-flex-
--hi-badge-align-itemscenter-
--hi-badge-justify-contentcenter-
--hi-badge-font-size0.8em-
--hi-badge-widthauto / 8px-
--hi-badge-heightauto / 8px-
--hi-badge-z-index8-
--hi-badge-leftauto-
--hi-badge-rightauto-
--hi-badge-topauto-
--hi-badge-bottomauto-
--hi-badge-transforminitial-
--hi-badge-background-opacity0.2-

基于 MIT 许可发布