Skip to content
+

Badge

The Badge component generates a small label that is attached to its child element.

Badge API

Import

import { Badge } from '@mui/base/Badge';
// or
import { Badge } from '@mui/base';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
badgeContentnode-

The content rendered within the badge.

childrennode-

The badge will be added relative to this node.

invisibleboolfalse

If true, the badge is invisible.

maxnumber99

Max count to show.

showZeroboolfalse

Controls whether the badge is hidden when badgeContent is zero.

slotProps{ badge?: func
| object, root?: func
| object }
{}

The props used for each slot inside the Badge.

slots{ badge?: elementType, root?: elementType }{}

The components used for each slot inside the Badge. Either a string to use a HTML element or a component.

See Slots API below for more details.


The ref is forwarded to the root element.

Slots

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

Slot nameClass nameDefault componentDescription
root.base-Badge-root'span'The component that renders the root.
badge.base-Badge-badge'span'The component that renders the badge.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameDescription
.base-Badge-invisibleState class applied to the badge span element if invisible={true}.