Loading...
Skip to main content

Button group

Group a series of buttons together on a single line or stack them in a vertical column.

Use ButtonGroup with vertical, divider, and size props for the variations below, and ButtonToolbar to combine groups. Both wrappers supply their default grouping role; provide an accessible label for each group or toolbar.

Examples

Wrap a series of buttons in ButtonGroup.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Basic example"
role="group"
>
<Button
theme="primary"
variant="solid"
>
Left
</Button>
<Button
theme="primary"
variant="solid"
>
Middle
</Button>
<Button
theme="primary"
variant="solid"
>
Right
</Button>
</ButtonGroup>
</div>

Button groups require an appropriate role attribute and explicit label to ensure assistive technologies like screen readers identify buttons as grouped and announce them. Use role="group" for button groups or role="toolbar" for button toolbars. Then use aria-label or aria-labelledby to label them.

With links

ButtonGroup can also group links; use the navigation components for navigation-specific behavior.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup aria-label="Related links">
<Button
active
aria-current="page"
href="#"
theme="primary"
variant="solid"
>
Active link
</Button>
<Button
href="#"
theme="primary"
variant="solid"
>
Link
</Button>
<Button
href="#"
theme="primary"
variant="solid"
>
Link
</Button>
</ButtonGroup>
</div>

Dividers

Set the divider prop on ButtonGroup to add dividers between buttons. This is most useful with buttons that share a theme color and solid fill.

<div className="d-flex gap-2">
<ButtonGroup
aria-label="Basic example"
divider
role="group"
>
<Button
theme="primary"
variant="solid"
>
Left
</Button>
<Button
active
theme="primary"
variant="solid"
>
Active
</Button>
<Button
theme="primary"
variant="solid"
>
Right
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Basic example"
divider
role="group"
>
<Button
theme="secondary"
variant="solid"
>
Left
</Button>
<Button
theme="secondary"
variant="solid"
>
Right
</Button>
</ButtonGroup>
</div>

Works with vertical button groups, too.

<div className="d-flex align-items-start gap-2">
<ButtonGroup
aria-label="Basic example"
divider
role="group"
vertical
>
<Button
theme="primary"
variant="solid"
>
Left
</Button>
<Button
active
theme="primary"
variant="solid"
>
Active
</Button>
<Button
theme="primary"
variant="solid"
>
Right
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Basic example"
divider
role="group"
vertical
>
<Button
theme="secondary"
variant="solid"
>
Left
</Button>
<Button
theme="secondary"
variant="solid"
>
Right
</Button>
</ButtonGroup>
</div>

Theme variants

Set the theme prop on each Button in the group to apply a consistent theme color.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Accent theme example"
role="group"
>
<Button
theme="accent"
variant="solid"
>
Left
</Button>
<Button
theme="accent"
variant="solid"
>
Middle
</Button>
<Button
theme="accent"
variant="solid"
>
Right
</Button>
</ButtonGroup>
</div>

You can mix and match button variants in a button group.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Basic mixed styles example"
role="group"
>
<Button
theme="danger"
variant="solid"
>
Left
</Button>
<Button
theme="warning"
variant="solid"
>
Middle
</Button>
<Button
theme="success"
variant="solid"
>
Right
</Button>
</ButtonGroup>
</div>

Style variants

All button styles are supported in button groups. Set divider on ButtonGroup to add dividers between some styles, or use the button borders with other styles.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Solid example"
divider
role="group"
>
<Button
theme="primary"
variant="solid"
>
Left
</Button>
<Button
theme="primary"
variant="solid"
>
Middle
</Button>
<Button
theme="primary"
variant="solid"
>
Right
</Button>
</ButtonGroup>
</div>
<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Outlined example"
role="group"
>
<Button
theme="primary"
variant="outline"
>
Left
</Button>
<Button
theme="primary"
variant="outline"
>
Middle
</Button>
<Button
theme="primary"
variant="outline"
>
Right
</Button>
</ButtonGroup>
</div>
<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Subtle example"
divider
role="group"
>
<Button
theme="primary"
variant="subtle"
>
Left
</Button>
<Button
theme="primary"
variant="subtle"
>
Middle
</Button>
<Button
theme="primary"
variant="subtle"
>
Right
</Button>
</ButtonGroup>
</div>

