Skip to content

Badge API

API documentation for the React Badge component. Learn about the available props, and the CSS API.

Import

import Badge from '@material-ui/core/Badge';
// or
import { Badge } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiBadge can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
anchorOrigin{ horizontal: 'left'
| 'right', vertical: 'bottom'
| 'top' }
{ vertical: 'top', horizontal: 'right', }The anchor of the badge.
badgeContentnodeThe content rendered within the badge.
childrennodeThe badge will be added relative to this node.
classesobject{}Override or extend the styles applied to the component. See CSS API below for more details.
color'default'
| 'error'
| 'primary'
| 'secondary'
'default'The color of the component. It supports those theme colors that make sense for this component.
components{ Badge?: elementType, Root?: elementType }{}The components used for each slot inside the Badge. Either a string to use a HTML element or a component.
componentsPropsobject{}The props used for each slot inside the Badge.
invisibleboolfalseIf true, the badge is invisible.
maxnumber99Max count to show.
overlap'circular'
| 'rectangular'
'rectangular'Wrapped shape the badge should overlap.
showZeroboolfalseControls whether the badge is hidden when badgeContent is zero.
sxobjectThe system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'dot'
| 'standard'
| string
'standard'The variant to use.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (BadgeUnstyled).

Inheritance

While not explicitly documented above, the props of the BadgeUnstyled component are also available on Badge. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiBadge-rootClass name applied to the root element.
badge.MuiBadge-badgeClass name applied to the badge `span` element.
dot.MuiBadge-dotClass name applied to the badge `span` element if variant="dot".
standard.MuiBadge-standardClass name applied to the badge `span` element if variant="standard".
anchorOriginTopRightRectangular.MuiBadge-anchorOriginTopRightRectangularClass name applied to the badge `span` element if anchorOrigin={{ 'top', 'right' }} overlap="rectangular".
anchorOriginBottomRightRectangular.MuiBadge-anchorOriginBottomRightRectangularClass name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular".
anchorOriginTopLeftRectangular.MuiBadge-anchorOriginTopLeftRectangularClass name applied to the badge `span` element if anchorOrigin={{ 'top', 'left' }} overlap="rectangular".
anchorOriginBottomLeftRectangular.MuiBadge-anchorOriginBottomLeftRectangularClass name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular".
anchorOriginTopRightCircular.MuiBadge-anchorOriginTopRightCircularClass name applied to the badge `span` element if anchorOrigin={{ 'top', 'right' }} overlap="circular".
anchorOriginBottomRightCircular.MuiBadge-anchorOriginBottomRightCircularClass name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'right' }} overlap="circular".
anchorOriginTopLeftCircular.MuiBadge-anchorOriginTopLeftCircularClass name applied to the badge `span` element if anchorOrigin={{ 'top', 'left' }} overlap="circular".
anchorOriginBottomLeftCircular.MuiBadge-anchorOriginBottomLeftCircularClass name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'left' }} overlap="circular".
invisible.MuiBadge-invisiblePseudo-class applied to the badge `span` element if invisible={true}.
colorPrimary.MuiBadge-colorPrimaryStyles applied to the badge `span` element if color="primary".
colorSecondary.MuiBadge-colorSecondaryStyles applied to the badge `span` element if color="secondary".
colorError.MuiBadge-colorErrorStyles applied to the badge `span` element if color="error".

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

Demos