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:

Badge

Import

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

You can learn about the difference by reading this guide on minimizing bundle size.

Props

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. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType		The component used for the root node. Either a string to use a HTML element or a 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. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ badge?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ badge?: elementType, root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyBadge to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Name	Default class	Default HTML tag	Description
root	.MuiBadge-root	'span'	The component that renders the root.
badge	.MuiBadge-badge	'span'	The component that renders the badge.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Global class	Description
.MuiBadge-anchorOriginBottomLeft	Class name applied to the badge `span` element if `anchorOrigin={{ 'bottom', 'left' }}`.
.MuiBadge-anchorOriginBottomRight	Class name applied to the badge `span` element if `anchorOrigin={{ 'bottom', 'right' }}`.
.MuiBadge-anchorOriginTopLeft	Class name applied to the badge `span` element if `anchorOrigin={{ 'top', 'left' }}`.
.MuiBadge-anchorOriginTopRight	Class name applied to the badge `span` element if `anchorOrigin={{ 'top', 'right' }}`.
.MuiBadge-colorContext	Class name applied to the root element when color inversion is triggered.
.MuiBadge-colorDanger	Class name applied to the badge `span` element if `color="danger"`.
.MuiBadge-colorInfo	Class name applied to the badge `span` element if `color="info"`.
.MuiBadge-colorNeutral	Class name applied to the badge `span` element if `color="neutral"`.
.MuiBadge-colorPrimary	Class name applied to the badge `span` element if `color="primary"`.
.MuiBadge-colorSuccess	Class name applied to the badge `span` element if `color="success"`.
.MuiBadge-colorWarning	Class name applied to the badge `span` element if `color="warning"`.
.MuiBadge-invisible	State class applied to the badge `span` element if `invisible={true}`.
.MuiBadge-locationInside	State class applied to the badge `span` element if `location="inside"`.
.MuiBadge-locationOutside	State class applied to the badge `span` element if `location="outside"`.
.MuiBadge-sizeLg	Class name applied to the badge `span` element if `size="lg"`.
.MuiBadge-sizeMd	Class name applied to the badge `span` element if `size="md"`.
.MuiBadge-sizeSm	Class name applied to the badge `span` element if `size="sm"`.
.MuiBadge-variantOutlined	Class name applied to the badge `span` element if `variant="outlined"`.
.MuiBadge-variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiBadge-variantSoft	Class name applied to the badge `span` element if `variant="soft"`.
.MuiBadge-variantSolid	Class name applied to the badge `span` element if `variant="solid"`.