Toggle group

A toggle group is a group of controls that can be used to quickly switch between actions or states.

Examples

Single select toggle group

A single select toggle group allows users to toggle between multiple items.

To indicate whether a <ToggleGroupItem> is selected or not, use the isSelected property.

Multi select toggle group

A multi select toggle group allows users to select multiple items at once.

When a toggle item is disabled it cannot be selected. Click the "Disable all" button in the following example to see this in action.

With icons

You can use a recognizable icon as a toggle item label.

To do this, pass an imported icon to the icon property of a <ToggleGroupItem>.

With text and icons

Adding text to a toggle item with an icon helps clarify the button's function.

To do this, pass a descriptive label to the text property of a <ToggleGroupItem>.


Compact toggle group

When space in a UI is limited, you can use a compact toggle group.

To apply compact styling to a <ToggleGroup>, use isCompact.

Props

ToggleGroup

*required
NameTypeDefaultDescription
areAllGroupsDisabledbooleanfalseDisable all toggle group items under this component.
aria-labelstringAccessible label for the toggle group
childrenReact.ReactNodeContent rendered inside the toggle group
classNamestringAdditional classes added to the toggle group
isCompactbooleanfalseModifies the toggle group to include compact styling.

ToggleGroupItem

*required
NameTypeDefaultDescription
aria-labelstringrequired when icon is used with no supporting text
buttonIdstringOptional id for the button within the toggle group item
classNamestringAdditional classes added to the toggle group item
iconReact.ReactNodeIcon rendered inside the toggle group item
iconPosition'start' | 'end''start'Sets position of the icon when text is also passed in
isDisabledbooleanfalseFlag indicating if the toggle group item is disabled
isSelectedbooleanfalseFlag indicating if the toggle group item is selected
onChange(event: React.MouseEvent<any> | React.KeyboardEvent | MouseEvent, selected: boolean) => void() => {}A callback for when the toggle group item selection changes.
textReact.ReactNodeText rendered inside the toggle group item

CSS variables

Expand or collapse columnSelectorVariableValue

View source on GitHub