# Toggle Group

A set of two-state buttons that can be toggled on or off.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).





<ComponentPreview name="toggle-group-demo">
  <ToggleGroupDemo />
</ComponentPreview>

## Installation [#installation]

<Tabs defaultValue="cli">
  <TabsList>
    <TabsTrigger value="cli">
      CLI
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add https://shadcn-cssinjs.com/r/toggle-group.json
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      pnpm add @base-ui/react @stylexjs/stylex
      ```

      <Step>
        Make sure [StyleX is configured](/docs/installation) and the design tokens are
        installed.
      </Step>

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource name="toggle-group" title="toggle-group.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</Tabs>

## Usage [#usage]

```tsx
import {
  ToggleGroup,
  ToggleGroupItem,
} from "@/components/ui/toggle-group/toggle-group";
```

```tsx
<ToggleGroup multiple>
  <ToggleGroupItem value="bold">B</ToggleGroupItem>
  <ToggleGroupItem value="italic">I</ToggleGroupItem>
</ToggleGroup>
```

## Composition [#composition]

Use the following composition to build a `Toggle Group`:

```txt
ToggleGroup
├── ToggleGroupItem
└── ToggleGroupItem
```

## Examples [#examples]



### Outline [#outline]

<ComponentPreview name="toggle-group-outline">
  <ToggleGroupOutline />
</ComponentPreview>

### Size [#size]

<ComponentPreview name="toggle-group-sizes">
  <ToggleGroupSizes />
</ComponentPreview>

### Spacing [#spacing]

Use the `spacing` prop to separate the items.

<ComponentPreview name="toggle-group-spacing">
  <ToggleGroupSpacing />
</ComponentPreview>

### Vertical [#vertical]

<ComponentPreview name="toggle-group-vertical">
  <ToggleGroupVertical />
</ComponentPreview>

### Disabled [#disabled]

<ComponentPreview name="toggle-group-disabled">
  <ToggleGroupDisabled />
</ComponentPreview>

### Custom [#custom]

<ComponentPreview name="toggle-group-custom">
  <ToggleGroupCustom />
</ComponentPreview>



## RTL [#rtl]

To enable right-to-left support, see the [RTL guide](/docs/rtl).

<ComponentPreview name="toggle-group-rtl" direction="rtl">
  <ToggleGroupRtl />
</ComponentPreview>

## API Reference [#api-reference]

See the [Base UI](https://base-ui.com/react/components/toggle-group#api-reference) documentation for the full API.