Skip to content

Badge

Props

API reference for Badge. For usage examples, see the React tab.

NameTypeDefault
badgeContent (required)ReactNode

The Badge content, primarily a number 0-99(+).

borderbooleanfalse

Change the border of Badge to white.

childrenReactNode

The content or child elements nested within this component.

hidebooleanfalse

Set to true, to hide the component. Useful when toggling on/off.

placement"bottomLeft" | "bottomRight" | "topLeft" | "topRight""topRight"

The placement of the Badge in relation to its children anchor.