Badge
v1.0.0
Display
A small status indicator or label component with multiple variants and sizes.
Dependencies
class-variance-authority
clsx
tailwind-merge
Installation
Add this component to your project
CLI Installation
npx shadcn@latest add badgeManual Installation
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 }Props
Component properties and their types
variant'default' | 'secondary' | 'destructive' | 'outline'
default: 'default'
The visual style variant of the badge
Examples
3 different usage examples
Default Badge
import { Badge } from "@/components/ui/badge"
export function BadgeDemo() {
return <Badge>Default</Badge>
}Registry
View the component registry file
Live Preview
Interactive
3 examples available
Badge