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

Import

import Badge from '@mui/joy/Badge';
// or
import { Badge } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

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

The anchor of the badge.

badgeContentnode''

The content rendered within the badge.

badgeInsetnumber
| string
0

The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset.

childrennode-

The badge will be added relative to this node.

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'primary'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

componentelementType-

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

invisibleboolfalse

If true, the badge is invisible.

maxnumber99

Max count to show.

showZeroboolfalse

Controls whether the badge is hidden when badgeContent is zero.

size'sm'
| 'md'
| 'lg'
| string
'md'

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

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

The props used for each slot inside.

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

The components used for each slot inside.

See Slots API below for more details.

sxArray<func
| object
| bool>
| func
| object
-

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

See the `sx` page for more details.

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'solid'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

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

Slots

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

Slot nameClass nameDefault componentDescription
root.MuiBadge-root'span'The component that renders the root.
badge.MuiBadge-badge'span'The component that renders the badge.

CSS classes

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

Class nameRule nameDescription
.MuiBadge-anchorOriginBottomLeftanchorOriginBottomLeftClass name applied to the badge span element if anchorOrigin={{ 'bottom', 'left' }}.
.MuiBadge-anchorOriginBottomRightanchorOriginBottomRightClass name applied to the badge span element if anchorOrigin={{ 'bottom', 'right' }}.
.MuiBadge-anchorOriginTopLeftanchorOriginTopLeftClass name applied to the badge span element if anchorOrigin={{ 'top', 'left' }}.
.MuiBadge-anchorOriginTopRightanchorOriginTopRightClass name applied to the badge span element if anchorOrigin={{ 'top', 'right' }}.
.MuiBadge-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiBadge-colorDangercolorDangerClass name applied to the badge span element if color="danger".
.MuiBadge-colorNeutralcolorNeutralClass name applied to the badge span element if color="neutral".
.MuiBadge-colorPrimarycolorPrimaryClass name applied to the badge span element if color="primary".
.MuiBadge-colorSuccesscolorSuccessClass name applied to the badge span element if color="success".
.MuiBadge-colorWarningcolorWarningClass name applied to the badge span element if color="warning".
.MuiBadge-invisibleinvisibleState class applied to the badge span element if invisible={true}.
.MuiBadge-locationInsidelocationInsideState class applied to the badge span element if location="inside".
.MuiBadge-locationOutsidelocationOutsideState class applied to the badge span element if location="outside".
.MuiBadge-sizeLgsizeLgClass name applied to the badge span element if size="lg".
.MuiBadge-sizeMdsizeMdClass name applied to the badge span element if size="md".
.MuiBadge-sizeSmsizeSmClass name applied to the badge span element if size="sm".
.MuiBadge-variantOutlinedvariantOutlinedClass name applied to the badge span element if variant="outlined".
.MuiBadge-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiBadge-variantSoftvariantSoftClass name applied to the badge span element if variant="soft".
.MuiBadge-variantSolidvariantSolidClass name applied to the badge span element if variant="solid".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.