Badge

FeedbackCompoundBuilt

Count/label indicator.

Also known as:

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

import React from 'react';
import Badge from './components/Badge';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Badge
        variant={props.variant || 'default'}
        size={props.size || 'medium'}
        count={props.count}
        max={props.max}
        dot={props.dot}
      >
        {props.children || 'Badge'}
      </Badge>
    </div>
  );
}

Open Sandbox

Initializing sandbox...

Anatomy

Understanding the structure of the Badge component helps ensure proper implementation and customization.

Component anatomy diagram will be generated based on the actual component structure.

Variants & States

Disabled

Open Sandbox

Initializing sandbox...

API Reference

Props

Props documentation will be auto-generated from the component implementation.

Methods

Method documentation will be extracted from the component interface.

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

Basic Usage

import React from 'react';
import Badge from './components/Badge';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Badge
        variant={props.variant || 'default'}
        size={props.size || 'medium'}
        count={props.count}
        max={props.max}
        dot={props.dot}
      >
        {props.children || 'Badge'}
      </Badge>
    </div>
  );
}

Open Sandbox

Initializing sandbox...

Advanced Usage

import React from 'react';
import Badge from './components/Badge';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Badge
        variant={props.variant || 'default'}
        size={props.size || 'medium'}
        count={props.count}
        max={props.max}
        dot={props.dot}
      >
        {props.children || 'Badge'}
      </Badge>
    </div>
  );
}