# Badge · JGuang UI

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

- Page: https://jiguang132.com/systems/jguang-ui/docs/components/base/badge
- Based on: shadcn/ui documentation (MIT) @ bc0705384b51252af26dcc65425b216bf5eb063c

> Example `badge-demo`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## Installation


  

**Command**


  

**Manual**


```text
Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.
```


### Copy and paste the following code into your project.


[View complete source: components/ui/badge.tsx](/r/jguang-ui/base/badge.json)


### Update the import paths to match your project setup.


## Usage

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

```tsx
<Badge variant="default | outline | secondary | destructive">Badge</Badge>
```

## Variants

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


> Example `badge-variants`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## 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.


> Example `badge-icon`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## 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.


> Example `badge-spinner`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## Link

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


> Example `badge-link`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## 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.


> Example `badge-colors`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## RTL

To enable RTL support in JGuang UI, see the [RTL configuration guide](/systems/jguang-ui/docs/rtl).


> Example `badge-rtl`: interactive preview on https://jiguang132.com/systems/jguang-ui/docs/components/base/badge


## API Reference

### Badge

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

| Prop        | Type                                                                          | Default     |
| ----------- | ----------------------------------------------------------------------------- | ----------- |
| `variant`   | `"default" \| "secondary" \| "destructive" \| "outline" \| "ghost" \| "link"` | `"default"` |
| `className` | `string`                                                                      | -           |

---

Index of all JGuang resources: https://jiguang132.com/llms.txt