2016-07-11 11:45:42 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2016-11-09 14:43:32 +08:00
|
|
|
type: Data Display
|
2016-09-21 11:28:38 +08:00
|
|
|
title: Badge
|
2016-07-11 11:45:42 +08:00
|
|
|
---
|
|
|
|
|
|
2017-09-16 11:29:38 +08:00
|
|
|
Small numerical value or status descriptor for UI elements.
|
2016-07-11 11:45:42 +08:00
|
|
|
|
2016-09-10 13:43:30 +08:00
|
|
|
## When To Use
|
2016-07-11 11:45:42 +08:00
|
|
|
|
2017-09-16 11:29:38 +08:00
|
|
|
Badge normally appears in proximity to notifications or user avatars with eye-catching appeal, typically displaying unread messages count.
|
2016-07-11 11:45:42 +08:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
|
<Badge count={5}>
|
2016-08-23 21:00:35 +08:00
|
|
|
<a href="#" className="head-example" />
|
2016-07-11 11:45:42 +08:00
|
|
|
</Badge>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
|
<Badge count={5} />
|
|
|
|
|
```
|
|
|
|
|
|
2017-10-25 10:25:44 +08:00
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| -------- | ----------- | ---- | ------- |
|
2018-11-06 14:45:17 +08:00
|
|
|
| count | Number to show in badge | ReactNode | |
|
2017-10-25 10:25:44 +08:00
|
|
|
| dot | Whether to display a red dot instead of `count` | boolean | `false` |
|
2018-02-11 19:21:12 +08:00
|
|
|
| offset | set offset of the badge dot, like`[x, y]` | `[number, number]` | - |
|
2017-10-25 10:25:44 +08:00
|
|
|
| overflowCount | Max count to show | number | 99 |
|
|
|
|
|
| showZero | Whether to show badge when `count` is zero | boolean | `false` |
|
|
|
|
|
| status | Set Badge as a status dot | `success` \| `processing` \| `default` \| `error` \| `warning` | `''` |
|
|
|
|
|
| text | If `status` is set, `text` sets the display text of the status `dot` | string | `''` |
|
2018-04-10 01:09:18 +08:00
|
|
|
| title | Text to show when hovering over the badge | string | `count` |
|
