# Badge

> A short pill of status text in five treatments and two sizes, with native span attributes passed through.

- Package: `fancy-ui-vue` (Vue 3.5+ + Tailwind CSS v4)
- Category: Data Display
- Tags: badge, label, status, pill, tag, chip
- Types: `BadgeProps`, `BadgeVariant`, `BadgeSize`
- Docs: https://fancy-ui.rama.app/docs/components/badge
- Source: https://github.com/RamaHerbin/fancy-ui/tree/main/vue/src/components/badge

## Import

```vue
<script setup lang="ts">
import { Badge } from 'fancy-ui-vue';
</script>
```

Setup (once per project): `npm install fancy-ui-vue`, then put these lines in your main CSS file (the stylesheet imports go right after `@import "tailwindcss";`):

```css
@import "tailwindcss";
@import "fancy-ui-vue/tailwind.css";
@import "fancy-ui-vue/styles.css";
```

Full guide: https://fancy-ui.rama.app/llms.txt

The names below are the ones to write in a Vue template; when one differs from the Svelte name, the Svelte name follows in parentheses. Snippets become named slots (`#default` is the default snippet), a prop the Vue port declares as a model is a `v-model:<name>` (except `ref`, exposed via `defineExpose({ ref })`: put a template ref on the component and read `.ref`) and callbacks are listeners (`onclick` is `@click`). Every component sets `inheritAttrs: false`: `class` is a declared prop, merged where the Svelte component applies it (not always the root element), and only when the props table below lists it; other attributes do not fall through unless the package README lists the component as forwarding native attributes. Divergences: https://github.com/RamaHerbin/fancy-ui/tree/main/vue#divergences-from-the-svelte-api

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `variant` | `"default" \| "secondary" \| "outline" \| "destructive" \| "success"` | `"default"` | Visual treatment. Always pair it with a visible word: colour is never the message |
| `size` | `"sm" \| "md"` | `"md"` | Compact or regular |
| `class` | `string` | — | Additional CSS classes |

## Slots

| Slot | Description |
| --- | --- |
| `#default` (Svelte `children`) | The label |

## Example

```vue
<script setup lang="ts">
import { Badge } from "fancy-ui-vue";
</script>

<template>
	<div class="flex flex-wrap items-center gap-2">
		<Badge>Default</Badge>
		<Badge variant="secondary">Secondary</Badge>
		<Badge variant="outline">Outline</Badge>
		<Badge variant="destructive">Destructive</Badge>
		<Badge variant="success">Success</Badge>
	</div>
</template>
```
