# Badge

shadcn's badge in Candor's theme.

- Registry name: `badge` (`@candor/badge`)
- Tier: Pro. Installing it needs a Pro, Premium or Team licence key: the person runs `npx candor-ui key <key>` themselves; never ask for the key in chat or write it to a file.
- Docs: https://candor.themethodic.com/docs/badge

## Install

```bash
npx candor-ui add badge
```

Run `npx candor-ui@latest init` once first (https://candor.themethodic.com/get-started.md). Without the CLI: `npx shadcn@latest add @candor/badge`.
It brings in: render-prop, utils.
npm packages: class-variance-authority@^0.7.1, radix-ui@^1.8.1.

## Example

```tsx
"use client"

import { Check, LoaderCircle, TriangleAlert } from "lucide-react"
import { Badge } from "@/components/ui/badge"

export default function Example() {
  return (
    <div className="flex flex-wrap items-center gap-2">
      <Badge variant="destructive">Production</Badge>
      <Badge variant="outline">Staging</Badge>
      <Badge variant="running">
        <LoaderCircle aria-hidden className="animate-spin" /> Migrating
      </Badge>
      <Badge variant="success">
        <Check aria-hidden /> Tests passed
      </Badge>
      <Badge variant="warning">
        <TriangleAlert aria-hidden /> Needs approval
      </Badge>
      <Badge variant="secondary">3 flags</Badge>
    </div>
  )
}
```

## <Badge>

Props:

- `asChild?: boolean | undefined`: Renders its child element with the badge's styles instead of a span.

Also takes the props of `React.ComponentProps<"span">`, `VariantProps<typeof badgeVariants>`, `RenderProp`.

## Rules for using Candor UI

- Components take plain typed data. Never pass model output as HTML or render it as a link; messages are typed blocks.
- A control that can't be used says why: wrap it in `<Locked reason="…">`, don't just disable it.
- Don't show a value you don't have: leave it out (it renders as —) rather than guess. An estimate is labelled as one.
- Nothing is pre-selected in a decision a person makes, and the agent is named from your app's data, never from model output.
- Your app's words go in `LocaleProvider` (fixed strings) and `TermsProvider` (nouns); entity kinds and agent roles in `EntityKindsProvider` and `AgentRolesProvider`.