useToggleButtonGroup

install	`yarn add react-aria`
version	3.36.0
usage	`import {useToggleButtonGroup} from 'react-aria'`

API#

useToggleButtonGroup(
  props: AriaToggleButtonGroupProps,
  state: ToggleGroupState,
  ref: RefObject<HTMLElement
    |  | null>
): ToggleButtonGroupAria

useToggleButtonGroupItem(
  props: AriaToggleButtonGroupItemOptions<ElementType>,
  state: ToggleGroupState,
  ref: RefObject<any>
): ToggleButtonAria<HTMLAttributes<any>>

Features#

There is no built in element for toggle button groups in HTML. useToggleButtonGroup helps achieve accessible toggle button groups that can be styled as needed.

Accessible – Represented as an ARIA radiogroup when using single selection, or a toolbar when using multiple selection.
Keyboard navigation – Users can navigate between buttons with the arrow keys. Selection can be toggled using the Enter or Space keys.
Styleable – Hover, press, keyboard focus, and selection states are provided for easy styling.

Anatomy#

A toggle button group consists of a set of toggle buttons, and coordinates the selection state between them. Users can navigate between buttons with the arrow keys in either horizontal or vertical orientations.

useToggleButtonGroup returns props for the toggle button group:

Name	Type	Description
`groupProps`	`DOMAttributes`	Props for the toggle button group container.

useToggleButtonGroupItem returns props for an individual toggle button:

Name	Type	Description
`isSelected`	`boolean`	Whether the button is selected.
`isDisabled`	`boolean`	Whether the button is disabled.
`buttonProps`	`T`	Props for the button element.
`isPressed`	`boolean`	Whether the button is currently pressed.

Selection state is managed by the useToggleGroupState hook in @react-stately/toggle. The state object should be passed as an option to useToggleButtonGroup and useToggleButtonGroupItem.

Note: useToggleButtonGroupItem should only be used when it is contained within a toggle button group. For a standalone toggle button, use the useToggleButton hook instead.

Example#

import type {ToggleGroupState} from 'react-stately';
import type {AriaToggleButtonGroupItemProps, AriaToggleButtonGroupProps} from 'react-aria';
import {useToggleGroupState} from 'react-stately';
import {useToggleButtonGroup, useToggleButtonGroupItem} from 'react-aria';

interface ToggleButtonGroupProps extends AriaToggleButtonGroupProps {
  children: React.ReactNode;
}

let ToggleButtonGroupContext = React.createContext<ToggleGroupState | null>(
  null
);

function ToggleButtonGroup(props: ToggleButtonGroupProps) {
  let state = useToggleGroupState(props);
  let ref = React.useRef<HTMLDivElement | null>(null);
  let { groupProps } = useToggleButtonGroup(props, state, ref);

  return (
    <div {...groupProps} className="toggle-group" ref={ref}>
      <ToggleButtonGroupContext.Provider value={state}>
        {props.children}
      </ToggleButtonGroupContext.Provider>
    </div>
  );
}

function ToggleButton(props: AriaToggleButtonGroupItemProps) {
  let ref = React.useRef<HTMLButtonElement | null>(null);
  let state = React.useContext(ToggleButtonGroupContext)!;
  let { buttonProps, isPressed, isSelected } = useToggleButtonGroupItem(
    props,
    state,
    ref
  );

  return (
    <button
      {...buttonProps}
      className="toggle-button"
      data-pressed={isPressed}
      data-selected={isSelected}
      ref={ref}
    >
      {props.children}
    </button>
  );
}

<ToggleButtonGroup>
  <ToggleButton id="left">Left</ToggleButton>
  <ToggleButton id="center">Center</ToggleButton>
  <ToggleButton id="right">Right</ToggleButton>
</ToggleButtonGroup>

import type {ToggleGroupState} from 'react-stately';
import type {
  AriaToggleButtonGroupItemProps,
  AriaToggleButtonGroupProps
} from 'react-aria';
import {useToggleGroupState} from 'react-stately';
import {
  useToggleButtonGroup,
  useToggleButtonGroupItem
} from 'react-aria';

interface ToggleButtonGroupProps
  extends AriaToggleButtonGroupProps {
  children: React.ReactNode;
}

let ToggleButtonGroupContext = React.createContext<
  ToggleGroupState | null
>(null);

