Badge API

API reference docs for the React Badge component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

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

Avatar
Badge

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

The anchor of the badge.

Type:{ horizontal: 'left' | 'right', vertical: 'bottom' | 'top' }

Default:{ vertical: 'top', horizontal: 'right', }

badgeContent

The content rendered within the badge.

Type:node

children

The badge will be added relative to this node.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Default:'default'

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

components

The components used for each slot inside.
This prop is an alias for the slots prop. It's recommended to use the slots prop instead.

Type:{ Badge?: elementType, Root?: elementType }

Default:{}

componentsProps

The extra props for the slot components. You can override the existing props or add new ones.
This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.

Type:{ badge?: func | object, root?: func | object }

Default:{}

invisible

If true, the badge is invisible.

Type:bool

Default:false

max

Max count to show.

Type:number

Default:99

overlap

Wrapped shape the badge should overlap.

Type:'circular' | 'rectangular'

Default:'rectangular'

showZero

Controls whether the badge is hidden when badgeContent is zero.

Type:bool

Default:false

slotProps

The props used for each slot inside the Badge.

Type:{ badge?: func | object, root?: func | object }

Default:{}

slots

The components used for each slot inside the Badge. Either a string to use a HTML element or a component.

Type:{ badge?: elementType, root?: elementType }

Default:{}

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

variant

The variant to use.

Type:'dot' | 'standard' | string

Default:'standard'

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiBadge-anchorOriginBottomLeft

Styles applied to the badge span element if anchorOrigin={{ 'bottom', 'left' }}.

Rule name:anchorOriginBottomLeft

.MuiBadge-anchorOriginBottomLeftCircular

Styles applied to the badge span element if anchorOrigin={{ 'bottom', 'left' }} overlap="circular".

Rule name:anchorOriginBottomLeftCircular

.MuiBadge-anchorOriginBottomLeftRectangular

Styles applied to the badge span element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular".

Rule name:anchorOriginBottomLeftRectangular

.MuiBadge-anchorOriginBottomRight

Styles applied to the badge span element if anchorOrigin={{ 'bottom', 'right' }}.

Rule name:anchorOriginBottomRight

.MuiBadge-anchorOriginBottomRightCircular

Styles applied to the badge span element if anchorOrigin={{ 'bottom', 'right' }} overlap="circular".

Rule name:anchorOriginBottomRightCircular

.MuiBadge-anchorOriginBottomRightRectangular

Styles applied to the badge span element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular".

Rule name:anchorOriginBottomRightRectangular

.MuiBadge-anchorOriginTopLeft

Styles applied to the badge span element if anchorOrigin={{ 'top', 'left' }}.

Rule name:anchorOriginTopLeft

.MuiBadge-anchorOriginTopLeftCircular

Styles applied to the badge span element if anchorOrigin={{ 'top', 'left' }} overlap="circular".

Rule name:anchorOriginTopLeftCircular

.MuiBadge-anchorOriginTopLeftRectangular

Styles applied to the badge span element if anchorOrigin={{ 'top', 'left' }} overlap="rectangular".

Rule name:anchorOriginTopLeftRectangular

.MuiBadge-anchorOriginTopRight

Styles applied to the badge span element if anchorOrigin={{ 'top', 'right' }}.

Rule name:anchorOriginTopRight

.MuiBadge-anchorOriginTopRightCircular

Styles applied to the badge span element if anchorOrigin={{ 'top', 'right' }} overlap="circular".

Rule name:anchorOriginTopRightCircular

.MuiBadge-anchorOriginTopRightRectangular

Styles applied to the badge span element if anchorOrigin={{ 'top', 'right' }} overlap="rectangular".

Rule name:anchorOriginTopRightRectangular

.MuiBadge-badge

Styles applied to the badge span element.

Rule name:badge

.MuiBadge-colorError

Styles applied to the badge span element if color="error".

Rule name:colorError

.MuiBadge-colorInfo

Styles applied to the badge span element if color="info".

Rule name:colorInfo

.MuiBadge-colorPrimary

Styles applied to the badge span element if color="primary".

Rule name:colorPrimary

.MuiBadge-colorSecondary

Styles applied to the badge span element if color="secondary".

Rule name:colorSecondary

.MuiBadge-colorSuccess

Styles applied to the badge span element if color="success".

Rule name:colorSuccess

.MuiBadge-colorWarning

Styles applied to the badge span element if color="warning".

Rule name:colorWarning

.MuiBadge-dot

Styles applied to the badge span element if variant="dot".

Rule name:dot

.MuiBadge-invisible

State class applied to the badge span element if invisible={true}.

Rule name:invisible

.MuiBadge-overlapCircular

Styles applied to the badge span element if overlap="circular".

Rule name:overlapCircular

.MuiBadge-overlapRectangular

Styles applied to the badge span element if overlap="rectangular".

Rule name:overlapRectangular

.MuiBadge-root

Styles applied to the root element.

Rule name:root

.MuiBadge-standard

Styles applied to the badge span element if variant="standard".

Rule name:standard

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.