120k

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 @force-ui/badge

Usage

import { Badge } from "@/components/ui/badge"
<Badge variant="default | outline | secondary | destructive | warning">
  Badge
</Badge>

Variants

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

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

export function BadgeVariants() {

Status Variants

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

export function BadgeStatus() {

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 BadgeCheck from "@material-symbols/svg-400/rounded/verified.svg?react"
import BookmarkIcon from "@material-symbols/svg-400/rounded/bookmark.svg?react"

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"

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

import ArrowUpRightIcon from "@material-symbols/svg-400/rounded/north_east.svg?react"

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

Solid Status Variants

Use solid variants for maximum-attention states like critical counts or overdue flags.

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

export function BadgeSolid() {

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 in Force UI, 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.

PropTypeDefault
variant"default" | "secondary" | "destructive" | "outline" | "ghost" | "link" | "warning" | "success" | "info" | "success-solid" | "warning-solid" | "info-solid" | "error-solid""default"
classNamestring-