mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 03:29:59 +08:00
74d13f48b1
* feat: add badge size * test: add doc and testcase for badge size * doc: update demo doc of Badge * doc: update demo doc of Badge * test: fix test case * docs: add badge new props size addition version * style: modify size of small badge
1.6 KiB
1.6 KiB
| category | subtitle | type | title | cover |
|---|---|---|---|---|
| Components | 徽标数 | 数据展示 | Badge | https://gw.alipayobjects.com/zos/antfincdn/6%26GF9WHwvY/Badge.svg |
图标右上角的圆形徽标数字。
何时使用
一般出现在通知图标或头像的右上角，用于显示需要处理的消息条数，通过醒目视觉形式吸引用户处理。
API
Badge
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| color | 自定义小圆点的颜色 | string | - | |
| count | 展示的数字，大于 overflowCount 时显示为 ${overflowCount}+，为 0 时隐藏 |
ReactNode | - | |
| dot | 不展示数字，只有一个小红点 | boolean | false | |
| offset | 设置状态点的位置偏移 | [number, number] | - | |
| overflowCount | 展示封顶的数字值 | number | 99 | |
| showZero | 当数值为 0 时，是否展示 Badge | boolean | false | |
| status | 设置 Badge 为状态点 | success | processing | default | error | warning |
- | |
| size | 在设置了 count 的前提下有效，设置小圆点的大小 |
default | small |
- | 4.6.0 |
| text | 在设置了 status 的前提下有效，设置状态点的文本 |
ReactNode | - | |
| title | 设置鼠标放在状态点上时显示的文字 | string | - |
Badge.Ribbon (4.5.0+)
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| color | 自定义缎带的颜色 | string | - | |
| placement | 缎带的位置，start 和 end 随文字方向（RTL 或 LTR）变动 |
start | end |
end |
|
| text | 缎带中填入的内容 | ReactNode | - |