Components/Feedback
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/badge
A badge is a visual indicator that informs users about the status of an item or function.
<CounterBadge/> instead.<Tag/> instead.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.Control the appearance of the badge according to its priority with the type prop. Choose from 3 styles:
solid (default)outlinedtransparentControl 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.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.
Add more context to a badge with affix icons:
prefixIcon - used to emphasize status message.suffixIcon - used to emphasize statuses that trigger popovers.Use badges to communicate item status. Highlight items that require user attention.
Use badges to draw more attention to new or recommended features and tools.
| 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. |
Import the driver matching your test environment:
| 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. |
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 changescustomContent prop (#16239) — has visual changesrole and aria-label attributes (#15642)Last updated: 22 October 2026