Skip to content

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

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

Props

Props of the native component are also available.

anchorOrigin

badgeContent

children

classes

color

component

components

componentsProps

invisible

max

overlap

showZero

slotProps

slots

sx

variant

The ref is forwarded to the root element.

Theme default props

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


CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiBadge-root

.MuiBadge-badge

.MuiBadge-dot

.MuiBadge-standard

.MuiBadge-anchorOriginTopRight

.MuiBadge-anchorOriginBottomRight

.MuiBadge-anchorOriginTopLeft

.MuiBadge-anchorOriginBottomLeft

.MuiBadge-invisible

.MuiBadge-colorPrimary

.MuiBadge-colorSecondary

.MuiBadge-colorError

.MuiBadge-colorInfo

.MuiBadge-colorSuccess

.MuiBadge-colorWarning

.MuiBadge-anchorOriginTopRightRectangular

.MuiBadge-anchorOriginBottomRightRectangular

.MuiBadge-anchorOriginTopLeftRectangular

.MuiBadge-anchorOriginBottomLeftRectangular

.MuiBadge-anchorOriginTopRightCircular

.MuiBadge-anchorOriginBottomRightCircular

.MuiBadge-anchorOriginTopLeftCircular

.MuiBadge-anchorOriginBottomLeftCircular

.MuiBadge-overlapRectangular

.MuiBadge-overlapCircular


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