Button Group

A container that groups related buttons together with consistent styling.

"use client"

import * as React from "react"

Installation


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

Usage

import {
  ButtonGroup,
  ButtonGroupSeparator,
  ButtonGroupText,
} from "@/components/ui/button-group"

<ButtonGroup>
  <Button>Button 1</Button>
  <Button>Button 2</Button>
</ButtonGroup>

Composition

Use the following composition to build a ButtonGroup:

ButtonGroup
├── Button or Input
├── ButtonGroupSeparator
└── ButtonGroupText

Accessibility

The ButtonGroup component has the role attribute set to group.
Use Tab to navigate between the buttons in the group.
Use aria-label or aria-labelledby to label the button group.

<ButtonGroup aria-label="Button group">
  <Button>Button 1</Button>
  <Button>Button 2</Button>
</ButtonGroup>

ButtonGroup vs ToggleGroup

Use the ButtonGroup component when you want to group buttons that perform an action.
Use the ToggleGroup component when you want to group buttons that toggle a state.

Orientation

Set the orientation prop to change the button group layout.

import { MinusIcon, PlusIcon } from "@phosphor-icons/react"

import { Button } from "@/components/ui/button"

Size

Control the size of buttons using the size prop on individual buttons.

import { PlusIcon } from "@phosphor-icons/react"

import { Button } from "@/components/ui/button"

Nested

Nest <ButtonGroup> components to create button groups with spacing.

import { PlusIcon, WaveformIcon } from "@phosphor-icons/react"

import { Button } from "@/components/ui/button"

Separator

The ButtonGroupSeparator component visually divides buttons within a group.

Buttons with variant outline do not need a separator since they have a border. For other variants, a separator is recommended to improve the visual hierarchy.

import { Button } from "@/components/ui/button"
import {
  ButtonGroup,

Split

Create a split button group by adding two buttons separated by a ButtonGroupSeparator.

import { PlusIcon } from "@phosphor-icons/react"

import { Button } from "@/components/ui/button"

Input

Wrap an Input component with buttons.

import { MagnifyingGlassIcon } from "@phosphor-icons/react"

import { Button } from "@/components/ui/button"

Input Group

Wrap an InputGroup component to create complex input layouts.

"use client"

import * as React from "react"

Create a split button group with a DropdownMenu component.

"use client"

import { CaretDownIcon, CheckIcon, CopyIcon, ShareIcon, SpeakerSlashIcon, TrashIcon, UserMinusIcon, WarningIcon } from "@phosphor-icons/react"

Select

Pair with a Select component.

"use client"

import * as React from "react"

Use with a Popover component.

import { CaretDownIcon, RobotIcon } from "@phosphor-icons/react"

import { Button } from "@/components/ui/button"

RTL

To enable RTL support, see the RTL configuration guide.

"use client"

import * as React from "react"

API Reference

ButtonGroup

The ButtonGroup component is a container that groups related buttons together with consistent styling.

Prop	Type	Default
`orientation`	`"horizontal" \| "vertical"`	`"horizontal"`

<ButtonGroup>
  <Button>Button 1</Button>
  <Button>Button 2</Button>
</ButtonGroup>

Nest multiple button groups to create complex layouts with spacing. See the nested example for more details.

<ButtonGroup>
  <ButtonGroup />
  <ButtonGroup />
</ButtonGroup>

ButtonGroupSeparator

The ButtonGroupSeparator component visually divides buttons within a group.

Prop	Type	Default
`orientation`	`"horizontal" \| "vertical"`	`"vertical"`

<ButtonGroup>
  <Button>Button 1</Button>
  <ButtonGroupSeparator />
  <Button>Button 2</Button>
</ButtonGroup>

ButtonGroupText

Use this component to display text within a button group.

Prop	Type	Default
`render`	`React.ReactElement`

<ButtonGroup>
  <ButtonGroupText>Text</ButtonGroupText>
  <Button>Button</Button>
</ButtonGroup>

Use the render prop to render a custom component as the text, for example a label.

import { ButtonGroupText } from "@/components/ui/button-group"
import { Label } from "@/components/ui/label"
 
export function ButtonGroupTextDemo() {
  return (
    <ButtonGroup>
      <ButtonGroupText render={<Label htmlFor="name" />}>Text</ButtonGroupText>
      <Input placeholder="Type something here..." id="name" />
    </ButtonGroup>
  )
}

Button Calendar