Toggle buttons

Checkbox

Checkbox toggle buttons can be grouped together. Any or all of the buttons can be checked.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Basic checkbox toggle button group"
role="group"
>
<ToggleButton
theme="primary"
type="checkbox"
variant="outline"
>
Check 1
</ToggleButton>
<ToggleButton
theme="primary"
type="checkbox"
variant="outline"
>
Check 2
</ToggleButton>
<ToggleButton
theme="primary"
type="checkbox"
variant="outline"
>
Check 3
</ToggleButton>
</ButtonGroup>
</div>

Radio

By design, radio toggle button groups can only have one button checked at a time.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Basic radio toggle button group"
role="group"
>
<ToggleButton
defaultChecked
name="btnradio"
theme="primary"
type="radio"
variant="outline"
>
Radio 1
</ToggleButton>
<ToggleButton
name="btnradio"
theme="primary"
type="radio"
variant="outline"
>
Radio 2
</ToggleButton>
<ToggleButton
name="btnradio"
theme="primary"
type="radio"
variant="outline"
>
Radio 3
</ToggleButton>
</ButtonGroup>
</div>

Button toolbar

Combine ButtonGroup components inside ButtonToolbar for more complex layouts. Pass spacing utilities through the className of the toolbar or its children.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonToolbar
aria-label="Toolbar with button groups"
role="toolbar"
>
<ButtonGroup
aria-label="First group"
role="group"
>
<Button
theme="primary"
variant="solid"
>
1
</Button>
<Button
theme="primary"
variant="solid"
>
2
</Button>
<Button
theme="primary"
variant="solid"
>
3
</Button>
<Button
theme="primary"
variant="solid"
>
4
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Second group"
role="group"
>
<Button
theme="secondary"
variant="solid"
>
5
</Button>
<Button
theme="secondary"
variant="solid"
>
6
</Button>
<Button
theme="secondary"
variant="solid"
>
7
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Third group"
role="group"
>
<Button
theme="info"
variant="solid"
>
8
</Button>
</ButtonGroup>
</ButtonToolbar>
</div>

Feel free to mix input groups with button groups in your toolbars. As in the example above, you may need spacing utilities through className to lay them out.

<div className="d-flex gap-3 flex-column">
<ButtonToolbar
aria-label="Toolbar with button groups"
role="toolbar"
>
<ButtonGroup
aria-label="First group"
role="group"
>
<Button
theme="secondary"
variant="outline"
>
1
</Button>
<Button
theme="secondary"
variant="outline"
>
2
</Button>
<Button
theme="secondary"
variant="outline"
>
3
</Button>
<Button
theme="secondary"
variant="outline"
>
4
</Button>
</ButtonGroup>
<InputGroup>
<InputGroupText id="btnGroupAddon">
@
</InputGroupText>
<FormControl
aria-describedby="btnGroupAddon"
aria-label="Input group example"
placeholder="Input group example"
type="text"
/>
</InputGroup>
</ButtonToolbar>
<ButtonToolbar
aria-label="Toolbar with button groups"
className="justify-content-between"
role="toolbar"
>
<ButtonGroup
aria-label="First group"
role="group"
>
<Button
theme="secondary"
variant="outline"
>
1
</Button>
<Button
theme="secondary"
variant="outline"
>
2
</Button>
<Button
theme="secondary"
variant="outline"
>
3
</Button>
<Button
theme="secondary"
variant="outline"
>
4
</Button>
</ButtonGroup>
<InputGroup>
<InputGroupText id="btnGroupAddon2">
@
</InputGroupText>
<FormControl
aria-describedby="btnGroupAddon2"
aria-label="Input group example"
placeholder="Input group example"
type="text"
/>
</InputGroup>
</ButtonToolbar>
</div>

