ant-design/index.en-US.md at a5f3ac8348d3192db35b3d49d37a9ac82511dfce

mirror of https://github.com/ant-design/ant-design.git synced 2024-11-28 21:19:37 +08:00

* docs: unite boolean in site

* fix demo

* fix boolean

* add

* add

* add

2020-06-17 23:18:14 +08:00

category	type	title	cover
Components	Data Display	Badge	https://gw.alipayobjects.com/zos/antfincdn/6%26GF9WHwvY/Badge.svg

Small numerical value or status descriptor for UI elements.

When To Use

Badge normally appears in proximity to notifications or user avatars with eye-catching appeal, typically displaying unread messages count.

Property	Description	Type	Default
color	Customize Badge dot color	string	-
count	Number to show in badge	ReactNode
dot	Whether to display a red dot instead of `count`	boolean	`false`
offset	set offset of the badge dot	`[number, number]`	-
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
title	Text to show when hovering over the badge	string	`count`