Badge
Count/label indicator.
- Pill
- Badge count
- Bullet Badge
- Circle Badge
- Chip
- Compound Tag
- Lozenge
- Quantity
- Counter badge
- Counter label
- Notification badge
- Status Badge
- Label Badge
- Count Badge
- Indicator Badge
Overview
Purpose
The Badge component count/label indicator.within our design system. It follows our compound layer principles, ensuring consistency and reusability across applications.
When to Use
- Use when you need providing system feedback
- Appropriate for feedback contexts
- Follows compound component patterns
When Not to Use
- Avoid when simpler alternatives exist
- Don't use for permanent content
- Consider alternatives for edge cases
Live Example
Anatomy
Understanding the structure of the Badge component helps ensure proper implementation and customization.
Anatomy data not yet defined for this component. Define anatomy in the component contract file (Badge.contract.json).
Variants & States
API Reference
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
variant | BadgeVariant | No | "status" with an intent prop. | — |
intent | Intent | No | 'info' | — |
size | ControlSize | No | 'md' | — |
icon | React.ReactNode | null | No | == null) return null | — |
showStatusIcon | boolean | No | true | — |
Accessibility
Standards Compliance
This component follows WCAG 2.1 AA guidelines and includes proper ARIA attributes, keyboard navigation, and screen reader support.
Common Pitfalls
- Too small for accessibility
- color-only distinction.
Accessibility Checklist
- ○ Keyboard navigation support
- ○ Screen reader compatibility
- ○ Color contrast compliance
- ○ Focus management
- ○ ARIA attributes
- ○ Reduced motion support
Usage Guidelines
✓ Do
- Use consistent spacing and sizing
- Follow established patterns
- Provide clear labels and descriptions
- Test with assistive technologies
✗ Don't
- Override core functionality
- Use without proper context
- Ignore accessibility requirements
- Modify without design system approval
Examples
Advanced Usage
Complex patterns including composition, state management, and real-world scenarios.
Development Tools
Use these tools to analyze the component's performance, design tokens, and accessibility during development.
Contribute
Help us improve the Badge component documentation. Found an issue or have suggestions?