> To build a Wix site agentically, or add Wix features like bookings or a store to a site you already have, follow https://www.wix.com/headless/skill.md
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: Badge Component

## Article: Badge Component

## Article Link: https://dev.wix.com/docs/wix-design-system/components/feedback/badge-component.md

## Article Content:

# Badge

_Components/Feedback_

Interactive docs page: <https://wix-pages.com/design-system-documentation/#/component/badge>

## Overview

```jsx
<Box align="center" padding="SP4">
  <Badge uppercase={false} size="small">
    Archived
  </Badge>
</Box>;
```

A badge is a visual indicator that informs users about the status of an item or function.

### Do

- Use badges to show the status of an item or function.
- Use short and clear text labels (1 - 2 words).

### Don't

- Don't use badges to display a number of items. Use `<CounterBadge/>` instead.
- Don't use them to label, categorize or organize content using descriptive keywords. Use `<Tag/>` instead.

### Feature examples

#### Size

Adjust the component size using the `size` prop. Choose from 3 sizes:

- `medium` (default) - can be used in all common cases.
- `small` - best for dense layouts.
- `tiny` - should be used sparingly, for dense and narrow layouts.

```jsx
<StorybookComponents.Stack>
  <StorybookComponents.Stack flexDirection="column">
    <Badge uppercase={false} size="medium">
      Medium
    </Badge>
    <Badge uppercase={false} size="small">
      Small
    </Badge>
    <Badge uppercase={false} size="tiny">
      Tiny
    </Badge>
  </StorybookComponents.Stack>
</StorybookComponents.Stack>;
```

#### Type

Control the appearance of the badge according to its priority with the `type` prop. Choose from 3 styles:

- `solid` (default)
- `outlined`
- `transparent`

```jsx
<StorybookComponents.Stack>
  <StorybookComponents.Stack flexDirection="column">
    <Badge uppercase={false} type="solid">
      Solid
    </Badge>
    <Badge uppercase={false} type="outlined">
      Outlined
    </Badge>
    <Badge uppercase={false} type="transparent">
      Transparent
    </Badge>
  </StorybookComponents.Stack>
</StorybookComponents.Stack>;
```

#### Skin

Control the appearance of badges with the `skin` prop. Choose from 13 skins:

- `general` (default) - used for default statuses.
- `standard`, `neutralStandard` - used for statuses that are relevant to current user task.
- `danger`, `neutralDanger` - used for critical issues that require user action.
- `success`, `neutralSuccess` - used for success or positive status.
- `neutral`, `neutralLight` - used for completed or pending status, when no action is needed at the moment.
- `warning`, `warningLight` - used for unresolved, but not critical issues.
- `urgent` - used for unresolved and time sensitive issues that require user action.
- `premium` - used for items or functions related to Premium Plans.

