Badge API

API reference docs for the React Badge component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import Badge from '@mui/joy/Badge';
// or
import { Badge } from '@mui/joy';

The name JoyBadge can be used when providing default props or style overrides in the theme.

Props of the native component are also available.

Name	Type	Default	Description
anchorOrigin	{ horizontal: 'left' \| 'right', vertical: 'bottom' \| 'top' }	{ vertical: 'top', horizontal: 'right', }	The anchor of the badge.
badgeContent	node	''	The content rendered within the badge.
badgeInset	number \| string	0	The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset.
children	node		The badge will be added relative to this node.
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'primary'	The color of the component. It supports those theme colors that make sense for this component.
invisible	bool	false	If `true`, the badge is invisible.
max	number	99	Max count to show.
showZero	bool	false	Controls whether the badge is hidden when `badgeContent` is zero.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'solid'	The variant to use.

The ref is forwarded to the root element.