function ToggleButtonGroup(props: ToggleButtonGroupProps) {
  let state = useToggleGroupState(props);
  let ref = React.useRef<HTMLDivElement | null>(null);
  let { groupProps } = useToggleButtonGroup(
    props,
    state,
    ref
  );

  return (
    <div {...groupProps} className="toggle-group" ref={ref}>
      <ToggleButtonGroupContext.Provider value={state}>
        {props.children}
      </ToggleButtonGroupContext.Provider>
    </div>
  );
}

function ToggleButton(
  props: AriaToggleButtonGroupItemProps
) {
  let ref = React.useRef<HTMLButtonElement | null>(null);
  let state = React.useContext(ToggleButtonGroupContext)!;
  let { buttonProps, isPressed, isSelected } =
    useToggleButtonGroupItem(props, state, ref);

  return (
    <button
      {...buttonProps}
      className="toggle-button"
      data-pressed={isPressed}
      data-selected={isSelected}
      ref={ref}
    >
      {props.children}
    </button>
  );
}

<ToggleButtonGroup>
  <ToggleButton id="left">Left</ToggleButton>
  <ToggleButton id="center">Center</ToggleButton>
  <ToggleButton id="right">Right</ToggleButton>
</ToggleButtonGroup>

import type {ToggleGroupState} from 'react-stately';
import type {
  AriaToggleButtonGroupItemProps,
  AriaToggleButtonGroupProps
} from 'react-aria';
import {useToggleGroupState} from 'react-stately';
import {
  useToggleButtonGroup,
  useToggleButtonGroupItem
} from 'react-aria';

interface ToggleButtonGroupProps
  extends
    AriaToggleButtonGroupProps {
  children:
    React.ReactNode;
}

let ToggleButtonGroupContext =
  React.createContext<
    | ToggleGroupState
    | null
  >(null);

function ToggleButtonGroup(
  props:
    ToggleButtonGroupProps
) {
  let state =
    useToggleGroupState(
      props
    );
  let ref = React.useRef<
    HTMLDivElement | null
  >(null);
  let { groupProps } =
    useToggleButtonGroup(
      props,
      state,
      ref
    );

  return (
    <div
      {...groupProps}
      className="toggle-group"
      ref={ref}
    >
      <ToggleButtonGroupContext.Provider
        value={state}
      >
        {props.children}
      </ToggleButtonGroupContext.Provider>
    </div>
  );
}

function ToggleButton(
  props:
    AriaToggleButtonGroupItemProps
) {
  let ref = React.useRef<
    | HTMLButtonElement
    | null
  >(null);
  let state = React
    .useContext(
      ToggleButtonGroupContext
    )!;
  let {
    buttonProps,
    isPressed,
    isSelected
  } =
    useToggleButtonGroupItem(
      props,
      state,
      ref
    );

  return (
    <button
      {...buttonProps}
      className="toggle-button"
      data-pressed={isPressed}
      data-selected={isSelected}
      ref={ref}
    >
      {props.children}
    </button>
  );
}

<ToggleButtonGroup>
  <ToggleButton id="left">
    Left
  </ToggleButton>
  <ToggleButton id="center">
    Center
  </ToggleButton>
  <ToggleButton id="right">
    Right
  </ToggleButton>
</ToggleButtonGroup>

Show CSS

.toggle-group {
  display: flex;
  gap: 4px;

  &[aria-orientation=vertical] {
    flex-direction: column;
    width: fit-content;
  }
}

.toggle-button {
  background: lightgray;
  color: black;
  padding: 10px;
  font-size: 16px;
  user-select: none;
  border: none;

  &[data-pressed=true] {
    background: gray;
  }

  &[data-selected=true] {
    background: green;
    color: white;

    &[data-pressed=true] {
      background: darkgreen;
    }
  }

  &:disabled {
    opacity: 0.5;
  }
}

.toggle-group {
  display: flex;
  gap: 4px;

  &[aria-orientation=vertical] {
    flex-direction: column;
    width: fit-content;
  }
}

.toggle-button {
  background: lightgray;
  color: black;
  padding: 10px;
  font-size: 16px;
  user-select: none;
  border: none;

  &[data-pressed=true] {
    background: gray;
  }

  &[data-selected=true] {
    background: green;
    color: white;

    &[data-pressed=true] {
      background: darkgreen;
    }
  }

  &:disabled {
    opacity: 0.5;
  }
}

