Badge API
API reference docs for the React Badge component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import Badge from '@mui/joy/Badge';
// or
import { Badge } from '@mui/joy';Learn about the difference by reading this guide on minimizing bundle size.
Props of the native component are also available.
| 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. |
| badgeInset | number | string | 0 | The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset. |
| children | node | - | The badge will be added relative to this node. |
| color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'primary' | The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors. |
| component | elementType | - | The component used for the root node. Either a string to use a HTML element or a component. |
| invisible | bool | false | If |
| max | number | 99 | Max count to show. |
| showZero | bool | false | Controls whether the badge is hidden when |
| size | 'sm' | 'md' | 'lg' | string | 'md' | The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes. |
| slotProps | { badge?: func | object, root?: func | object } | {} | The props used for each slot inside. |
| slots | { badge?: elementType, root?: elementType } | {} | The components used for each slot inside. See Slots API below for more details. |
| sx | Array<func | object | bool> | func | object | - | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
| variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'solid' | The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants. |
ref is forwarded to the root element.Theme default props
You can use JoyBadge to change the default props of this component with the theme.
To learn how to customize the slot, check out the Overriding component structure guide.
| Slot name | Class name | Default component | Description |
|---|---|---|---|
| root | .MuiBadge-root | 'span' | The component that renders the root. |
| badge | .MuiBadge-badge | 'span' | The component that renders the badge. |
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
| Class name | Rule name | Description |
|---|---|---|
| .MuiBadge-anchorOriginBottomLeft | anchorOriginBottomLeft | Class name applied to the badge span element if anchorOrigin={{ 'bottom', 'left' }}. |
| .MuiBadge-anchorOriginBottomRight | anchorOriginBottomRight | Class name applied to the badge span element if anchorOrigin={{ 'bottom', 'right' }}. |
| .MuiBadge-anchorOriginTopLeft | anchorOriginTopLeft | Class name applied to the badge span element if anchorOrigin={{ 'top', 'left' }}. |
| .MuiBadge-anchorOriginTopRight | anchorOriginTopRight | Class name applied to the badge span element if anchorOrigin={{ 'top', 'right' }}. |
| .MuiBadge-colorContext | colorContext | Class name applied to the root element when color inversion is triggered. |
| .MuiBadge-colorDanger | colorDanger | Class name applied to the badge span element if color="danger". |
| .MuiBadge-colorNeutral | colorNeutral | Class name applied to the badge span element if color="neutral". |
| .MuiBadge-colorPrimary | colorPrimary | Class name applied to the badge span element if color="primary". |
| .MuiBadge-colorSuccess | colorSuccess | Class name applied to the badge span element if color="success". |
| .MuiBadge-colorWarning | colorWarning | Class name applied to the badge span element if color="warning". |
| .MuiBadge-invisible | invisible | State class applied to the badge span element if invisible={true}. |
| .MuiBadge-locationInside | locationInside | State class applied to the badge span element if location="inside". |
| .MuiBadge-locationOutside | locationOutside | State class applied to the badge span element if location="outside". |
| .MuiBadge-sizeLg | sizeLg | Class name applied to the badge span element if size="lg". |
| .MuiBadge-sizeMd | sizeMd | Class name applied to the badge span element if size="md". |
| .MuiBadge-sizeSm | sizeSm | Class name applied to the badge span element if size="sm". |
| .MuiBadge-variantOutlined | variantOutlined | Class name applied to the badge span element if variant="outlined". |
| .MuiBadge-variantPlain | variantPlain | Class name applied to the root element if variant="plain". |
| .MuiBadge-variantSoft | variantSoft | Class name applied to the badge span element if variant="soft". |
| .MuiBadge-variantSolid | variantSolid | Class name applied to the badge span element if variant="solid". |
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.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.