ant-design/components/badge/index.zh-CN.md
二货爱吃白萝卜 20561d6f9d
docs: Fix component doc alignment & support import usage (#48004)
* docs: init ref

* docs all support

* docs: fix link show
2024-03-22 14:22:42 +08:00

3.1 KiB
Raw Blame History

category title subtitle description cover coverDark demo group
Components Badge 徽标数 图标右上角的圆形徽标数字。 https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*e0qITYqF394AAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*v8EQT7KoGbcAAAAAAAAAAAAADrJ8AQ/original
cols
2
数据展示

何时使用

一般出现在通知图标或头像的右上角,用于显示需要处理的消息条数,通过醒目视觉形式吸引用户处理。

代码演示

基本 独立使用 封顶数字 讨嫌的小红点 动态 可点击 自定义位置偏移 大小 状态点 多彩徽标 缎带 Ribbon Debug 各种混用的情况 自定义标题 多彩徽标支持 count 显示 Debug 组件 Token

API

通用属性参考:通用属性

Badge

参数 说明 类型 默认值 版本
color 自定义小圆点的颜色 string -
count 展示的数字,大于 overflowCount 时显示为 ${overflowCount}+,为 0 时隐藏 ReactNode -
classNames 语义化结构 class Record<SemanticDOM, string> - 5.7.0
dot 不展示数字,只有一个小红点 boolean false
offset 设置状态点的位置偏移 [number, number] -
overflowCount 展示封顶的数字值 number 99
showZero 当数值为 0 时,是否展示 Badge boolean false
size 在设置了 count 的前提下有效,设置小圆点的大小 default | small - -
status 设置 Badge 为状态点 success | processing | default | error | warning -
styles 语义化结构 style Record<SemanticDOM, CSSProperties> - 5.7.0
text 在设置了 status 的前提下有效,设置状态点的文本 ReactNode -
title 设置鼠标放在状态点上时显示的文字 string -

Badge.Ribbon

参数 说明 类型 默认值 版本
color 自定义缎带的颜色 string -
placement 缎带的位置,startend 随文字方向RTL 或 LTR变动 start | end end
text 缎带中填入的内容 ReactNode -

Semantic DOM

主题变量Design Token