Toggle Group

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

import { TextBIcon, TextItalicIcon, TextUnderlineIcon } from "@phosphor-icons/react"

import {

Installation


pnpm dlx shadcn@latest add https://anotherui.dev/r/toggle-group.json

Usage

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

<ToggleGroup type="single">
  <ToggleGroupItem value="a">A</ToggleGroupItem>
  <ToggleGroupItem value="b">B</ToggleGroupItem>
  <ToggleGroupItem value="c">C</ToggleGroupItem>
</ToggleGroup>

Composition

Use the following composition to build a ToggleGroup:

ToggleGroup
├── ToggleGroupItem
└── ToggleGroupItem

Outline

Use variant="outline" for an outline style.

import {
  ToggleGroup,
  ToggleGroupItem,

Size

Use the size prop to change the size of the toggle group.

import {
  ToggleGroup,
  ToggleGroupItem,

Spacing

Use spacing to add spacing between toggle group items.

import {
  ToggleGroup,
  ToggleGroupItem,

Vertical

Use orientation="vertical" for vertical toggle groups.

import { TextBIcon, TextItalicIcon, TextUnderlineIcon } from "@phosphor-icons/react"

import {

Disabled

import { TextBIcon, TextItalicIcon, TextUnderlineIcon } from "@phosphor-icons/react"

import {

Custom

A custom toggle group example.

"use client"

import * as React from "react"

RTL

To enable RTL support, see the RTL configuration guide.

"use client"

import * as React from "react"

API Reference

See the Base UI Toggle Group documentation.

Toggle Tool Call

On This Page

Installation Usage Composition Outline Size Spacing Vertical Disabled Custom RTL API Reference