Badge

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

export function BadgeDemo() {

Installation#

pnpmnpmyarnbun
pnpm dlx shadcn@latest add @dots/badge
Copy

Usage#

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

Copy<Badge variant="default | outline | secondary | destructive">Badge</Badge>

Variants#

Use the variant prop to change the variant of the badge.

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

export function BadgeVariants() {

With Icon#

You can render an icon inside the badge. Use data-icon="inline-start" to render the icon on the left and data-icon="inline-end" to render the icon on the right.

import { BadgeCheck, BookmarkIcon } from "lucide-react"

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

With Spinner#

You can render a spinner inside the badge. Remember to add the data-icon="inline-start" or data-icon="inline-end" prop to the spinner.

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

Link#

Use the render prop to render a link as a badge.

import { ArrowUpRightIcon } from "lucide-react"

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

Custom Colors#

You can customize the colors of a badge by adding custom classes such as bg-green-50 dark:bg-green-800 to the Badge component.

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

export function BadgeCustomColors() {

API Reference#

Badge#

The Badge component displays a badge or a component that looks like a badge.