Badge

Display short labels, statuses, and metadata.

Overview

Badges are compact visual indicators used to display status, categories, counts, and metadata. MiniKit provides several badge variants for communicating information while maintaining a consistent visual language across your application.

Basic Usage

Create a badge using the data-badge attribute.

Badge
<span data-badge>Badge</span>

Variants

Badges support multiple variants for different semantic meanings.

Default Secondary Success Warning Danger
<div class="hstack">
  <span data-badge>Default</span>
  <span data-badge data-variant="secondary">Secondary</span>
  <span data-badge data-variant="success">Success</span>
  <span data-badge data-variant="warning">Warning</span>
  <span data-badge data-variant="danger">Danger</span>
</div>

Outline

Use the outline class for a less prominent appearance.

Default Secondary Success Warning Danger
<div class="hstack">
  <span data-badge data-style="outline">Default</span>
  <span data-badge data-style="outline" data-variant="secondary">Secondary</span>
  <span data-badge data-style="outline" data-variant="success">Success</span>
  <span data-badge data-style="outline" data-variant="warning">Warning</span>
  <span data-badge data-style="outline" data-variant="danger">Danger</span>
</div>

Sizes

Badges support small and large size modifiers.

Small Default Large
<div class="hstack">
  <span data-badge data-size="sm">Small</span>
  <span data-badge>Default</span>
  <span data-badge data-size="lg">Large</span>
</div>

Accessibility

Badges provide supplemental information and should not be the only method of communicating important status or state changes.

  • Do not rely on color alone to convey meaning.
  • Use descriptive badge text whenever possible.
  • Ensure badges have sufficient color contrast against their background.
  • When badges represent dynamic values or notifications, provide accessible context nearby.

API

Attribute Applies To Description
data-badge <span> Creates a MiniKit badge.
data-variant="secondary" <span> Displays the secondary badge variant.
data-variant="success" <span> Displays the success badge variant.
data-variant="warning" <span> Displays the warning badge variant.
data-variant="danger" <span> Displays the danger badge variant.
data-style="outline" <span> Displays the outline badge style.
data-size="sm" <span> Displays a small badge.
data-size="lg" <span> Displays a large badge.