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.


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


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 of the native component are also available.

The content rendered within the badge.
The badge will be added relative to this node.
The component used for the root node. Either a string to use a HTML element or a component.
If true, the badge is invisible.
Max count to show.
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.


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

NameDefault classDefault HTML tagDescription
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: