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. |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
| 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. |
| variant | 'dot' | 'standard' | string | 'standard' | The variant to use. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (native element).
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. |
| 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". |
| 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}. |
You can override the style of the component using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.