Badge API
API reference docs for the React Badge component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Badge from '@mui/joy/Badge';
// or
import { Badge } from '@mui/joy';Props of the native component are also available.
The anchor of the badge.
Type:{ horizontal: 'left'
| 'right', vertical: 'bottom'
| 'top' }
Default:{
vertical: 'top',
horizontal: 'right',
}
The inset of the badge. Support shorthand syntax as described in https://developer.mozilla.org/en-US/docs/Web/CSS/inset.
Type:number
| string
Default:0
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.
Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
Default:'primary'
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
The size of the component.
To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
Type:'sm'
| 'md'
| 'lg'
| string
Default:'md'
The props used for each slot inside.
Type:{ badge?: func
| object, root?: func
| object }
Default:{}
The components used for each slot inside.
See Slots API below for more details.
Type:{ badge?: elementType, root?: elementType }
Default:{}
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
The global variant to use.
To learn how to add your own variants, check out Themed components—Extend variants.
Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
Default:'solid'
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name applied to the badge span element if anchorOrigin={{ 'bottom', 'left' }}.
Rule name:anchorOriginBottomLeft
Class name applied to the badge span element if anchorOrigin={{ 'bottom', 'right' }}.
Rule name:anchorOriginBottomRight
Class name applied to the badge span element if anchorOrigin={{ 'top', 'left' }}.
Rule name:anchorOriginTopLeft
Class name applied to the badge span element if anchorOrigin={{ 'top', 'right' }}.
Rule name:anchorOriginTopRight
Class name applied to the root element when color inversion is triggered.
Rule name:colorContext
Class name applied to the badge span element if color="danger".
Rule name:colorDanger
Class name applied to the badge span element if color="neutral".
Rule name:colorNeutral
Class name applied to the badge span element if color="primary".
Rule name:colorPrimary
Class name applied to the badge span element if color="success".
Rule name:colorSuccess
Class name applied to the badge span element if color="warning".
Rule name:colorWarning
State class applied to the badge span element if invisible={true}.
Rule name:invisible
State class applied to the badge span element if location="inside".
Rule name:locationInside
State class applied to the badge span element if location="outside".
Rule name:locationOutside
Class name applied to the badge span element if variant="outlined".
Rule name:variantOutlined
Class name applied to the root element if variant="plain".
Rule name:variantPlain
Class name applied to the badge span element if variant="soft".
Rule name:variantSoft
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.