# Button Group

A container that groups related buttons with shared borders and orientation.

## Installation

```bash
npx shadcn@latest add https://reactdocs.canceydejean.dev/r/button-group.json
```

[Registry JSON](https://reactdocs.canceydejean.dev/r/button-group.json)

## Preview

```tsx
import { Button } from "@/components/ui/button";

import { ButtonGroup } from "@/components/ui/button-group/button-group";

export function Preview() {
  return (
    <ButtonGroup>
      <Button variant="outline">Copy</Button>
      <Button variant="outline">Paste</Button>
      <Button variant="outline">Cut</Button>
    </ButtonGroup>
  );
}
```


## Source

### button-group.tsx

```tsx
import { mergeProps } from "@base-ui/react/merge-props";
import { useRender } from "@base-ui/react/use-render";
import { type VariantProps } from "class-variance-authority";
import type * as React from "react";

import { Separator } from "@/components/ui/separator";
import { cn } from "cn";

import { buttonGroupVariants } from "./button-group.variants";

function ButtonGroup({
  className,
  orientation,
  ...props
}: React.ComponentProps<"div"> & VariantProps<typeof buttonGroupVariants>) {
  return (
    <div
      role="group"
      data-slot="button-group"
      data-orientation={orientation}
      className={cn(buttonGroupVariants({ orientation }), className)}
      {...props}
    />
  );
}

function ButtonGroupText({
  className,
  render,
  ...props
}: useRender.ComponentProps<"div">) {
  return useRender({
    defaultTagName: "div",
    props: mergeProps<"div">(
      {
        className: cn(
          "flex items-center gap-2 rounded-lg border bg-muted px-2.5 text-sm font-medium [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4",
          className,
        ),
      },
      props,
    ),
    render,
    state: {
      slot: "button-group-text",
    },
  });
}

function ButtonGroupSeparator({
  className,
  orientation = "vertical",
  ...props
}: React.ComponentProps<typeof Separator>) {
  return (
    <Separator
      data-slot="button-group-separator"
      orientation={orientation}
      className={cn(
        "bg-input relative self-stretch data-horizontal:mx-px data-horizontal:w-auto data-vertical:my-px data-vertical:h-auto",
        className,
      )}
      {...props}
    />
  );
}

export {
  ButtonGroup,
  ButtonGroupSeparator,
  ButtonGroupText,
  buttonGroupVariants,
};
```


### button-group.variants.ts

```ts
import { cva } from "class-variance-authority";

import { cn } from "cn"

const buttonGroupBase = cn(
  "flex w-fit items-stretch *:focus-visible:relative *:focus-visible:z-10 has-[>[data-slot=button-group]]:gap-2 has-[select[aria-hidden=true]:last-child]:[&>[data-slot=select-trigger]:last-of-type]:rounded-r-lg [&>[data-slot=select-trigger]:not([class*='w-'])]:w-fit [&>input]:flex-1",
);

const buttonGroupConfig = {
  variants: {
    orientation: {
      horizontal:
        "*:data-slot:rounded-r-none [&>[data-slot]:not(:has(~[data-slot]))]:rounded-r-lg! [&>[data-slot]~[data-slot]]:rounded-l-none [&>[data-slot]~[data-slot]]:border-l-0",
      vertical:
        "flex-col *:data-slot:rounded-b-none [&>[data-slot]:not(:has(~[data-slot]))]:rounded-b-lg! [&>[data-slot]~[data-slot]]:rounded-t-none [&>[data-slot]~[data-slot]]:border-t-0",
    },
  },
  compoundVariants: [],
  defaultVariants: {
    orientation: "horizontal",
  },
} as const;

export const buttonGroupCva = cva(buttonGroupBase, {
  ...buttonGroupConfig,
  compoundVariants: [...buttonGroupConfig.compoundVariants],
});

// Export the orientation variants
export const BUTTON_GROUP_ORIENTATIONS = Object.keys(
  buttonGroupConfig.variants.orientation,
) as (keyof typeof buttonGroupConfig.variants.orientation)[];

export const buttonGroupVariants = buttonGroupCva;
```



## Usage

Use a button group to connect related actions into a single control strip.

```tsx
import { Button } from "@/components/button/button";
import { ButtonGroup } from "@/components/button-group/button-group";

export function Example() {
  return (
    <ButtonGroup>
      <Button variant="outline">Copy</Button>
      <Button variant="outline">Paste</Button>
      <Button variant="outline">Cut</Button>
    </ButtonGroup>
  );
}
```

Set `orientation="vertical"` for a stacked group. Use `ButtonGroupText` for a label segment and
`ButtonGroupSeparator` between sections.