|
|
|
@ -4,11 +4,11 @@ type: Data Display
|
|
|
|
|
title: Badge
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Small numerical value or status descriptors for UI elements.
|
|
|
|
|
Small numerical value or status descriptor 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.
|
|
|
|
|
Badge normally appears in proximity to notifications or user avatars with eye-catching appeal, typically displaying unread messages count.
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
@ -27,7 +27,7 @@ Badge normally appears in proximity to notification or head picture with eye-cat
|
|
|
|
|
|----------------|-------------------------|------------|---------|
|
|
|
|
|
| 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 | '' |
|
|
|
|
|
| showZero | Whether to show badge when `count` is zero | boolean | `false` |
|
|
|
|
|
| dot | Whether to display a red dot instead of `count` | 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 | `''` |
|
|
|
|
|