Badge

A badge component with default, secondary, destructive, and outline variants. Supports the asChild pattern via Radix Slot.

DefaultSecondaryDestructiveOutline

Installation

Install the badge component via the shadcn CLI:

bash

npx shadcn@latest add "https://dexterityui.vercel.app/r/badge.json"

Dependencies installed automatically:

@radix-ui/react-slotclass-variance-authority

Examples

v1.0.0BetaDeprecatedComing Soon

Source

tsx

import * as React from "react"
import { Slot } from "@radix-ui/react-slot"
import { cva, type VariantProps } from "class-variance-authority"

import { cn } from "@/lib/utils"

const badgeVariants = cva(
    "inline-flex items-center justify-center rounded-md border px-2 py-0.5 text-xs font-medium w-fit whitespace-nowrap shrink-0 ...",
    {
        variants: {
            variant: {
                default: "border-transparent bg-primary text-primary-foreground",
                secondary: "border-transparent bg-secondary text-secondary-foreground",
                destructive: "border-transparent bg-destructive text-white",
                outline: "text-foreground",
            },
        },
        defaultVariants: { variant: "default" },
    }
)

function Badge({ className, variant, asChild = false, ...props }) {
    const Comp = asChild ? Slot : "span"
    return (
        <Comp
            data-slot="badge"
            className={cn(badgeVariants({ variant }), className)}
            {...props}
        />
    )
}

export { Badge, badgeVariants }