# Badge

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

## Installation

```bash
npx shadcn@latest add https://reactdocs.canceydejean.dev/r/badge.json
```

[Registry JSON](https://reactdocs.canceydejean.dev/r/badge.json)

## Preview

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

export function Preview() {
  return <Badge>Badge</Badge>;
}
```


## Source

### badge.tsx

```tsx
import { mergeProps } from "@base-ui/react/merge-props";
import { useRender } from "@base-ui/react/use-render";
import { type VariantProps } from "class-variance-authority";

import { cn } from "cn"

import { badgeVariants } from "./badge.variants";

function Badge({
  className,
  variant = "default",
  render,
  ...props
}: useRender.ComponentProps<"span"> & VariantProps<typeof badgeVariants>) {
  return useRender({
    defaultTagName: "span",
    props: mergeProps<"span">(
      {
        className: cn(badgeVariants({ variant }), className),
      },
      props,
    ),
    render,
    state: {
      slot: "badge",
      variant,
    },
  });
}

export { Badge, badgeVariants };
```


### badge.variants.ts

```ts
import { cva } from "class-variance-authority";

import { cn } from "cn"

const badgeBase = cn(
  "group/badge inline-flex h-5 w-fit shrink-0 items-center justify-center gap-1 overflow-hidden rounded-4xl border border-transparent px-2 py-0.5 text-xs font-medium whitespace-nowrap transition-all focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 aria-invalid:border-destructive aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 [&>svg]:pointer-events-none [&>svg]:size-3!",
);

const badgeConfig = {
  variants: {
    variant: {
      default: "bg-primary text-primary-foreground [a]:hover:bg-primary/80",
      secondary: "bg-secondary text-secondary-foreground [a]:hover:bg-secondary/80",
      destructive:
        "bg-destructive/10 text-destructive focus-visible:ring-destructive/20 dark:bg-destructive/20 dark:focus-visible:ring-destructive/40 [a]:hover:bg-destructive/20",
      outline: "border-border text-foreground [a]:hover:bg-muted [a]:hover:text-muted-foreground",
      ghost: "hover:bg-muted hover:text-muted-foreground dark:hover:bg-muted/50",
      link: "text-primary underline-offset-4 hover:underline",
    },
  },
  compoundVariants: [],
  defaultVariants: {
    variant: "default",
  },
} as const;

export const badgeCva = cva(badgeBase, {
  ...badgeConfig,
  compoundVariants: [...badgeConfig.compoundVariants],
});

// Export the variant variants
export const BADGE_VARIANTS = Object.keys(
  badgeConfig.variants.variant,
) as (keyof typeof badgeConfig.variants.variant)[];

export const badgeVariants = badgeCva;
```



## Usage

Use badges for status, counts, labels, and compact metadata.

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

export function Example() {
  return <Badge>Badge</Badge>;
}
```

Variants: `default`, `secondary`, `destructive`, `outline`, `ghost`, and `link`. Render as a link
with `render={<a href="..." />}`.