Badge

Installation#

pnpmnpmyarnbun
pnpm dlx shadcn@latest add @force-ui-vue/badge
Copy

Usage#

Copy<script setup lang="ts">
import { Badge } from "@/components/ui/badge"
</script>
 
<template>
  <Badge variant="default | outline | secondary | destructive | warning">
    Badge
  </Badge>
</template>

Examples#

Variants#

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

Status Variants#

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.

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.

Link#

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

Solid Status Variants#

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

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.

API Reference#

Badge#

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