```jsx
<StorybookComponents.Stack>
  <StorybookComponents.Stack flexDirection="column">
    <Badge uppercase={false} skin="general">
      General
    </Badge>
    <Badge uppercase={false} skin="standard">
      Standard
    </Badge>
    <Badge uppercase={false} skin="danger">
      Danger
    </Badge>
    <Badge uppercase={false} skin="success">
      Success
    </Badge>
    <Badge uppercase={false} skin="neutral">
      Neutral
    </Badge>
    <Badge uppercase={false} skin="warning">
      Warning
    </Badge>
    <Badge uppercase={false} skin="urgent">
      Urgent
    </Badge>
    <Badge uppercase={false} skin="premium">
      Premium
    </Badge>
  </StorybookComponents.Stack>

  <StorybookComponents.Stack flexDirection="column" margin="54px 0">
    <Badge uppercase={false} skin="neutralStandard">
      Neutral Standard
    </Badge>
    <Badge uppercase={false} skin="neutralDanger">
      Neutral Danger
    </Badge>
    <Badge uppercase={false} skin="neutralSuccess">
      Neutral Success
    </Badge>
    <Badge uppercase={false} skin="neutralLight">
      Neutral Light
    </Badge>
    <Badge uppercase={false} skin="warningLight">
      Warning Light
    </Badge>
  </StorybookComponents.Stack>

  <StorybookComponents.Stack flexDirection="column">
    <Badge uppercase={false} skin="general" type="outlined">
      General
    </Badge>
    <Badge uppercase={false} skin="standard" type="outlined">
      Standard
    </Badge>
    <Badge uppercase={false} skin="danger" type="outlined">
      Danger
    </Badge>
    <Badge uppercase={false} skin="success" type="outlined">
      Success
    </Badge>
    <Badge uppercase={false} skin="neutral" type="outlined">
      Neutral
    </Badge>
    <Badge uppercase={false} skin="warning" type="outlined">
      Warning
    </Badge>
    <Badge uppercase={false} skin="urgent" type="outlined">
      Urgent
    </Badge>
    <Badge uppercase={false} skin="premium" type="outlined">
      Premium
    </Badge>
  </StorybookComponents.Stack>

  <StorybookComponents.Stack flexDirection="column" margin="54px 0">
    <Badge uppercase={false} skin="neutralStandard" type="outlined">
      Neutral Standard
    </Badge>
    <Badge uppercase={false} skin="neutralDanger" type="outlined">
      Neutral Danger
    </Badge>
    <Badge uppercase={false} skin="neutralSuccess" type="outlined">
      Neutral Success
    </Badge>
    <Badge uppercase={false} skin="neutralLight" type="outlined">
      Neutral Light
    </Badge>
    <Badge uppercase={false} skin="warningLight" type="outlined">
      Warning Light
    </Badge>
  </StorybookComponents.Stack>

  <StorybookComponents.Stack flexDirection="column">
    <Badge uppercase={false} skin="general" type="transparent">
      General
    </Badge>
    <Badge uppercase={false} skin="standard" type="transparent">
      Standard
    </Badge>
    <Badge uppercase={false} skin="danger" type="transparent">
      Danger
    </Badge>
    <Badge uppercase={false} skin="success" type="transparent">
      Success
    </Badge>
    <Badge uppercase={false} skin="neutral" type="transparent">
      Neutral
    </Badge>
    <Badge uppercase={false} skin="warning" type="transparent">
      Warning
    </Badge>
    <Badge uppercase={false} skin="urgent" type="transparent">
      Urgent
    </Badge>
    <Badge uppercase={false} skin="premium" type="transparent">
      Premium
    </Badge>
  </StorybookComponents.Stack>
</StorybookComponents.Stack>;
```

#### Letter case

Decide whether a badge is written in all uppercase letters or in sentence case with the `uppercase` prop.

By default, badges are written in lowercase.

```jsx
<StorybookComponents.Stack>
  <StorybookComponents.Stack flexDirection="column">
    <Badge>Upper case</Badge>
    <Badge uppercase={false}>Lower case</Badge>
  </StorybookComponents.Stack>
</StorybookComponents.Stack>;
```

#### Affix

Add more context to a badge with affix icons:

- `prefixIcon` - used to emphasize status message.
- `suffixIcon` - used to emphasize statuses that trigger popovers.

```jsx
<StorybookComponents.Stack>
  <StorybookComponents.Stack flexDirection="column">
    <Badge uppercase={false} prefixIcon={<Icons.LockLockedSmall />}>
      Prefix icon
    </Badge>
    <Badge uppercase={false} suffixIcon={<Icons.ChevronDownSmall />}>
      Suffix icon
    </Badge>
  </StorybookComponents.Stack>
</StorybookComponents.Stack>;
```

### Common use case examples

#### Item status

Use badges to communicate item status. Highlight items that require user attention.

