Components/Form/CheckToggle
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/checktoggle
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.
<ToggleSwitch/> instead.<Checkbox/> or <Radio/> instead.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
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
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.
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.
Use the check toggle to mark items as completed, e.g., in lists of to-do tasks.
| Name | Type | Default | Description |
|---|---|---|---|
checked | boolean | — | Specifies whether a check is selected. |
dataHook | string | — | Applies a data-hook HTML attribute that can be used in the tests. |
disabled | boolean | — | Specifies whether toggle interactions should be disabled. |
onBlur | (event: FocusEvent, triggers: Triggers) => void | — | |
onChange | ChangeEventHandler | — | Defines a callback function which is called every time the check value is changed. |
onFocus | (event: FocusEvent, triggers: Triggers) => void | — | |
ref | RefObject | — | |
size | "small" | "medium" | — | Controls the size of the component. |
skin | "standard" | "success" | — | Controls the skin of the component. |
tooltipContent | ReactNode | — | Defines a message to be displayed in a tooltip. Tooltip is displayed on component hover. |
tooltipProps | TooltipCommonProps | — | Allows to pass all common tooltip props. |
Import the driver matching your test environment:
| Method | Description |
|---|---|
isChecked | Checks whether CheckToggle is checked |
click | Clicks on the element |
getTooltipContent | Gets the tooltip content, throws an error if content is not provided. |
exists | Checks whether the component found with the given data hook. |
element | Gets the component root element. |
base | Returns UniDriver for the base element. |
Last updated: 22 October 2026