.toggle-group {
  display: flex;
  gap: 4px;

  &[aria-orientation=vertical] {
    flex-direction: column;
    width: fit-content;
  }
}

.toggle-button {
  background: lightgray;
  color: black;
  padding: 10px;
  font-size: 16px;
  user-select: none;
  border: none;

  &[data-pressed=true] {
    background: gray;
  }

  &[data-selected=true] {
    background: green;
    color: white;

    &[data-pressed=true] {
      background: darkgreen;
    }
  }

  &:disabled {
    opacity: 0.5;
  }
}

Selection#

ToggleButtonGroup supports both single and multiple selection modes. Use defaultSelectedKeys to provide a default set of selected items (uncontrolled) and selectedKeys to set the selected items (controlled). The value of the selected keys must match the id prop of the items.

Single selection#

By default, the selectionMode of a ToggleButtonGroup is "single".

<ToggleButtonGroup defaultSelectedKeys={['list']}>
  <ToggleButton id="grid">Grid view</ToggleButton>
  <ToggleButton id="list">List view</ToggleButton>
  <ToggleButton id="gallery">Gallery view</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup defaultSelectedKeys={['list']}>
  <ToggleButton id="grid">Grid view</ToggleButton>
  <ToggleButton id="list">List view</ToggleButton>
  <ToggleButton id="gallery">Gallery view</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup
  defaultSelectedKeys={[
    'list'
  ]}
>
  <ToggleButton id="grid">
    Grid view
  </ToggleButton>
  <ToggleButton id="list">
    List view
  </ToggleButton>
  <ToggleButton id="gallery">
    Gallery view
  </ToggleButton>
</ToggleButtonGroup>

Multiple selection#

Set selectionMode prop to multiple to allow more than one selection.

<ToggleButtonGroup selectionMode="multiple">
  <ToggleButton id="bold">Bold</ToggleButton>
  <ToggleButton id="italic">Italic</ToggleButton>
  <ToggleButton id="underline">Underline</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup selectionMode="multiple">
  <ToggleButton id="bold">Bold</ToggleButton>
  <ToggleButton id="italic">Italic</ToggleButton>
  <ToggleButton id="underline">Underline</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup selectionMode="multiple">
  <ToggleButton id="bold">
    Bold
  </ToggleButton>
  <ToggleButton id="italic">
    Italic
  </ToggleButton>
  <ToggleButton id="underline">
    Underline
  </ToggleButton>
</ToggleButtonGroup>

Controlled selection#

The selectedKeys prop can be used to make the selected state controlled.

import type {Key} from 'react-stately';

function Example() {
  let [selected, setSelected] = React.useState(new Set<Key>(['bold']));

  return (
    <>
      <ToggleButtonGroup
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        <ToggleButton id="bold">Bold</ToggleButton>
        <ToggleButton id="italic">Italic</ToggleButton>
        <ToggleButton id="underline">Underline</ToggleButton>
      </ToggleButtonGroup>
      <p>Current selections (controlled): {[...selected].join(', ')}</p>
    </>
  );
}

import type {Key} from 'react-stately';

function Example() {
  let [selected, setSelected] = React.useState(
    new Set<Key>(['bold'])
  );

  return (
    <>
      <ToggleButtonGroup
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        <ToggleButton id="bold">Bold</ToggleButton>
        <ToggleButton id="italic">Italic</ToggleButton>
        <ToggleButton id="underline">
          Underline
        </ToggleButton>
      </ToggleButtonGroup>
      <p>
        Current selections (controlled):{' '}
        {[...selected].join(', ')}
      </p>
    </>
  );
}

import type {Key} from 'react-stately';

function Example() {
  let [
    selected,
    setSelected
  ] = React.useState(
    new Set<Key>([
      'bold'
    ])
  );

  return (
    <>
      <ToggleButtonGroup
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        <ToggleButton id="bold">
          Bold
        </ToggleButton>
        <ToggleButton id="italic">
          Italic
        </ToggleButton>
        <ToggleButton id="underline">
          Underline
        </ToggleButton>
      </ToggleButtonGroup>
      <p>
        Current
        selections
        (controlled):
        {' '}
        {[...selected]
          .join(', ')}
      </p>
    </>
  );
}

Disabled#

All buttons within a ToggleButtonGroup can be disabled using the isDisabled prop.

