Badge API
API documentation for the React Badge component. Learn about the available props, and the CSS API.
Import
import Badge from '@material-ui/core/Badge';
// or
import { Badge } from '@material-ui/core';Component name
The nameMuiBadge can be used when providing default props or style overrides in the theme.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. |
| 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 | 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 | object | The system prop that allows defining system overrides as well as additional CSS styles. | |
| variant | 'dot' | 'standard' | string | 'standard' | The variant to use. |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a component. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (BadgeUnstyled).
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 | Styles applied to the root element. |
| badge | .MuiBadge-badge | Styles applied to the badge `span` element. |
| dot | .MuiBadge-dot | Styles applied to the root element if variant="dot". |
| standard | .MuiBadge-standard | Styles applied to the root element if variant="standard". |
| anchorOriginTopRightRectangular | .MuiBadge-anchorOriginTopRightRectangular | Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="rectangular". |
| anchorOriginBottomRightRectangular | .MuiBadge-anchorOriginBottomRightRectangular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular". |
| anchorOriginTopLeftRectangular | .MuiBadge-anchorOriginTopLeftRectangular | Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="rectangular". |
| anchorOriginBottomLeftRectangular | .MuiBadge-anchorOriginBottomLeftRectangular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular". |
| anchorOriginTopRightCircular | .MuiBadge-anchorOriginTopRightCircular | Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="circular". |
| anchorOriginBottomRightCircular | .MuiBadge-anchorOriginBottomRightCircular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="circular". |
| anchorOriginTopLeftCircular | .MuiBadge-anchorOriginTopLeftCircular | Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="circular". |
| anchorOriginBottomLeftCircular | .MuiBadge-anchorOriginBottomLeftCircular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="circular". |
| invisible | .MuiBadge-invisible | Pseudo-class to the badge `span` element if invisible={true}. |
| 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". |
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.