ToggleGroupControl

ToggleGroupControl is a form component that lets users choose options represented in horizontal segments. To render options for this control use ToggleGroupControlOption component.

This component is intended for selecting a single persistent value from a set of options, similar to a how a radio button group would work. If you simply want a toggle to switch between views, use a TabPanel instead.

Only use this control when you know for sure the labels of items inside won’t wrap. For items with longer labels, you can consider a SelectControl or a CustomSelectControl component instead.

Usage

import {
    __experimentalToggleGroupControl as ToggleGroupControl,
    __experimentalToggleGroupControlOption as ToggleGroupControlOption,
} from '@wordpress/components';

function Example() {
    return (
        <ToggleGroupControl
            label="my label"
            value="vertical"
            isBlock
            __nextHasNoMarginBottom
        >
            <ToggleGroupControlOption value="horizontal" label="Horizontal" />
            <ToggleGroupControlOption value="vertical" label="Vertical" />
        </ToggleGroupControl>
    );
}

Props

help: ReactNode

If this property is added, a help text will be generated using help property as the content.

• Required: No

hideLabelFromVision: boolean

If true, the label will only be visible to screen readers.

• Required: No
• Default: false

isAdaptiveWidth: boolean

Determines if segments should be rendered with equal widths.

• Required: No
• Default: false

isDeselectable: boolean

Whether an option can be deselected by clicking it again.

• Required: No
• Default: false

isBlock: boolean

Renders ToggleGroupControl as a (CSS) block element, spanning the entire width of the available space. This is the recommended style when the options are text-based and not icons.

• Required: No
• Default: false

label: string

Label for the form element.

• Required: Yes

onChange: ( value?: string | number ) => void

Callback when a segment is selected.

• Required: No
• Default: () => {}

value: string | number

The value of the ToggleGroupControl.

• Required: No

__next40pxDefaultSize: boolean

Start opting into the larger default height that will become the default size in a future version.

• Required: No
• Default: false

__nextHasNoMarginBottom: boolean

Start opting into the new margin-free styles that will become the default in a future version.

• Required: No
• Default: false