mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-26 20:20:00 +08:00
1.0 KiB
1.0 KiB
| category | type | title |
|---|---|---|
| Components | Data Display | Badge |
Small numerical value or status descriptors for UI elements.
When To Use
Badge normally appears in proximity to notification or head picture with eye-catching appeal, typically displaying unread messages count.
API
<Badge count={5}>
<a href="#" className="head-example" />
</Badge>
<Badge count={5} />
| Property | Description | Type | Default |
|---|---|---|---|
| count | Number to show in badge | number | |
| overflowCount | Max count to show | number | 99 |
| showZero | Whether to show badge when count is zero |
boolean | false |
| dot | Whether to show red dot without number | boolean | false |
| status | Set Badge as a status dot | Enum{ 'success', 'processing, 'default', 'error', 'warning' } | '' |
| text | If status is set, text is to set the text of status dot |
string | '' |