# Badge

Compact status pill for tagging, categorisation, and inline emphasis.

**Install:** `nimbus-docs add badge`  
**Source:** `src/components/ui/badge/`  
**Canonical:** https://nimbus-docs.com/components/badge/

## Agent payload (JSON)

```json
{
  "slug": "badge",
  "name": "Badge",
  "description": "Small status / category pill.",
  "tagline": "Compact status pill for tagging, categorisation, and inline emphasis.",
  "install": "nimbus-docs add badge",
  "sourcePath": "src/components/ui/badge/",
  "canonicalUrl": "https://nimbus-docs.com/components/badge/",
  "props": [
    {
      "name": "text",
      "type": "string",
      "required": true,
      "description": "Label rendered inside the badge."
    },
    {
      "name": "variant",
      "type": "\"default\" | \"info\" | \"note\" | \"success\" | \"tip\" | \"warning\" | \"caution\" | \"danger\"",
      "defaultValue": "\"default\"",
      "required": false,
      "description": "Visual treatment that conveys intent. Starlight aliases collapse onto the four canonical pairs: note→info, tip→success, caution→warning."
    },
    {
      "name": "size",
      "type": "\"small\" | \"medium\" | \"large\"",
      "defaultValue": "\"small\"",
      "required": false,
      "description": "Relative scale; affects padding and font size."
    }
  ],
  "registryDependencies": [
    "cn"
  ],
  "dependencies": []
}
```