Skip to content

BadgeUnstyled API

API reference docs for the React BadgeUnstyled 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

import BadgeUnstyled from '@mui/base/BadgeUnstyled';
// or
import { BadgeUnstyled } from '@mui/base';
You can 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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
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

NameDefault classDefault valueDescription
badge.MuiBadge-badge'span'The component used to render the badge.
root.MuiBadge-root'span'The component used to render the root.