Badge

Components/Feedback

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

Overview

Copy

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

Type

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

  • solid (default)
  • outlined
  • transparent
Copy

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

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.

Copy

Affix

Add more context to a badge with affix icons:

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

Common use case examples

Item status

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

Copy

Promote

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

Copy

Code

Copy

Props

NameTypeDefaultDescription
ariaLabelstring—Defines a string value that labels the badge element.
childrenReactNode—Accepts any component as a child item. Usually it is a text string.
customContentReactNode—Accepts custom content to render instead of the default text-wrapped children.
dataHookstring—Applies a data-hook HTML attribute to be used in the tests.
display"inline" | "block"inlineDefines the display property of the component.
noPaddingboolean—Removes paddings from the component.
onClickEventHandler<MouseEvent<HTMLElement, MouseEvent> | KeyboardEvent<HTMLElement>>—Defines a click handler.
prefixIconnull | IconElement—Pass an icon or a component to display in front of the content.
showTooltipbooleantrueControls 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.
suffixIconnull | 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.
uppercaseboolean—Forces uppercase letters.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
textGets badge text
getTypeGets badge type
getSkinGets badge type
getSizeGets badge size
isUppercaseChecks whether the text is uppercase
hasClickCursorChecks whether badge is clickable
existsChecks whether the component found with the given data hook.
elementGets the component root element.
clickClicks on the component root element.
baseReturns 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) — 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) — 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) — 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)
  • 1.216.0 (2025-09-01) — breaking: editor3 tokenization (#15223)
  • 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)
  • 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)
  • 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

Last updated: 22 October 2026

Did this help?