From 81e342995565340d0e7f6b48f037b737bd59c7e1 Mon Sep 17 00:00:00 2001 From: Khalifa Lame Date: Sat, 16 Sep 2017 04:29:38 +0100 Subject: [PATCH] Update Badge English doc (#7628) * Update Badge English doc Fixed typos. * Update index.en-US.md Reverted some changes after studying the component. --- components/badge/index.en-US.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/components/badge/index.en-US.md b/components/badge/index.en-US.md index 831a13f470..69d19b6684 100644 --- a/components/badge/index.en-US.md +++ b/components/badge/index.en-US.md @@ -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 | `''` |