Badge
Badge generates a small badge to the top-right of its child(ren).
Basic badge
Examples of badges containing text, using primary and secondary colors. The badge is applied to its children.
Color
Use color prop to apply theme palette to component.
Customization
Here is an example of customizing the component. You can learn more about this in the overrides documentation page.
Badge visibility
The visibility of badges can be controlled using the invisible prop.
The badge hides automatically when badgeContent is zero. You can override this with the showZero prop.
Maximum value
You can use the max prop to cap the value of the badge content.
Dot badge
The dot prop changes a badge into a small dot. This can be used as a notification that something has changed without giving a count.
Badge overlap
You can use the overlap prop to place the badge relative to the corner of the wrapped element.
Badge alignment
You can use the anchorOrigin prop to move the badge to any corner of the wrapped element.
<Badge
anchorOrigin={{
vertical: 'top',
horizontal: 'right',
}}
>Accessibility
You can't rely on the content of the badge to be announced correctly.
You should provide a full description, for instance, with aria-label:
Unstyled
Use the Base UI Badge for complete ownership of the component's design, with no Material UI or Joy UI styles to override. This unstyled version of the component is the ideal choice for heavy customization with a smaller bundle size.