<ToggleButtonGroup isDisabled>
  <ToggleButton id="grid">Grid view</ToggleButton>
  <ToggleButton id="list">List view</ToggleButton>
  <ToggleButton id="gallery">Gallery view</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup isDisabled>
  <ToggleButton id="grid">Grid view</ToggleButton>
  <ToggleButton id="list">List view</ToggleButton>
  <ToggleButton id="gallery">Gallery view</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup
  isDisabled
>
  <ToggleButton id="grid">
    Grid view
  </ToggleButton>
  <ToggleButton id="list">
    List view
  </ToggleButton>
  <ToggleButton id="gallery">
    Gallery view
  </ToggleButton>
</ToggleButtonGroup>

Individual items can be disabled using the isDisabled prop on each ToggleButton.

<ToggleButtonGroup>
  <ToggleButton id="grid">Grid view</ToggleButton>
  <ToggleButton id="list" isDisabled>List view</ToggleButton>
  <ToggleButton id="gallery">Gallery view</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup>
  <ToggleButton id="grid">Grid view</ToggleButton>
  <ToggleButton id="list" isDisabled>
    List view
  </ToggleButton>
  <ToggleButton id="gallery">Gallery view</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup>
  <ToggleButton id="grid">
    Grid view
  </ToggleButton>
  <ToggleButton
    id="list"
    isDisabled
  >
    List view
  </ToggleButton>
  <ToggleButton id="gallery">
    Gallery view
  </ToggleButton>
</ToggleButtonGroup>

Orientation#

By default, toggle button groups are horizontally oriented. The orientation prop can be set to "vertical" to change the arrow key navigation behavior.

<ToggleButtonGroup orientation="vertical">
  <ToggleButton id="grid">Grid</ToggleButton>
  <ToggleButton id="list">List</ToggleButton>
  <ToggleButton id="gallery">Gallery</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup orientation="vertical">
  <ToggleButton id="grid">Grid</ToggleButton>
  <ToggleButton id="list">List</ToggleButton>
  <ToggleButton id="gallery">Gallery</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup orientation="vertical">
  <ToggleButton id="grid">
    Grid
  </ToggleButton>
  <ToggleButton id="list">
    List
  </ToggleButton>
  <ToggleButton id="gallery">
    Gallery
  </ToggleButton>
</ToggleButtonGroup>

Accessiblity#

A ToggleButtonGroup can be labeled using the aria-label or aria-labelledby props.

<ToggleButtonGroup aria-label="Text style">
  <ToggleButton id="bold">Bold</ToggleButton>
  <ToggleButton id="italic">Italic</ToggleButton>
  <ToggleButton id="underline">Underline</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup aria-label="Text style">
  <ToggleButton id="bold">Bold</ToggleButton>
  <ToggleButton id="italic">Italic</ToggleButton>
  <ToggleButton id="underline">Underline</ToggleButton>
</ToggleButtonGroup>

<ToggleButtonGroup aria-label="Text style">
  <ToggleButton id="bold">
    Bold
  </ToggleButton>
  <ToggleButton id="italic">
    Italic
  </ToggleButton>
  <ToggleButton id="underline">
    Underline
  </ToggleButton>
</ToggleButtonGroup>

Name	Type	Default	Description
`orientation`	`Orientation`	`'horizontal'`	The orientation of the the toggle button group.
`selectionMode`	`'single' \| 'multiple'`	—	Whether single or multiple selection is enabled.
`disallowEmptySelection`	`boolean`	—	Whether the collection allows empty selection.
`selectedKeys`	`Iterable<Key>`	—	The currently selected keys in the collection (controlled).
`defaultSelectedKeys`	`Iterable<Key>`	—	The initial selected keys in the collection (uncontrolled).
`onSelectionChange`	`( (keys: Set<Key> )) => void`	—	Handler that is called when the selection changes.
`isDisabled`	`boolean`	—	Whether all items are disabled.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.

'horizontal' | 'vertical'

string | number

Properties

Name	Type	Description
`selectionMode`	`'single' \| 'multiple'`	Whether single or multiple selection is enabled.
`isDisabled`	`boolean`	Whether all items are disabled.
`selectedKeys`	`Set<Key>`	A set of keys for items that are selected.

Methods

