CheckToggle

Components/Form/CheckToggle

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

Overview

Copy

Check toggle allows users to make a binary choice between two states. It`s commonly used to mark a specific item as completed or not.

Do

  • Use it to mark item as completed or not

Don't

  • Don't use it to turn the setting on or off. Use <ToggleSwitch/> instead.
  • Don't use it to select a single or multiple items. Use <Checkbox/> or <Radio/> instead.

Feature examples

Size

Adjust the component size using the `size` prop. The prop supports two sizes:
 - `medium` - use where the component needs more emphasis
 - `small` (default) - use in dense and compact layouts

Copy

Skin

Style the component using the `skin` prop. This prop supports two skins:
 - `standard` (default) - use in all common cases
 - `success` - use to emphasize success states, such as approved

Copy

State

Control the state of a component with:
 - `checked` - use this state to mark an item as complete.
 - `disabled` - disables all component interactions. Use it to highlight unavailable functions.

Copy

Tooltip

Explain an action that's about to be performed with a descriptive message in a tooltip. Use the `tooltipContent` prop to pass the text to a tooltip.

Copy

Common use case examples

To-do list

Use the check toggle to mark items as completed, e.g., in lists of to-do tasks.

Copy

Code

Copy

Props

NameTypeDefaultDescription
checkedboolean—Specifies whether a check is selected.
dataHookstring—Applies a data-hook HTML attribute that can be used in the tests.
disabledboolean—Specifies whether toggle interactions should be disabled.
onBlur(event: FocusEvent, triggers: Triggers) => void—
onChangeChangeEventHandler—Defines a callback function which is called every time the check value is changed.
onFocus(event: FocusEvent, triggers: Triggers) => void—
refRefObject—
size"small" | "medium"—Controls the size of the component.
skin"standard" | "success"—Controls the skin of the component.
tooltipContentReactNode—Defines a message to be displayed in a tooltip. Tooltip is displayed on component hover.
tooltipPropsTooltipCommonProps—Allows to pass all common tooltip props.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
isCheckedChecks whether CheckToggle is checked
clickClicks on the element
getTooltipContentGets the tooltip content, throws an error if content is not provided.
existsChecks whether the component found with the given data hook.
elementGets 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.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.323.0 (2026-09-10) — maintenance release, no component-specific changes
  • 1.322.0 (2026-09-09) — 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.273.0 (2026-04-30) — 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.257.0 (2026-02-19) — breaking: tokenized component (#15941)
  • 1.254.0 (2026-02-03) — maintenance release, no component-specific changes
  • 1.250.0 (2026-01-27) — maintenance release, no component-specific changes
  • 1.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.242.0 (2025-12-19) — maintenance release, no component-specific changes
  • 1.241.0 (2025-12-17) — maintenance release, no component-specific changes
  • 1.212.0 (2025-08-11) — maintenance release, no component-specific changes
  • 1.154.0 (2025-01-17) — maintenance release, no component-specific changes
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.104.1 (2024-05-14) — maintenance release, no component-specific changes
  • 1.102.0 (2024-04-16) — 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?