Badge API
The API documentation of the Badge React component. Learn more about the props and the CSS customization points.
Import
import Badge from '@material-ui/core/Badge';
// or
import { Badge } from '@material-ui/core';You can learn more about the difference by reading this guide.
Component name
The MuiBadge name can be used for providing default props or style overrides at the theme level.
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 | 'span' | The component used for the root node. Either a string to use a HTML element or a component. |
| invisible | bool | If true, the badge will be invisible. |
|
| max | number | 99 | Max count to show. |
| overlap | 'circle' | 'rectangle' | 'circular' | 'rectangular' |
'rectangle' | Wrapped shape the badge should overlap. |
| showZero | bool | false | Controls whether the badge is hidden when badgeContent is zero. |
| variant | 'dot' | 'standard' |
'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". |
| anchorOriginTopRightRectangle | .MuiBadge-anchorOriginTopRightRectangle | Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="rectangle". |
| anchorOriginTopRightRectangular | .MuiBadge-anchorOriginTopRightRectangular | Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="rectangular". |
| anchorOriginBottomRightRectangle | .MuiBadge-anchorOriginBottomRightRectangle | Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangle". |
| anchorOriginBottomRightRectangular | .MuiBadge-anchorOriginBottomRightRectangular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="rectangular". |
| anchorOriginTopLeftRectangle | .MuiBadge-anchorOriginTopLeftRectangle | Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="rectangle". |
| anchorOriginTopLeftRectangular | .MuiBadge-anchorOriginTopLeftRectangular | Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="rectangular". |
| anchorOriginBottomLeftRectangle | .MuiBadge-anchorOriginBottomLeftRectangle | Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangle". |
| anchorOriginBottomLeftRectangular | .MuiBadge-anchorOriginBottomLeftRectangular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="rectangular". |
| anchorOriginTopRightCircle | .MuiBadge-anchorOriginTopRightCircle | Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="circle". |
| anchorOriginTopRightCircular | .MuiBadge-anchorOriginTopRightCircular | Styles applied to the root element if anchorOrigin={{ 'top', 'right' }} overlap="circular". |
| anchorOriginBottomRightCircle | .MuiBadge-anchorOriginBottomRightCircle | Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="circle". |
| anchorOriginBottomRightCircular | .MuiBadge-anchorOriginBottomRightCircular | Styles applied to the root element if anchorOrigin={{ 'bottom', 'right' }} overlap="circular". |
| anchorOriginTopLeftCircle | .MuiBadge-anchorOriginTopLeftCircle | Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="circle". |
| anchorOriginTopLeftCircular | .MuiBadge-anchorOriginTopLeftCircular | Styles applied to the root element if anchorOrigin={{ 'top', 'left' }} overlap="circular". |
| anchorOriginBottomLeftCircle | .MuiBadge-anchorOriginBottomLeftCircle | Styles applied to the root element if anchorOrigin={{ 'bottom', 'left' }} overlap="circle". |
| 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 thanks to one of these customization points:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
overridesproperty.
If that's not sufficient, you can check the implementation of the component for more detail.