---
title: Badge
description: "`Badge` is a component that emphasizes the status of an item to make it immediately recognizable."
links:
  - style: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/badge/badge.style.ts
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/badge
  - storybook: https://yamada-ui.github.io/yamada-ui?path=/story/components-badge--basic
---

# Badge

`Badge` is a component that emphasizes the status of an item to make it immediately recognizable.

```tsx
<Badge>Badge</Badge>
```

## Usage

```tsx
import { Badge } from "@yamada-ui/react"
```

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

```tsx
import { Badge } from "@workspaces/ui"
```

```tsx
<Badge />
```

:::tip
If you want to categorize or organize items using keywords that describe them, use a [Tag](https://yamada-ui.com/docs/components/tag.md).
:::

### Change Variant

```tsx
<Wrap gap="md">
  <For each={["solid", "subtle", "surface", "outline"]}>
    {(variant, index) => (
      <Badge key={index} variant={variant}>
        {variant}
      </Badge>
    )}
  </For>
</Wrap>
```

### Change Size

```tsx
<Wrap gap="md">
  <For each={["sm", "md", "lg"]}>
    {(size, index) => (
      <Badge key={index} size={size}>
        {size}
      </Badge>
    )}
  </For>
</Wrap>
```

### Change Color Scheme

```tsx
<Wrap gap="md">
  <For each={["success", "warning"]}>
    {(colorScheme, index) => (
      <Badge key={index} colorScheme={colorScheme}>
        {colorScheme}
      </Badge>
    )}
  </For>
</Wrap>
```

## Props

| Prop          | Default     | Type                                                                                                                      | Description                                |
| ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `as`          | -           | `As`                                                                                                                      | The HTML element to render.                |
| `asChild`     | -           | `boolean`                                                                                                                 | Merges its props onto its immediate child. |
| `css`         | -           | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                            |
| `colorScheme` | -           | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                |
| `size`        | `"sm"`      | `"lg" \| "md" \| "sm"`                                                                                                    | The size of the component.                 |
| `variant`     | `"outline"` | `"outline" \| "solid" \| "subtle" \| "surface"`                                                                           | The variant of the component.              |

## Similar Components

- [Tag](https://yamada-ui.com/docs/components/tag.md): `Tag` is a component used to categorize or organize items using keywords that describe them.
- [NativeTable](https://yamada-ui.com/docs/components/native-table.md): `NativeTable` is a component for efficiently organizing and displaying data.
- [Stat](https://yamada-ui.com/docs/components/stat.md): `Stat` is used to display numbers or data within a box.
- [Table](https://yamada-ui.com/docs/components/table.md): `Table` is a table component equipped with column sorting, row selection, and click event features.
- [AreaChart](https://yamada-ui.com/docs/components/area-chart.md): `AreaChart` is a component for drawing area charts to compare multiple sets of data.
- [BarChart](https://yamada-ui.com/docs/components/bar-chart.md): `BarChart` is a component for drawing bar charts to compare multiple sets of data.
- [Card](https://yamada-ui.com/docs/components/card.md): `Card` is a component that groups and displays related information. By default, it renders a `article` element.
- [ComposedChart](https://yamada-ui.com/docs/components/composed-chart.md): `ComposedChart` is a component for drawing composed charts to compare multiple sets of data.