110k
New

Badge

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

Component badge-demo not found in registry.

Installation

pnpm dlx createui@latest add badge

Usage

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

Examples

Variants

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

Component badge-variants not found in registry.

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.

Component badge-icon not found in registry.

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.

Component badge-spinner not found in registry.

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

Component badge-link not found in registry.

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.

Component badge-colors not found in registry.

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""default"
classNamestring-