Badge API
API reference docs for the React Badge component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Badge from '@mui/material/Badge';
// or
import { Badge } from '@mui/material';
Props of the native component are also available.
The anchor of the badge.
Type:{ horizontal: 'left'
| 'right', vertical: 'bottom'
| 'top' }
Default:{
vertical: 'top',
horizontal: 'right',
}
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
Type:'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
Default:'default'
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
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:{}
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:{}
The props used for each slot inside the Badge.
Type:{ badge?: func
| object, root?: func
| object }
Default:{}
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
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the badge span
element if anchorOrigin={{ 'bottom', 'left' }}
.
Rule name:anchorOriginBottomLeft
Styles applied to the badge span
element if anchorOrigin={{ 'bottom', 'left' }} overlap="circular"
.
Rule name:anchorOriginBottomLeftCircular
Styles applied to the badge span
element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular"
.
Rule name:anchorOriginBottomLeftRectangular
Styles applied to the badge span
element if anchorOrigin={{ 'bottom', 'right' }}
.
Rule name:anchorOriginBottomRight
Styles applied to the badge span
element if anchorOrigin={{ 'bottom', 'right' }} overlap="circular"
.
Rule name:anchorOriginBottomRightCircular
Styles applied to the badge span
element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular"
.
Rule name:anchorOriginBottomRightRectangular
Styles applied to the badge span
element if anchorOrigin={{ 'top', 'left' }}
.
Rule name:anchorOriginTopLeft
Styles applied to the badge span
element if anchorOrigin={{ 'top', 'left' }} overlap="circular"
.
Rule name:anchorOriginTopLeftCircular
Styles applied to the badge span
element if anchorOrigin={{ 'top', 'left' }} overlap="rectangular"
.
Rule name:anchorOriginTopLeftRectangular
Styles applied to the badge span
element if anchorOrigin={{ 'top', 'right' }}
.
Rule name:anchorOriginTopRight
Styles applied to the badge span
element if anchorOrigin={{ 'top', 'right' }} overlap="circular"
.
Rule name:anchorOriginTopRightCircular
Styles applied to the badge span
element if anchorOrigin={{ 'top', 'right' }} overlap="rectangular"
.
Rule name:anchorOriginTopRightRectangular
Styles applied to the badge span
element if color="primary"
.
Rule name:colorPrimary
Styles applied to the badge span
element if color="secondary"
.
Rule name:colorSecondary
Styles applied to the badge span
element if color="success"
.
Rule name:colorSuccess
Styles applied to the badge span
element if color="warning"
.
Rule name:colorWarning
State class applied to the badge span
element if invisible={true}
.
Rule name:invisible
Styles applied to the badge span
element if overlap="circular"
.
Rule name:overlapCircular
Styles applied to the badge span
element if overlap="rectangular"
.
Rule name:overlapRectangular
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.