Skip to main content

Function: ToggleButtonGroup()

ToggleButtonGroup(__namedParameters): any

Defined in: components/ToggleButtonGroup/ToggleButtonGroup.tsx:56

Groups related ToggleButtons into a single selectable set (Selection entity). React Aria manages selection (selectionMode single | multiple) and arrow-key navigation between the toggles; each child is a ToggleButton with an id.

Parameters

ParameterType
__namedParametersToggleButtonGroupProps

Returns

any

Example

<ToggleButtonGroup selectionMode="single" defaultSelectedKeys={['grid']}>
<ToggleButton id="grid">Grid</ToggleButton>
<ToggleButton id="list">List</ToggleButton>
</ToggleButtonGroup>