2016-03-31 14:17:09 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2016-09-21 11:28:38 +08:00
|
|
|
subtitle: 徽标数
|
2018-11-04 16:20:35 +08:00
|
|
|
type: 数据展示
|
2016-09-21 11:28:38 +08:00
|
|
|
title: Badge
|
2016-03-31 14:17:09 +08:00
|
|
|
---
|
2015-09-01 13:59:07 +08:00
|
|
|
|
2015-09-01 17:16:51 +08:00
|
|
|
图标右上角的圆形徽标数字。
|
2015-09-01 13:59:07 +08:00
|
|
|
|
|
|
|
|
## 何时使用
|
|
|
|
|
|
2015-09-01 17:16:51 +08:00
|
|
|
一般出现在通知图标或头像的右上角，用于显示需要处理的消息条数，通过醒目视觉形式吸引用户处理。
|
2015-09-01 13:59:07 +08:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2015-09-01 17:48:22 +08:00
|
|
|
```jsx
|
2015-11-04 18:02:59 +08:00
|
|
|
<Badge count={5}>
|
2016-08-23 21:00:35 +08:00
|
|
|
<a href="#" className="head-example" />
|
2015-09-01 17:48:22 +08:00
|
|
|
</Badge>
|
|
|
|
|
```
|
|
|
|
|
|
2015-12-18 17:27:22 +08:00
|
|
|
```jsx
|
|
|
|
|
<Badge count={5} />
|
|
|
|
|
```
|
|
|
|
|
|
2017-10-25 10:25:44 +08:00
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
|
|
|
| --- | --- | --- | --- |
|
2018-11-06 13:38:51 +08:00
|
|
|
| count | 展示的数字，大于 overflowCount 时显示为 `${overflowCount}+`，为 0 时隐藏 | ReactNode | |
|
2017-10-25 10:25:44 +08:00
|
|
|
| dot | 不展示数字，只有一个小红点 | boolean | false |
|
2018-02-11 19:21:12 +08:00
|
|
|
| offset | 设置状态点的位置偏移，格式为 `[x, y]` | `[number, number]` | - |
|
2017-10-25 10:25:44 +08:00
|
|
|
| overflowCount | 展示封顶的数字值 | number | 99 |
|
|
|
|
|
| showZero | 当数值为 0 时，是否展示 Badge | boolean | false |
|
|
|
|
|
| status | 设置 Badge 为状态点 | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' |
|
|
|
|
|
| text | 在设置了 `status` 的前提下有效，设置状态点的文本 | string | '' |
|
2018-04-10 01:09:18 +08:00
|
|
|
| title | 设置鼠标放在状态点上时显示的文字 | string | `count` |
|
