BadgeSelect

Components/Feedback/Badge

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

Overview

Copy

The BadgeSelect component is used for selecting a badge from a list.

Do

  • Use it to let users change the status of an item where the status is shown.
  • Keep the text of each option short, one or two words.

Don't

  • Don't use it for a status that users can't change. Use <Badge/> instead.
  • Don't use it for options that don't represent a status. Use <Dropdown/> instead.

Feature examples

Controlled example

This component can be used in controlled or uncontrolled modes. This ia an example of usage in controlled mode.

Copy

Sizes

The BadgeSelect component has two different sizes: "small" and "medium" (default). This size is used to define the <Badge/> size.

Copy

Type

The BadgeSelect has 3 different types: "solid" (default), "outlined", "transparent". This type is used to define the <Badge/> type.

Copy

Subtitle

The BadgeSelect can display a subtitle per option. This is an example of options with subtitles.

Copy

Code

Copy

Props

NameTypeDefaultDescription
dataHookstring—Applied as data-hook HTML attribute that can be used to create driver in testing.
onSelect(option: BadgeSelectItemProps) => void—Callback function called whenever the user selects a different option in the list.
options (required)BadgeSelectItemProps[]—An array of options. Each option must have a unique id, a text and a skin whose value should match one of <Badge/>'s skin values.
popoverPropsPopoverCommonProps—Accepts common popover props that are passed to the dropdown popover.
refnull | string | (instance: BadgeSelectImperativeActions | null) => void | RefObject<BadgeSelectImperativeActions>—Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).
selectedIdstring—The id of the selected option in the list.
showDrawerOnMobilebooleantrueSpecifies whether the options open in a bottom <Drawer/> when WixDesignSystemProvider has mobile enabled.
size"small" | "tiny" | "medium"'medium'The size of the <Badge/>
type"transparent" | "solid" | "outlined"'solid'The type of the <Badge/>
uppercasebooleantrueWhether the text of the <Badge/> should be uppercase.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
exists—
clickAtOptionClicks an option at given index
textGets badge text
getTypeGets badge type
getSkinGets badge skin
getSizeGets badge size
isUppercaseChecks whether the text is uppercase
hasClickCursorChecks whether badge is clickable
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.331.0 (2026-10-01) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.320.0 (2026-09-03) — 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.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.291.0 (2026-06-19) — maintenance release, no component-specific changes
  • 1.279.0 (2026-05-13) — maintenance release, no component-specific changes
  • 1.278.0 (2026-05-08) — maintenance release, no component-specific changes
  • 1.272.0 (2026-04-27) — maintenance release, no component-specific changes
  • 1.270.0 (2026-04-20) — maintenance release, no component-specific changes
  • 1.267.0 (2026-04-09) — maintenance release, no component-specific 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.242.0 (2025-12-19) — maintenance release, no component-specific changes
  • 1.149.1 (2024-12-20) — maintenance release, no component-specific changes
  • 1.116.0 (2024-07-22) — 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?