# Badge

Semantic status indicator badge (success/error/warning/info)



<ComponentPreview base="opentui" name="badge-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/opentui-badge
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="opentui" name="badge" title="components/ui/badge.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { Badge } from "@/components/ui/badge";
```

```tsx
<Badge variant="success">Active</Badge>
```

Examples [#examples]

Basic [#basic]

A basic default badge.

<ComponentPreview base="opentui" name="badge-basic" />

Bold Without Border [#bold-without-border]

Use `bold` and `bordered={false}` for an inline label style.

<ComponentPreview base="opentui" name="badge-bold" />

Custom Border Style [#custom-border-style]

Customize the border style and padding.

<ComponentPreview base="opentui" name="badge-custom-border" />

API Reference [#api-reference]

Badge [#badge]

| Prop          | Type                                                                                         | Default     |
| ------------- | -------------------------------------------------------------------------------------------- | ----------- |
| `children`    | `string`                                                                                     | `required`  |
| `variant`     | `"default" \| "success" \| "warning" \| "error" \| "info" \| "secondary"`                    | `"default"` |
| `color`       | `string`                                                                                     | -           |
| `bold`        | `boolean`                                                                                    | `false`     |
| `bordered`    | `boolean`                                                                                    | `true`      |
| `borderStyle` | `"single" \| "double" \| "round" \| "bold" \| "singleDouble" \| "doubleSingle" \| "classic"` | `"round"`   |
| `paddingX`    | `number`                                                                                     | `1`         |