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 | _ |
| variant? | neutralSecondary | neutralPrimary | criticalSecondary | criticalPrimary | positiveSecondary | positivePrimary | cautionSecondary | cautionPrimary | New variant system replacing tone-based styling | positiveSecondary |
| isRounded? | boolean | Controls the border radius of the badge. | false |
| 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 |
positive | neutral | caution | critical | Sets the color of the component | positive |