BadgeUnstyled API
API documentation for the React BadgeUnstyled component. Learn about the available props and the CSS API.
Import
import BadgeUnstyled from '@mui/base/BadgeUnstyled';
// or
import { BadgeUnstyled } from '@mui/base';Props
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| badgeContent | node | The content rendered within the badge. | |
| children | node | The badge will be added relative to this node. | |
| 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?: func | object, root?: func | 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. |
| showZero | bool | false | Controls whether the badge is hidden when badgeContent is zero. |
The
ref is forwarded to the root element.