Method	Description
`toggleKey( (key: Key )): void`	Toggles the selected state for an item by its key.
`setSelected( (key: Key, , isSelected: boolean )): void`	Sets whether the given key is selected.
`setSelectedKeys( (keys: Set<Key> )): void`	Replaces the set of selected keys.

Name	Type	Description
`current`	`T`

Name	Type	Description
`groupProps`	`DOMAttributes`	Props for the toggle button group container.

All DOM attributes supported across both HTML and SVG elements.

Extends: AriaAttributes, ReactDOMAttributes

Name	Type	Description
`id`	`string \| undefined`
`role`	`AriaRole \| undefined`
`tabIndex`	`number \| undefined`
`style`	`CSSProperties \| undefined`
`className`	`string \| undefined`

Name	Type	Default	Description
`id`	`Key`	—	An identifier for the item in the `selectedKeys` of a ToggleButtonGroup.
`isDisabled`	`boolean`	—	Whether the button is disabled.
`onPress`	`( (e: PressEvent )) => void`	—	Handler that is called when the press is released over the target.
`onPressStart`	`( (e: PressEvent )) => void`	—	Handler that is called when a press interaction starts.
`onPressEnd`	`( (e: PressEvent )) => void`	—	Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
`onPressChange`	`( (isPressed: boolean )) => void`	—	Handler that is called when the press state changes.
`onPressUp`	`( (e: PressEvent )) => void`	—	Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => void`	—	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	—	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is released.
`aria-expanded`	`boolean \| 'true' \| 'false'`	—	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
`aria-haspopup`	`boolean \| 'menu' \| 'listbox' \| 'tree' \| 'grid' \| 'dialog' \| 'true' \| 'false'`	—	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`aria-controls`	`string`	—	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-pressed`	`boolean \| 'true' \| 'false' \| 'mixed'`	—	Indicates the current "pressed" state of toggle buttons.
`type`	`'button' \| 'submit' \| 'reset'`	`'button'`	The behavior of the button when used in an HTML form.
`preventFocusOnPress`	`boolean`	—	Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.
`excludeFromTabOrder`	`boolean`	—	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`elementType`	`ElementType \| JSXElementConstructor<any>`	`'button'`	The HTML element or React element used to render the button, e.g. 'div', 'a', or `RouterLink`.

Properties

Name	Type	Description
`type`	`'pressstart' \| 'pressend' \| 'pressup' \| 'press'`	The type of press event being fired.
`pointerType`	`PointerType`	The pointer type that triggered the press event.
`target`	`Element`	The target element of the press event.
`shiftKey`	`boolean`	Whether the shift keyboard modifier was held during the press event.
`ctrlKey`	`boolean`	Whether the ctrl keyboard modifier was held during the press event.
`metaKey`	`boolean`	Whether the meta keyboard modifier was held during the press event.
`altKey`	`boolean`	Whether the alt keyboard modifier was held during the press event.
`x`	`number`	X position relative to the target.
`y`	`number`	Y position relative to the target.

Methods

Method	Description
`continuePropagation(): void`	By default, press events stop propagation to parent elements. In cases where a handler decides not to handle a specific event, it can call `continuePropagation()` to allow a parent to handle it.

'mouse'
  | 'pen'
  | 'touch'
  | 'keyboard'
  | 'virtual'

BaseEvent<ReactKeyboardEvent<any>>

SyntheticEvent & {stopPropagation: () => void,
continuePropagation: () => void
}

Name	Type	Description
`isSelected`	`boolean`	Whether the button is selected.
`isDisabled`	`boolean`	Whether the button is disabled.
`buttonProps`	`T`	Props for the button element.
`isPressed`	`boolean`	Whether the button is currently pressed.

Manages state for a group of toggles. It supports both single and multiple selected items.

useToggleGroupState(
  (props: ToggleGroupProps
)): ToggleGroupState

Name	Type	Description
`selectionMode`	`'single' \| 'multiple'`	Whether single or multiple selection is enabled.
`disallowEmptySelection`	`boolean`	Whether the collection allows empty selection.
`selectedKeys`	`Iterable<Key>`	The currently selected keys in the collection (controlled).
`defaultSelectedKeys`	`Iterable<Key>`	The initial selected keys in the collection (uncontrolled).
`onSelectionChange`	`( (keys: Set<Key> )) => void`	Handler that is called when the selection changes.
`isDisabled`	`boolean`	Whether all items are disabled.