Skip to content
Edit this page

Badge API

The API documentation of the Badge React component. Learn more about the props and the CSS customization points.

Import

import Badge from '@material-ui/core/Badge';
// or
import { Badge } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Props

Name Type Default Description
anchorOrigin { horizontal: 'left'
| 'right', vertical: 'bottom'
| 'top' }		 { vertical: 'top', horizontal: 'right',} The anchor of the badge.
badgeContent node The content rendered within the badge.
children node The badge will be added relative to this node.
classes object 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.
component elementType 'span' The component used for the root node. Either a string to use a DOM element or a component.
invisible bool If true, the badge will be invisible.
max number 99 Max count to show.
overlap 'circle'
| 'rectangle'		 'rectangle' Wrapped shape the badge should overlap.
showZero bool false Controls whether the badge is hidden when badgeContent is zero.
variant 'dot'
| 'standard'		 'standard' The variant to use.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

  • Style sheet name: MuiBadge.
  • Style sheet details:
Rule name Global class Description
root .MuiBadge-root Styles applied to the root element.
badge .MuiBadge-badge Styles applied to the badge span element.
colorPrimary .MuiBadge-colorPrimary Styles applied to the root element if color="primary".
colorSecondary .MuiBadge-colorSecondary Styles applied to the root element if color="secondary".
colorError .MuiBadge-colorError Styles applied to the root element if color="error".
dot .MuiBadge-dot Styles applied to the root element if variant="dot".
anchorOriginTopRightRectangle .MuiBadge-anchorOriginTopRightRectangle Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="rectangle".
anchorOriginBottomRightRectangle .MuiBadge-anchorOriginBottomRightRectangle Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangle".
anchorOriginTopLeftRectangle .MuiBadge-anchorOriginTopLeftRectangle Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="rectangle".
anchorOriginBottomLeftRectangle .MuiBadge-anchorOriginBottomLeftRectangle Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangle".
anchorOriginTopRightCircle .MuiBadge-anchorOriginTopRightCircle Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="circle".
anchorOriginBottomRightCircle .MuiBadge-anchorOriginBottomRightCircle Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="circle".
anchorOriginTopLeftCircle .MuiBadge-anchorOriginTopLeftCircle Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="circle".
anchorOriginBottomLeftCircle .MuiBadge-anchorOriginBottomLeftCircle Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="circle".
invisible .MuiBadge-invisible Pseudo-class to the badge span element if invisible={true}.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos