> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/shadcn-ui/ui/llms.txt
> Use this file to discover all available pages before exploring further.

# Badge

> Displays a badge or a component that looks like a badge.

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npx shadcn@latest add badge
  ```

  ```bash yarn theme={null}
  yarn dlx shadcn@latest add badge
  ```

  ```bash pnpm theme={null}
  pnpm dlx shadcn@latest add badge
  ```
</CodeGroup>

## Usage

```tsx theme={null}
import { Badge } from "@/components/ui/badge"
```

```tsx theme={null}
<Badge>Badge</Badge>
```

## Component Code

```tsx theme={null}
import * as React from "react"
import { cva, type VariantProps } from "class-variance-authority"
import { Slot } from "radix-ui"
import { cn } from "@/lib/utils"

const badgeVariants = cva(
  "inline-flex w-fit shrink-0 items-center justify-center gap-1 overflow-hidden rounded-full border border-transparent px-2 py-0.5 text-xs font-medium whitespace-nowrap transition-[color,box-shadow] focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 [&>svg]:pointer-events-none [&>svg]:size-3",
  {
    variants: {
      variant: {
        default: "bg-primary text-primary-foreground [a&]:hover:bg-primary/90",
        secondary:
          "bg-secondary text-secondary-foreground [a&]:hover:bg-secondary/90",
        destructive:
          "bg-destructive text-white [a&]:hover:bg-destructive/90",
        outline:
          "border-border text-foreground [a&]:hover:bg-accent [a&]:hover:text-accent-foreground",
        ghost: "[a&]:hover:bg-accent [a&]:hover:text-accent-foreground",
        link: "text-primary underline-offset-4 [a&]:hover:underline",
      },
    },
    defaultVariants: {
      variant: "default",
    },
  }
)

function Badge({
  className,
  variant = "default",
  asChild = false,
  ...props
}: React.ComponentProps<"span"> &
  VariantProps<typeof badgeVariants> & { asChild?: boolean }) {
  const Comp = asChild ? Slot.Root : "span"

  return (
    <Comp
      data-slot="badge"
      data-variant={variant}
      className={cn(badgeVariants({ variant }), className)}
      {...props}
    />
  )
}

export { Badge, badgeVariants }
```

## Examples

<Tabs>
  <Tab title="Default">
    The default badge variant.

    ```tsx theme={null}
    <Badge>Default</Badge>
    ```
  </Tab>

  <Tab title="Secondary">
    Use the `secondary` variant for less prominent badges.

    ```tsx theme={null}
    <Badge variant="secondary">Secondary</Badge>
    ```
  </Tab>

  <Tab title="Destructive">
    Use the `destructive` variant for error states.

    ```tsx theme={null}
    <Badge variant="destructive">Destructive</Badge>
    ```
  </Tab>

  <Tab title="Outline">
    Use the `outline` variant for a subtle badge.

    ```tsx theme={null}
    <Badge variant="outline">Outline</Badge>
    ```
  </Tab>

  <Tab title="With Icon">
    Add icons to badges for additional context.

    ```tsx theme={null}
    <Badge>
      <CheckIcon />
      Verified
    </Badge>
    ```
  </Tab>
</Tabs>

## Variants

The Badge component supports the following variants:

* `default` - Primary badge style
* `secondary` - Secondary, less prominent style
* `destructive` - For errors or warnings
* `outline` - Outlined badge with transparent background
* `ghost` - Minimal styling, visible on hover
* `link` - Styled as a link with underline on hover

## API Reference

### Badge

| Prop        | Type                                                                          | Default     |
| ----------- | ----------------------------------------------------------------------------- | ----------- |
| `variant`   | `"default" \| "secondary" \| "destructive" \| "outline" \| "ghost" \| "link"` | `"default"` |
| `asChild`   | `boolean`                                                                     | `false`     |
| `className` | `string`                                                                      | -           |