Skip to content

Badge 徽章

按钮和图标上的数字或状态标记

基础用法

最大值

自定义颜色

自定义徽标内容

自定义徽标位置

独立展示

API

Props

参数说明类型默认值
content徽标内容(dotfasle 时生效)number / string-
color徽标背景颜色string#ee0a24
dot是否展示为小红点booleanfalse
max最大值,超过最大值会显示 {max}+,仅当 content 为数字时有效number / string-
offset设置徽标的偏移量,数组的两项分别对应水平向右和垂直向下方向的偏移量,默认单位为 px[number / string, number / string]-
show-zero当 content 为数字 0 或字符串 '0' 时,是否展示徽标booleantrue
position徽标位置,可选值为 top-left bottom-left bottom-rightstringtop-right
type显示类型,可选值为 primary success warning infostringdanger

Slots

名称说明
default徽标包裹的子元素
content自定义徽标内容

类型定义

组件导出以下类型定义:

ts
import type { BadgeProps, BadgeType, BadgePosition } from 'ryxon'

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-badge-size16px-
--r-badge-colorvar(--r-white)-
--r-badge-padding0 3px-
--r-badge-font-sizevar(--r-font-size-sm)-
--r-badge-font-weightvar(--r-font-bold)-
--r-badge-border-widthvar(--r-border-width)-
--r-badge-backgroundvar(--r-danger-color)-
--r-badge-dot-colorvar(--r-danger-color)-
--r-badge-dot-size8px-
--r-badge-font-apple-system-font, Helvetica Neue, Arial, sans-serif-

Released under the MIT License.