Badge API

API reference docs for theBadgecomponent. For examples and details on the usage of this component, visit the component demo page.

Props

Prop

Type

Description

Default

children

React.ReactNode

The content of the component

_

iconStart?

(props: IconProps) => React.ReactNode

The icon to be displayed at the start of the component. It will be rendered at 16px.

_

size?

standard | small

The size of the component

standard

tone?

positive | neutral | caution | critical

Sets the color of the component

positive