ant-design/components/badge/index.en-US.md

category	type	title
Components	Data Display	Badge

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.

API

<Badge count={5}>
  <a href="#" className="head-example" />
</Badge>

<Badge count={5} />

Property	Description	Type	Default
count	Number to show in badge	number|ReactNode
dot	Whether to display a red dot instead of count	boolean	false
offset	set offset of the badge dot, like [x, y]	[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	''