Badge

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

BadgeSecondaryDestructiveOutline

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

export function BadgeDemo() {

Installation


pnpm dlx shadcn@latest add https://anotherui.dev/r/badge.json

Usage

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

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

Variants

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

DefaultSecondaryDestructiveOutlineGhost

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

export function BadgeVariants() {

Tones and Fill

Besides destructive, there are success, warning and info variants. Each one comes soft (a pale tint, the default) or solid (the full colour with white text).

<Badge variant="success">Paid</Badge>
<Badge variant="success" fill="solid">Paid</Badge>
<Badge variant="destructive" fill="solid">Overdue</Badge>

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.

VerifiedBookmark

import { BookmarkIcon, CheckCircleIcon } from "@phosphor-icons/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.

DeletingGenerating

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

Link

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

Open Link

import { ArrowUpRightIcon } from "@phosphor-icons/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.

BlueGreenSkyPurpleRed

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

export function BadgeCustomColors() {

RTL

To enable RTL support, see the RTL configuration guide.

شارةثانويمدمرمخططمتحققإشارة مرجعية

"use client"

import * as React from "react"

API Reference

Badge

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

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

Avatar Upload Banner

On This Page

Installation Usage Variants Tones and Fill With Icon With Spinner Link Custom Colors RTL API Reference Badge