test/ant-design
1
0
Fork 0
mirror of https://gitee.com/ant-design/ant-design.git synced 2024-11-30 19:19:26 +08:00
Code Issues Actions 68 Packages Projects Releases Wiki Activity

Update Badge English doc (#7628)

Browse Source 
* Update Badge English doc

Fixed typos.

* Update index.en-US.md

Reverted some changes after studying the component.
This commit is contained in:
Khalifa Lame 2017-09-16 04:29:38 +01:00 committed by niko
parent 05fbdd0959
commit 81e3429955
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/badge/index.en-US.md
View File

@ -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 | `''` |