Badge API
API documentation for the React Badge component. Learn about the available props and the CSS API.
Import
import Badge from '@mui/material/Badge';
// or
import { Badge } from '@mui/material';Component name
The nameMuiBadge can be used when providing default props or style overrides in the theme.Props
Props of the BadgeUnstyled component are also available.
| 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' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'default' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a 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. |
| componentsProps | { badge?: object, root?: object } | {} | The props used for each slot inside the Badge. |
| invisible | bool | false | If true, the badge is invisible. |
| max | number | 99 | Max count to show. |
| overlap | 'circular' | 'rectangular' | 'rectangular' | Wrapped shape the badge should overlap. |
| showZero | bool | false | Controls whether the badge is hidden when badgeContent is zero. |
| sx | Array<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 | 'dot' | 'standard' | string | 'standard' | The variant to use. |
The
ref is forwarded to the root element.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 name | Global class | Description |
|---|---|---|
| root | .MuiBadge-root | Class name applied to the root element. |
| badge | .MuiBadge-badge | Class name applied to the badge `span` element. |
| dot | .MuiBadge-dot | Class name applied to the badge `span` element if variant="dot". |
| standard | .MuiBadge-standard | Class name applied to the badge `span` element if variant="standard". |
| anchorOriginTopRight | .MuiBadge-anchorOriginTopRight | Class name applied to the badge `span` element if anchorOrigin={{ 'top', 'right' }}. |
| anchorOriginBottomRight | .MuiBadge-anchorOriginBottomRight | Class name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'right' }}. |
| anchorOriginTopLeft | .MuiBadge-anchorOriginTopLeft | Class name applied to the badge `span` element if anchorOrigin={{ 'top', 'left' }}. |
| anchorOriginBottomLeft | .MuiBadge-anchorOriginBottomLeft | Class name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'left' }}. |
| invisible | .MuiBadge-invisible | State class applied to the badge `span` element if invisible={true}. |
| colorPrimary | .MuiBadge-colorPrimary | Styles applied to the badge `span` element if color="primary". |
| colorSecondary | .MuiBadge-colorSecondary | Styles applied to the badge `span` element if color="secondary". |
| colorError | .MuiBadge-colorError | Styles applied to the badge `span` element if color="error". |
| colorInfo | .MuiBadge-colorInfo | Styles applied to the badge `span` element if color="info". |
| colorSuccess | .MuiBadge-colorSuccess | Styles applied to the badge `span` element if color="success". |
| colorWarning | .MuiBadge-colorWarning | Styles applied to the badge `span` element if color="warning". |
| anchorOriginTopRightRectangular | .MuiBadge-anchorOriginTopRightRectangular | Class name applied to the badge `span` element if anchorOrigin={{ 'top', 'right' }} overlap="rectangular". |
| anchorOriginBottomRightRectangular | .MuiBadge-anchorOriginBottomRightRectangular | Class name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular". |
| anchorOriginTopLeftRectangular | .MuiBadge-anchorOriginTopLeftRectangular | Class name applied to the badge `span` element if anchorOrigin={{ 'top', 'left' }} overlap="rectangular". |
| anchorOriginBottomLeftRectangular | .MuiBadge-anchorOriginBottomLeftRectangular | Class name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular". |
| anchorOriginTopRightCircular | .MuiBadge-anchorOriginTopRightCircular | Class name applied to the badge `span` element if anchorOrigin={{ 'top', 'right' }} overlap="circular". |
| anchorOriginBottomRightCircular | .MuiBadge-anchorOriginBottomRightCircular | Class name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'right' }} overlap="circular". |
| anchorOriginTopLeftCircular | .MuiBadge-anchorOriginTopLeftCircular | Class name applied to the badge `span` element if anchorOrigin={{ 'top', 'left' }} overlap="circular". |
| anchorOriginBottomLeftCircular | .MuiBadge-anchorOriginBottomLeftCircular | Class name applied to the badge `span` element if anchorOrigin={{ 'bottom', 'left' }} overlap="circular". |
| overlapRectangular | .MuiBadge-overlapRectangular | Class name applied to the badge `span` element if overlap="rectangular". |
| overlapCircular | .MuiBadge-overlapCircular | Class name applied to the badge `span` element if overlap="circular". |
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
styleOverridesproperty in a custom theme.