Skip to content

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.

4
Press Enter to start editing

Color

Use color prop to apply theme palette to component.

44
Press Enter to start editing

Customization

Here is an example of customizing the component. You can learn more about this in the overrides documentation page.

Press Enter to start editing

Badge visibility

The visibility of badges can be controlled using the invisible prop.

1

The badge hides automatically when badgeContent is zero. You can override this with the showZero prop.

0
Press Enter to start editing

Maximum value

You can use the max prop to cap the value of the badge content.

9999+999+
Press Enter to start editing

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.

Press Enter to start editing

Badge overlap

You can use the overlap prop to place the badge relative to the corner of the wrapped element.

Press Enter to start editing

Badge alignment

You can use the anchorOrigin prop to move the badge to any corner of the wrapped element.

Vertical
Horizontal
11299+999+
<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:

Press Enter to start editing

Unstyled

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.