Badge
The API documentation of the Badge React component.
Props
| Name | Type | Default | Description |
|---|---|---|---|
| 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 | enum: 'default' | 'primary' | 'secondary' | 'error' |
'default' | The color of the component. It supports those theme colors that make sense for this component. |
| component | union: string | func | object |
'span' | The component used for the root node. Either a string to use a DOM element or a component. |
Any other properties supplied will be spread to the root element (native element).
CSS API
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| badge | Styles applied to the badge span element. |
| colorPrimary | Styles applied to the root element if color="primary". |
| colorSecondary | Styles applied to the root element if color="secondary". |
| colorError | Styles applied to the root element if color="error". |
Have a look at overriding with classes section and the implementation of the component for more detail.
If using the overrides key of the theme as documented
here,
you need to use the following style sheet name: MuiBadge.