```jsx
() => {
  const records = [
    {
      number: '#1439',
      total: '$105.55',
      status: (
        <Badge size="small" skin="neutralLight">
          Paid
        </Badge>
      ),
    },
    {
      number: '#4152',
      total: '$928.41',
      status: (
        <Badge size="small" skin="neutralLight">
          Paid
        </Badge>
      ),
    },
    {
      number: '#9261',
      total: '$710.68',
      status: (
        <Badge size="small" skin="neutralLight">
          Paid
        </Badge>
      ),
    },
    {
      number: '#9359',
      total: '$219.78',
      status: (
        <Badge size="small" skin="danger">
          Overdue
        </Badge>
      ),
    },
    {
      number: '#5560',
      total: '$782.01',
      status: (
        <Badge size="small" skin="urgent">
          Partially paid
        </Badge>
      ),
    },
    {
      number: '#6690',
      total: '$406.27',
      status: (
        <Badge size="small" skin="neutralLight">
          Paid
        </Badge>
      ),
    },
    {
      number: '#5948',
      total: '$475.22',
      status: (
        <Badge size="small" skin="success">
          Sent
        </Badge>
      ),
    },
  ];

  const secondaryAction = [
    {
      icon: <Icons.DuplicateSmall />,
      text: 'Duplicate',
      onClick: () => {},
    },
    {
      icon: <Icons.DeleteSmall />,
      text: 'Delete',
      onClick: () => {},
    },
  ];

  const columns = [
    {
      title: 'Number',
      render: (row) => row.number,
      width: '30%',
    },
    {
      title: 'Total',
      render: (row) => row.total,
      width: '30%',
    },
    {
      title: 'Status',
      render: (row) => row.status,
      width: '30%',
    },
    {
      title: '',
      render: (row) => (
        <TableActionCell size="small" secondaryActions={secondaryAction} />
      ),
      width: '10%',
    },
  ];

  return (
    <Card>
      <Table data={records} columns={columns} showSelection>
        <TableToolbar>
          <TableToolbar.ItemGroup position="start">
            <TableToolbar.Item>
              <TableToolbar.Label>7 invoices</TableToolbar.Label>
            </TableToolbar.Item>
          </TableToolbar.ItemGroup>
        </TableToolbar>
        <Table.Content />
      </Table>
    </Card>
  );
};
```

#### Promote

Use badges to draw more attention to new or recommended features and tools.

```jsx
<Card>
  <MarketingLayout
    title="Get listed on Google Search"
    description="Continue with your SEO setup checklist and connect to Google Search Console."
    actions={<Button size="small">Go for It</Button>}
    size="tiny"
    badge={<Badge size="small">Recommended</Badge>}
    image={
      <Box width="100%" align="right">
        <Image
          width="120px"
          src="PromotionalPromoteMarketingHomeSEO.svg"
          transparent
        />
      </Box>
    }
  />
</Card>;
```

## Code

```jsx
import { Badge } from '@wix/design-system';
```

### Props

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `ariaLabel` | `string` | — | Defines a string value that labels the badge element. |
| `children` | `ReactNode` | — | Accepts any component as a child item. Usually it is a text string. |
| `customContent` | `ReactNode` | — | Accepts custom content to render instead of the default text-wrapped `children`. |
| `dataHook` | `string` | — | Applies a data-hook HTML attribute to be used in the tests. |
| `display` | `"inline" \| "block"` | `inline` | Defines the display property of the component. |
| `noPadding` | `boolean` | — | Removes paddings from the component. |
| `onClick` | `EventHandler<MouseEvent<HTMLElement, MouseEvent> \| KeyboardEvent<HTMLElement>>` | — | Defines a click handler. |
| `prefixIcon` | `null \| IconElement` | — | Pass an icon or a component to display in front of the content. |
| `showTooltip` | `boolean` | `true` | Controls whether ellipsis tooltip is enabled. |
| `size` | `"small" \| "tiny" \| "medium"` | — | Controls the size of the component. |
| `skin` | `"warning" \| "standard" \| "neutral" \| "premium" \| "success" \| "general" \| "danger" \| "neutralLight" \| "warningLight" \| "urgent" \| "neutralStandard" \| "neutralSuccess" \| "neutralDanger"` | — | Controls the appearance of a notification. |
| `suffixIcon` | `null \| IconElement` | — | Pass an icon or a component to display at the end of the content. |
| `type` | `"transparent" \| "solid" \| "outlined"` | — | Controls the appearance of a notification. |
| `uppercase` | `boolean` | — | Forces uppercase letters. |

## Testkit

Import the driver matching your test environment:

```jsx
// UniDriver
import { BadgeUniDriver } from '@wix/design-system/dist/testkit/unidriver';

// Vanilla
import { BadgeTestkit } from '@wix/design-system/dist/testkit';

// Puppeteer
import { BadgeTestkit } from '@wix/design-system/dist/testkit/puppeteer';

// Testing Library
import { BadgeTestkit } from '@wix/design-system/dist/testkit/testing-library';
```

### Driver methods

| Method | Description |
| --- | --- |
| `text` | Gets badge text |
| `getType` | Gets badge type |
| `getSkin` | Gets badge type |
| `getSize` | Gets badge size |
| `isUppercase` | Checks whether the text is uppercase |
| `hasClickCursor` | Checks whether badge is clickable |
| `exists` | Checks whether the component found with the given data hook. |
| `element` | Gets the component root element. |
| `click` | Clicks on the component root element. |
| `base` | Returns UniDriver for the base element. |

## Changelog

- **1.340.0** (2026-10-21) — maintenance release, no component-specific changes
- **1.339.0** (2026-10-19) — maintenance release, no component-specific changes
- **1.338.0** (2026-10-15) — maintenance release, no component-specific changes
- **1.330.0** (2026-09-28) — maintenance release, no component-specific changes
- **1.329.0** (2026-09-24) — maintenance release, no component-specific changes
- **1.328.0** (2026-09-22) — maintenance release, no component-specific changes
- **1.327.0** (2026-09-21) — fix: skin colors match the Harmony (odeditor) design definition again, and transparent badges with a neutral or light skin are readable instead of nearly invisible. ([#17106](invalid-url)) — has visual changes
- **1.325.0** (2026-09-17) — maintenance release, no component-specific changes
- **1.323.0** (2026-09-10) — maintenance release, no component-specific changes
- **1.316.0** (2026-08-25) — maintenance release, no component-specific changes
- **1.310.0** (2026-08-10) — maintenance release, no component-specific changes
- **1.305.1** (2026-07-30) — fix: label color of the solid `neutralSuccess`, `neutralDanger` and `warningLight` skins is now tokenized; in Studio 2.0 (odeditor-dark) the label renders white to meet WCAG small-text contrast. ([#16663](invalid-url)) — has visual changes
- **1.292.0** (2026-06-22) — maintenance release, no component-specific changes
- **1.278.0** (2026-05-08) — maintenance release, no component-specific changes
- **1.277.0** (2026-05-07) — feat: add `customContent` prop ([#16239](invalid-url)) — has visual changes
- **1.266.0** (2026-04-07) — maintenance release, no component-specific changes
- **1.260.0** (2026-03-17) — maintenance release, no component-specific changes
- **1.254.0** (2026-02-03) — maintenance release, no component-specific changes
- **1.247.2** (2026-01-21) — maintenance release, no component-specific changes
- **1.241.0** (2025-12-17) — maintenance release, no component-specific changes
- **1.238.0** (2025-12-10) — feat: add `role` and `aria-label` attributes ([#15642](invalid-url))
- **1.216.0** (2025-09-01) — breaking: editor3 tokenization ([#15223](invalid-url))
- **1.212.0** (2025-08-11) — maintenance release, no component-specific changes
- **1.169.0** (2025-03-10) — maintenance release, no component-specific changes
- **1.155.0** (2025-01-23) — maintenance release, no component-specific changes
- **1.151.0** (2025-01-07) — fix: fixed issue when undefined prop value overrides defaults ([#14428](invalid-url))
- **1.149.1** (2024-12-20) — maintenance release, no component-specific changes
- **1.138.1** (2024-10-30) — maintenance release, no component-specific changes
- **1.128.0** (2024-09-19) — feat: exposing display prop on badge ([#14130](invalid-url))
- **1.115.0** (2024-07-17) — maintenance release, no component-specific changes
- **1.102.0** (2024-04-16) — maintenance release, no component-specific changes
- **1.93.0** (2024-02-08) — maintenance release, no component-specific changes
- **1.92.1** (2024-02-05) — maintenance release, no component-specific changes