Logo
DocsBadge

Badge

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

Badge

Implementation

1

Copy and paste the following code into your project.

import * as React from "react";
import { cva, type VariantProps } from "class-variance-authority";

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

const badgeVariants = cva(
  "inline-flex items-center rounded-full border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2",
  {
    variants: {
      variant: {
        default:
          "border-transparent bg-primary text-primary-foreground hover:bg-primary/80",
        secondary:
          "border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80",
        destructive:
          "border-transparent bg-destructive text-destructive-foreground hover:bg-destructive/80",
        outline: "text-foreground",
      },
    },
    defaultVariants: {
      variant: "default",
    },
  },
);

export interface BadgeProps
  extends React.HTMLAttributes<HTMLDivElement>,
    VariantProps<typeof badgeVariants> {}

function Badge({ className, variant, ...props }: BadgeProps) {
  return (
    <div className={cn(badgeVariants({ variant }), className)} {...props} />
  );
}

export { Badge, badgeVariants };
2

Update the import paths to match your project setup.

Usage

import { Badge } from "@/components/ui/badge"

Examples

Default

Default

Secondary

Secondary

Destructive

Destructive

Outline

Outline

API Reference

Badge

Renders a badge or a component that looks like a badge.

Properties

PropertyTypeDefaultDescription
variant"default" | "secondary" | "destructive" | "outline""default"The variant style of the badge
classNamestring-Additional CSS classes to apply
childrenReact.ReactNode-The content to display inside the badge