Sizing

Set the size prop on ButtonGroup to resize its buttons together. Set it on each group independently when nesting multiple groups.

<div className="d-flex gap-3 flex-column align-items-start">
<ButtonGroup
aria-label="Large button group"
role="group"
size="lg"
>
<Button
theme="primary"
variant="outline"
>
Left
</Button>
<Button
theme="primary"
variant="outline"
>
Middle
</Button>
<Button
theme="primary"
variant="outline"
>
Right
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Default button group"
role="group"
>
<Button
theme="primary"
variant="outline"
>
Left
</Button>
<Button
theme="primary"
variant="outline"
>
Middle
</Button>
<Button
theme="primary"
variant="outline"
>
Right
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Small button group"
role="group"
size="sm"
>
<Button
theme="primary"
variant="outline"
>
Left
</Button>
<Button
theme="primary"
variant="outline"
>
Middle
</Button>
<Button
theme="primary"
variant="outline"
>
Right
</Button>
</ButtonGroup>
<ButtonGroup
aria-label="Extra small button group"
role="group"
size="xs"
>
<Button
theme="primary"
variant="outline"
>
Left
</Button>
<Button
theme="primary"
variant="outline"
>
Middle
</Button>
<Button
theme="primary"
variant="outline"
>
Right
</Button>
</ButtonGroup>
</div>

Nesting

Place a ButtonGroup inside another ButtonGroup when you want menus mixed with a series of buttons.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Button group with nested menu"
role="group"
>
<Button
theme="primary"
variant="solid"
>
1
</Button>
<Button
theme="primary"
variant="solid"
>
2
</Button>
<Menu
label="Menu"
toggleProps={{
theme: 'primary',
variant: 'solid'
}}
>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
</Menu>
</ButtonGroup>
</div>

Vertical variation

Make a set of buttons appear vertically stacked rather than horizontally. Split button menus are not supported here.

<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Vertical button group"
role="group"
vertical
>
<Button
theme="primary"
variant="solid"
>
Button
</Button>
<Button
theme="primary"
variant="solid"
>
Button
</Button>
<Button
theme="primary"
variant="solid"
>
Button
</Button>
<Button
theme="primary"
variant="solid"
>
Button
</Button>
</ButtonGroup>
</div>
<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Vertical button group"
role="group"
vertical
>
<Menu
label="Menu"
toggleProps={{
theme: 'primary',
variant: 'solid'
}}
>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
</Menu>
<Button
theme="primary"
variant="solid"
>
Button
</Button>
<Button
theme="primary"
variant="solid"
>
Button
</Button>
<Menu
label="Menu"
placement="left-start"
toggleProps={{
theme: 'primary',
variant: 'solid'
}}
>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
</Menu>
<Menu
label="Menu"
placement="right-start"
toggleProps={{
theme: 'primary',
variant: 'solid'
}}
>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
</Menu>
<Menu
label="Menu"
placement="top-start"
toggleProps={{
theme: 'primary',
variant: 'solid'
}}
>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
<MenuItem
href="#"
variant={false}
>
Menu link
</MenuItem>
</Menu>
</ButtonGroup>
</div>
<div className="d-flex flex-wrap gap-2 align-items-center">
<ButtonGroup
aria-label="Vertical radio toggle button group"
role="group"
vertical
>
<ToggleButton
defaultChecked
name="vbtn-radio"
theme="danger"
type="radio"
variant="outline"
>
Radio 1
</ToggleButton>
<ToggleButton
name="vbtn-radio"
theme="danger"
type="radio"
variant="outline"
>
Radio 2
</ToggleButton>
<ToggleButton
name="vbtn-radio"
theme="danger"
type="radio"
variant="outline"
>
Radio 3
</ToggleButton>
</ButtonGroup>
</div>
Documentation navigation
On this page
On this page