mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 11:40:04 +08:00
c93bd326f4
* docs(update): removed 3.x version description in 4.0-prepare ref #19815 * docs(update): update docs remove carousel/index.zh-CN.md empty version column * docs(update): update docs remove carousel/index.en-US.md empty version column
1.2 KiB
1.2 KiB
| category | subtitle | type | title |
|---|---|---|---|
| Components | 徽标数 | 数据展示 | Badge |
图标右上角的圆形徽标数字。
何时使用
一般出现在通知图标或头像的右上角，用于显示需要处理的消息条数，通过醒目视觉形式吸引用户处理。
API
<Badge count={5}>
<a href="#" className="head-example" />
</Badge>
<Badge count={5} />
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| color | 自定义小圆点的颜色 | string | - | |
| count | 展示的数字，大于 overflowCount 时显示为 ${overflowCount}+，为 0 时隐藏 |
ReactNode | ||
| dot | 不展示数字，只有一个小红点 | boolean | false | |
| offset | 设置状态点的位置偏移，格式为 [x, y] |
[number, number] |
- | |
| overflowCount | 展示封顶的数字值 | number | 99 | |
| showZero | 当数值为 0 时，是否展示 Badge | boolean | false | |
| status | 设置 Badge 为状态点 | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' | |
| text | 在设置了 status 的前提下有效，设置状态点的文本 |
string | '' | |
| title | 设置鼠标放在状态点上时显示的文字 | string | count |