ButtonGroup

ButtonGroup handles overflow for a grouping of buttons whose actions are related to each other.

installyarn add @react-spectrum/buttongroup
version3.0.0-rc.0
usageimport {ButtonGroup} from '@react-spectrum/buttongroup'
View guidelines
Spectrum
View repository
GitHub
View package
NPM

Example#

import {ButtonGroup} from '@react-spectrum/buttongroup';
import {Button} from '@react-spectrum/button';

<ButtonGroup>
  <Button variant="primary">Rate Now</Button>
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
</ButtonGroup>
import {ButtonGroup} from '@react-spectrum/buttongroup';
import {Button} from '@react-spectrum/button';

<ButtonGroup>
  <Button variant="primary">Rate Now</Button>
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
</ButtonGroup>
import {ButtonGroup} from '@react-spectrum/buttongroup';
import {Button} from '@react-spectrum/button';

<ButtonGroup>
  <Button variant="primary">
    Rate Now
  </Button>
  <Button variant="secondary">
    No, thanks
  </Button>
  <Button variant="secondary">
    Remind me later
  </Button>
</ButtonGroup>

Content#

ButtonGroup expects Buttons as children and is used to handle overflow. When horizontal space is limited, the ButtonGroup switches to a vertical layout. ButtonGroup should be used when there are two or more related Buttons in a group. To see the orientation switch in the example above, resize the width of your window.

Props#

NameTypeDefaultDescription
childrenReactNode—The Buttons contained within the ButtonGroup.
isDisabledboolean—Whether the Buttons in the ButtonGroup are all disabled.
orientationOrientation'horizontal'The axis the ButtonGroup should align with. Setting this to 'vertical' will prevent any switching behaviors between 'vertical' and 'horizontal'.
alignAlignment | 'center''start'The alignment of the buttons within the ButtonGroup.
Layout
NameTypeDefaultDescription
flexstring | number | boolean—When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumber—When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumber—When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumber | string—When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'—Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'—Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumber—The layout order for the element within a flex or grid container. See MDN.
gridAreastring—When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstring—When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstring—When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstring—When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstring—When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstring—When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstring—When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValue—The margin for all four sides of the element. See MDN.
marginTopDimensionValue—The margin for the top side of the element. See MDN.
marginBottomDimensionValue—The margin for the bottom side of the element. See MDN.
marginStartDimensionValue—The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValue—The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValue—The margin for both the left and right sides of the element. See MDN.
marginYDimensionValue—The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValue—The width of the element. See MDN.
minWidthDimensionValue—The minimum width of the element. See MDN.
maxWidthDimensionValue—The maximum width of the element. See MDN.
heightDimensionValue—The height of the element. See MDN.
minHeightDimensionValue—The minimum height of the element. See MDN.
maxHeightDimensionValue—The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'—Specifies how the element is positioned. See MDN.
topDimensionValue—The top position for the element. See MDN.
bottomDimensionValue—The bottom position for the element. See MDN.
leftDimensionValue—The left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValue—The right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValue—The logical start position for the element, depending on layout direction. See MDN.
endDimensionValue—The logical end position for the element, depending on layout direction. See MDN.
zIndexnumber—The stacking order for the element. See MDN.
isHiddenboolean—Hides the element.
Accessibility
NameTypeDefaultDescription
idstring—The element's unique identifier.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestring—Sets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSProperties—Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Orientation#

View guidelines

Setting this to 'vertical' will prevent any dynamic orientation changes, the ButtonGroup will remain in vertical regardless of the available width.

<ButtonGroup orientation="vertical">
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup orientation="vertical">
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup orientation="vertical">
  <Button variant="secondary">
    No, thanks
  </Button>
  <Button variant="secondary">
    Remind me later
  </Button>
  <Button variant="primary">
    Rate Now
  </Button>
</ButtonGroup>

Alignment#

View guidelines

Button groups are aligned contextually. Generally, button groups should be start-aligned to follow content. However, they should be end-aligned inside container components, such as in dialogs, popovers, or cards. Center alignment should be used in the context of an empty state. In right-to-left languages, alignment is flipped automatically.

<ButtonGroup orientation="vertical" align="end">
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup orientation="vertical" align="end">
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup
  orientation="vertical"
  align="end">
  <Button variant="secondary">
    No, thanks
  </Button>
  <Button variant="secondary">
    Remind me later
  </Button>
  <Button variant="primary">
    Rate Now
  </Button>
</ButtonGroup>
<ButtonGroup orientation="vertical" align="center">
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup orientation="vertical" align="center">
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup
  orientation="vertical"
  align="center">
  <Button variant="secondary">
    No, thanks
  </Button>
  <Button variant="secondary">
    Remind me later
  </Button>
  <Button variant="primary">
    Rate Now
  </Button>
</ButtonGroup>

Disabled#

View guidelines

<ButtonGroup isDisabled>
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup isDisabled>
  <Button variant="secondary">No, thanks</Button>
  <Button variant="secondary">Remind me later</Button>
  <Button variant="primary">Rate Now</Button>
</ButtonGroup>
<ButtonGroup
  isDisabled>
  <Button variant="secondary">
    No, thanks
  </Button>
  <Button variant="secondary">
    Remind me later
  </Button>
  <Button variant="primary">
    Rate Now
  </Button>
</ButtonGroup>