import { Meta } from '@storybook/addon-docs/blocks';

<Meta title="Actions/ButtonGroup" />

# ButtonGroup

A container for grouping buttons with consistent spacing. Extends `Space` and inherits all its defaults.

## When to Use

- Grouping related actions (Save/Cancel)
- Button bars and toolbars

## Properties

Inherits all [Space](/docs/layout-space--docs) properties.

### Style Defaults

Inherits Space defaults:

- `display` — `flex`
- `gap` — `1x`
- `flow` — `row`
- `placeItems` — `center stretch`
- `gridArea` — `buttonGroup`

### Base Properties

Supports [Base properties](/docs/getting-started-base-properties--docs).

### Style Properties

These properties allow direct style application without using the `styles` prop:

- **Base:** `display`, `font`, `preset`, `hide`, `whiteSpace`, `opacity`, `transition`
- **Position:** `gridArea`, `order`, `gridColumn`, `gridRow`, `placeSelf`, `alignSelf`, `justifySelf`, `zIndex`, `margin`, `blockMargin`, `inlineMargin`, `inset`, `blockInset`, `inlineInset`, `position`, `scrollMargin`, `blockScrollMargin`, `inlineScrollMargin`, `scrollPadding`, `blockScrollPadding`, `inlineScrollPadding`
- **Dimension:** `width`, `height`, `blockSize`, `inlineSize`, `flexBasis`, `flexGrow`, `flexShrink`, `flex`
- **Block:** `border`, `blockBorder`, `inlineBorder`, `radius`, `shadow`, `outline`, `padding`, `blockPadding`, `inlinePadding`, `overflow`, `scrollbar`, `textAlign`
- **Color:** `color`, `fill`, `fade`, `image`
- **Flow:** `flow`, `place`, `placeItems`, `placeContent`, `alignItems`, `alignContent`, `justifyItems`, `justifyContent`, `align`, `justify`, `gap`, `columnGap`, `rowGap`, `gridColumns`, `gridRows`, `gridTemplate`, `gridAreas`

## Examples

### Horizontal group

```jsx
<Button.Group>
  <Button>Save</Button>
  <Button type="outline">Cancel</Button>
</Button.Group>
```

### Vertical group

```jsx
<Button.Group direction="vertical">
  <Button>Option 1</Button>
  <Button>Option 2</Button>
</Button.Group>
```
