---
title: Toggle Group
subtitle: Provides a shared state to a series of toggle buttons.
description: A high-quality, unstyled React toggle group component that provides shared state to a series of toggle buttons.
---
# Toggle Group
A high-quality, unstyled React toggle group component that provides shared state to a series of toggle buttons.
## Demo
### Tailwind
This example shows how to implement the component using Tailwind CSS.
```tsx
/* index.tsx */
import * as React from 'react';
import { Toggle } from '@base-ui/react/toggle';
import { ToggleGroup } from '@base-ui/react/toggle-group';
export default function ExampleToggleGroup() {
return (
);
}
function AlignLeftIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function AlignCenterIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function AlignRightIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
### CSS Modules
This example shows how to implement the component using CSS Modules.
```css
/* index.module.css */
.Panel {
display: flex;
gap: 1px;
border: 1px solid var(--color-gray-200);
background-color: var(--color-gray-50);
border-radius: 0.375rem;
padding: 0.125rem;
}
.Button {
box-sizing: border-box;
display: flex;
align-items: center;
justify-content: center;
width: 2rem;
height: 2rem;
padding: 0;
margin: 0;
outline: 0;
border: 0;
border-radius: 0.25rem;
background-color: transparent;
color: var(--color-gray-600);
user-select: none;
&:focus-visible {
background-color: transparent;
outline: 2px solid var(--color-blue);
outline-offset: -1px;
}
&:active {
background-color: var(--color-gray-200);
}
&[data-pressed] {
background-color: var(--color-gray-100);
color: var(--color-gray-900);
}
}
.Icon {
width: 1rem;
height: 1rem;
}
```
```tsx
/* index.tsx */
import * as React from 'react';
import { Toggle } from '@base-ui/react/toggle';
import { ToggleGroup } from '@base-ui/react/toggle-group';
import styles from './index.module.css';
export default function ExampleToggleGroup() {
return (
);
}
function AlignLeftIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function AlignCenterIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function AlignRightIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
## Anatomy
Import the component and use it as a single part:
```jsx title="Anatomy"
import { ToggleGroup } from '@base-ui/react/toggle-group';
;
```
## Examples
### Multiple
Add the `multiple` prop to allow pressing more than one toggle at a time.
## Demo
### Tailwind
This example shows how to implement the component using Tailwind CSS.
```tsx
/* index.tsx */
import { Toggle } from '@base-ui/react/toggle';
import { ToggleGroup } from '@base-ui/react/toggle-group';
export default function ExampleToggleGroupMultiple() {
return (
);
}
function BoldIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function ItalicIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function UnderlineIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
### CSS Modules
This example shows how to implement the component using CSS Modules.
```css
/* index.module.css */
.Panel {
display: flex;
gap: 1px;
border: 1px solid var(--color-gray-200);
background-color: var(--color-gray-50);
border-radius: 0.375rem;
padding: 0.125rem;
}
.Button {
box-sizing: border-box;
display: flex;
align-items: center;
justify-content: center;
width: 2rem;
height: 2rem;
padding: 0;
margin: 0;
outline: 0;
border: 0;
border-radius: 0.25rem;
background-color: transparent;
font-family: inherit;
font-size: 1rem;
color: var(--color-gray-600);
user-select: none;
&:focus-visible {
background-color: transparent;
outline: 2px solid var(--color-blue);
outline-offset: -1px;
}
&:active {
background-color: var(--color-gray-200);
}
&[data-pressed] {
background-color: var(--color-gray-100);
color: var(--color-gray-900);
}
}
```
```tsx
/* index.tsx */
import { Toggle } from '@base-ui/react/toggle';
import { ToggleGroup } from '@base-ui/react/toggle-group';
import styles from './index.module.css';
export default function ExampleToggleGroupMultiple() {
return (
);
}
function BoldIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function ItalicIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
function UnderlineIcon(props: React.ComponentProps<'svg'>) {
return (
);
}
```
## API reference
### ToggleGroup
Provides a shared state to a series of toggle buttons.
**ToggleGroup Props:**
| Prop | Type | Default | Description |
| :------------ | :---------------------------------------------------------------------------------------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| defaultValue | `string[]` | - | The open state of the toggle group represented by an array of
the values of all pressed toggle buttons.
This is the uncontrolled counterpart of `value`. |
| value | `string[]` | - | The open state of the toggle group represented by an array of
the values of all pressed toggle buttons.
This is the controlled counterpart of `defaultValue`. |
| onValueChange | `((groupValue: string[], eventDetails: ToggleGroup.ChangeEventDetails) => void)` | - | Callback fired when the pressed states of the toggle group changes. |
| loopFocus | `boolean` | `true` | Whether to loop keyboard focus back to the first item
when the end of the list is reached while using the arrow keys. |
| multiple | `boolean` | `false` | When `false` only one item in the group can be pressed. If any item in
the group becomes pressed, the others will become unpressed.
When `true` multiple items can be pressed. |
| disabled | `boolean` | `false` | Whether the toggle group should ignore user interaction. |
| orientation | `Orientation` | `'horizontal'` | - |
| className | `string \| ((state: ToggleGroup.State) => string \| undefined)` | - | CSS class applied to the element, or a function that
returns a class based on the component's state. |
| style | `React.CSSProperties \| ((state: ToggleGroup.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that
returns a style object based on the component's state. |
| render | `ReactElement \| ((props: HTMLProps, state: ToggleGroup.State) => ReactElement)` | - | Allows you to replace the component's HTML element
with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
**ToggleGroup Data Attributes:**
| Attribute | Type | Description |
| :--------------- | :--------------------------- | :------------------------------------------------------------------------------------------------- |
| data-orientation | `'horizontal' \| 'vertical'` | Indicates the orientation of the toggle group. |
| data-disabled | - | Present when the toggle group is disabled. |
| data-multiple | - | Present when the toggle group allows multiple buttons to be in the pressed state at the same time. |
### ToggleGroup.Props
Re-export of [ToggleGroup](/react/components/toggle-group.md) props.
### ToggleGroup.State
```typescript
type ToggleGroupState = {
/** Whether the component should ignore user interaction. */
disabled: boolean;
/**
* When `false` only one item in the group can be pressed. If any item in
* the group becomes pressed, the others will become unpressed.
* When `true` multiple items can be pressed.
* @default false
*/
multiple: boolean;
/** The orientation of the toggle group. */
orientation: Orientation;
};
```
### ToggleGroup.ChangeEventReason
```typescript
type ToggleGroupChangeEventReason = 'none';
```
### ToggleGroup.ChangeEventDetails
```typescript
type ToggleGroupChangeEventDetails = {
/** The reason for the event. */
reason: 'none';
/** The native event associated with the custom event. */
event: Event;
/** Cancels Base UI from handling the event. */
cancel: () => void;
/** Allows the event to propagate in cases where Base UI will stop the propagation. */
allowPropagation: () => void;
/** Indicates whether the event has been canceled. */
isCanceled: boolean;
/** Indicates whether the event is allowed to propagate. */
isPropagationAllowed: boolean;
/** The element that triggered the event, if applicable. */
trigger: Element | undefined;
};
```
## External Types
### Orientation
```typescript
type Orientation = 'horizontal' | 'vertical';
```
## Canonical Types
Maps `Canonical`: `Alias` — Use Canonical when its namespace is already imported; otherwise use Alias.
- `ToggleGroup.State`: `ToggleGroupState`
- `ToggleGroup.Props`: `ToggleGroupProps`
- `ToggleGroup.ChangeEventReason`: `ToggleGroupChangeEventReason`
- `ToggleGroup.ChangeEventDetails`: `ToggleGroupChangeEventDetails`