neutral, success, error, warning) and four risk tiers (critical, high, medium, low) — plus a dedicated risk prop that resolves Mantine color and variant automatically.
Status: Draft — Badge ships in production and the token contract is defined. Full spec verification is still in progress. Avoid adding new intents or changing token bindings until the component reaches AI-Ready status.
When to use
- Status indicator in a data table row (e.g. “Active”, “Revoked”, “Pending”)
- Severity tier on a security finding (e.g. “Critical”, “High”)
- Count next to a navigation item
- Tag or label on a content item
When not to use
- Tappable or clickable labels. Use Button.
- Selectable tags. Use a chip pattern (not yet specced in Clementine DS).
Usage
Props
Badge extendsMantineBadgeProps and adds one Clementine-specific prop. The package also exports BadgeProps and RiskLevel as named TypeScript types.
Import the types alongside the component:
risk prop resolves internally as follows:
Intents and variants
Badge covers eight intent categories across two groups. Semantic feedback intents:
Risk tier intents:
Use the
risk prop for all four risk tiers — it ensures the correct color/variant pairing without you needing to manage them manually.
Token contract
10 component-tier tokens. Tokens follow the 3-tier cascade: component → semantic → primitive.Badge carries Draft status. The token bindings listed here are current and used in production, but full verification has not been completed. Dark-mode behavior and per-intent foreground tokens may be revised in a future update.
All background tokens resolve to subtle surface-level tints, keeping the badge visually lightweight. The foreground token (
badge.fg.default) uses text.primary for all intents — a per-intent foreground token may be introduced once the reconciliation is complete.
Accessibility
Badge is a presentational component. It carries no required ARIA attributes of its own.The ARIA approach for badges that convey context-critical state is still under review. The
aria_correct gate passes today because Badge is presentational, but additional guidance for parent-level ARIA announcements will be added when the spec advances to AI-Ready.