Button Group

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

Basic example

Wrap a series of buttons with Button component in ButtonGroup component.

vue
<template>
 <ButtonGroup aria-label="Basic example">
  <b-button color="primary">
   Left
  </b-button>
  <b-button color="primary">
   Middle
  </b-button>
  <b-button color="primary">
   Right
  </b-button>
 </ButtonGroup>
</template>
warning
Ensure correct role and provide a label

In order for assistive technologies (such as screen readers) to convey that a series of buttons is grouped, an appropriate role attribute needs to be provided. For button groups, this would be role="group", while toolbars should have a role="toolbar".

In addition, groups and toolbars should be given an explicit label, as most assistive technologies will otherwise not announce them, despite the presence of the correct role attribute. In the examples provided here, we use aria-label, but alternatives such as aria-labelledby can also be used.

These classes can also be added to groups of links, as an alternative to the nav navigation components .

vue
<template>
 <ButtonGroup aria-label="Basic example">
  <b-button
   color="primary"
   active
  >
   Active link
  </b-button>
  <b-button color="primary">
   Middle
  </b-button>
  <b-button color="primary">
   Right
  </b-button>
 </ButtonGroup>
</template>

Mixed styles

vue
<template>
 <ButtonGroup aria-label="Basic mixed styles example">
  <b-button color="danger">
   Left
  </b-button>
  <b-button color="warning">
   Middle
  </b-button>
  <b-button color="success">
   Right
  </b-button>
 </ButtonGroup>
</template>

Outlined styles

vue
<template>
 <ButtonGroup aria-label="Basic outlined example">
  <b-button color="outline-primary">
   Left
  </b-button>
  <b-button color="outline-primary">
   Middle
  </b-button>
  <b-button color="outline-primary">
   Right
  </b-button>
 </ButtonGroup>
</template>

Checkbox and radio button groups

Combine button-like checkbox and radio toggle buttons into a seamless looking button group.

vue
<template>
 <ButtonGroup aria-label="Basic checkbox toggle button group">
  <CheckboxToggleButton
   color="outline-primary"
   checked
  >
   Checkbox 1
  </CheckboxToggleButton>
  <CheckboxToggleButton color="outline-primary">
   Checkbox 2
  </CheckboxToggleButton>
  <CheckboxToggleButton color="outline-primary">
   Checkbox 3
  </CheckboxToggleButton>
 </ButtonGroup>
</template>
vue
<template>
 <ButtonGroup aria-label="Basic checkbox toggle button group">
  <RadioToggleButton
   name="btnradio"
   color="outline-primary"
   checked
  >
   Radio 1
  </RadioToggleButton>
  <RadioToggleButton
   name="btnradio"
   color="outline-primary"
  >
   Radio 1
  </RadioToggleButton>
  <RadioToggleButton
   name="btnradio"
   color="outline-primary"
  >
   Radio 1
  </RadioToggleButton>
 </ButtonGroup>
</template>

Button toolbar

Combine sets of button groups into button toolbars for more complex components. Use utility attributes as needed to space out groups, buttons, and more.

vue
<template>
 <ButtonToolbar aria-label="Toolbar with button groups">
  <ButtonGroup
   margin="e-2"
   aria-label="First group"
  >
   <b-button color="primary">
    1
   </b-button>
   <b-button color="primary">
    2
   </b-button>
   <b-button color="primary">
    3
   </b-button>
   <b-button color="primary">
    4
   </b-button>
  </ButtonGroup>
  <ButtonGroup
   margin="e-2"
   aria-label="Second group"
  >
   <b-button color="secondary">
    5
   </b-button>
   <b-button color="secondary">
    6
   </b-button>
   <b-button color="secondary">
    7
   </b-button>
  </ButtonGroup>
  <ButtonGroup aria-label="Third group">
   <b-button color="info">
    8
   </b-button>
  </ButtonGroup>
 </ButtonToolbar>
</template>

Feel free to mix input groups with button groups in your toolbars. Similar to the example above, you'll likely need some attributes though to space things properly.

vue
<template>
 <ButtonToolbar
  margin="b-3"
  aria-label="Toolbar with button groups"
 >
  <ButtonGroup
   margin="e-2"
   aria-label="First group"
  >
   <b-button color="primary">
    1
   </b-button>
   <b-button color="primary">
    2
   </b-button>
   <b-button color="primary">
    3
   </b-button>
   <b-button color="primary">
    4
   </b-button>
  </ButtonGroup>
  <BInputGroup>
   <BInputGroupText>@</BInputGroupText>
   <BFormInput
    type="text"
    placeholder="Input group example"
    aria-label="Input group example"
   />
  </BInputGroup>
 </ButtonToolbar>

 <ButtonToolbar
  justify-content="between"
  aria-label="Toolbar with button groups"
 >
  <ButtonGroup aria-label="First group">
   <b-button color="outline-secondary">
    1
   </b-button>
   <b-button color="outline-secondary">
    2
   </b-button>
   <b-button color="outline-secondary">
    3
   </b-button>
   <b-button color="outline-secondary">
    4
   </b-button>
  </ButtonGroup>
  <BInputGroup>
   <BInputGroupText>@</BInputGroupText>
   <BFormInput
    type="text"
    placeholder="Input group example"
    aria-label="Input group example"
   />
  </BInputGroup>
 </ButtonToolbar>
</template>

Sizing

Instead of applying button sizing classes to every button in a group, just add .btn-group-* to each .btn-group, including each one when nesting multiple groups.



vue
<template>
 <ButtonGroup
  size="lg"
  aria-label="Large button group"
 >
  <b-button color="outline-dark">
   Left
  </b-button>
  <b-button color="outline-dark">
   Middle
  </b-button>
  <b-button color="outline-dark">
   Right
  </b-button>
 </ButtonGroup>
 <br />
 <ButtonGroup
  class="btn-group"
  aria-label="Default button group"
 >
  <b-button color="outline-dark">
   Left
  </b-button>
  <b-button color="outline-dark">
   Middle
  </b-button>
  <b-button color="outline-dark">
   Right
  </b-button>
 </ButtonGroup>
 <br />
 <ButtonGroup
  size="sm"
  aria-label="Small button group"
 >
  <b-button color="outline-dark">
   Left
  </b-button>
  <b-button color="outline-dark">
   Middle
  </b-button>
  <b-button color="outline-dark">
   Right
  </b-button>
 </ButtonGroup>
</template>

Nesting

vue
<template>
 <ButtonGroup aria-label="Button group with nested dropdown">
  <b-button class="btn btn-secondary">
   1
  </b-button>
  <b-button class="btn btn-secondary">
   2
  </b-button>

  <ButtonGroup>
   <DropdownToggle
    id="btnGroupDrop1"
    color="secondary"
   >
    Dropdown
   </DropdownToggle>
   <ul
    class="dropdown-menu"
    aria-labelledby="btnGroupDrop1"
   >
    <li>
     <Anchor
      class="dropdown-item"
      to="/"
     >
      Dropdown link
     </Anchor>
    </li>
    <li>
     <Anchor
      class="dropdown-item"
      to="/"
     >
      Dropdown link
     </Anchor>
    </li>
   </ul>
  </ButtonGroup>
 </ButtonGroup>
</template>

Vertical variation

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

vue
<template>
 <ButtonGroup vertical>
  <b-button color="dark">
   Button
  </b-button>
  <b-button color="dark">
   Button
  </b-button>
  <b-button color="dark">
   Button
  </b-button>
  <b-button color="dark">
   Button
  </b-button>
  <b-button color="dark">
   Button
  </b-button>
  <b-button color="dark">
   Button
  </b-button>
 </ButtonGroup>

 <ButtonGroup vertical>
  <b-button color="primary">
   Button
  </b-button>
  <b-button color="primary">
   Button
  </b-button>
  <ButtonGroup>
   <DropdownToggle color="primary">
    Dropdown
   </DropdownToggle>
   <DropdownMenu>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
   </DropdownMenu>
  </ButtonGroup>
  <b-button color="primary">
   Button
  </b-button>
  <b-button color="primary">
   Button
  </b-button>
  <ButtonGroup>
   <DropdownToggle color="primary">
    Dropdown
   </DropdownToggle>
   <DropdownMenu>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
   </DropdownMenu>
  </ButtonGroup>
  <ButtonGroup>
   <DropdownToggle color="primary">
    Dropdown
   </DropdownToggle>
   <DropdownMenu>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
   </DropdownMenu>
  </ButtonGroup>
  <ButtonGroup>
   <DropdownToggle color="primary">
    Dropdown
   </DropdownToggle>
   <DropdownMenu>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
    <DropdownItem to="/">
     Dropdown link
    </DropdownItem>
   </DropdownMenu>
  </ButtonGroup>
 </ButtonGroup>

 <ButtonGroup
  vertical
  aria-label="Basic checkbox toggle button group"
 >
  <RadioToggleButton
   name="btnradio"
   color="outline-danger"
   checked
  >
   Radio 1
  </RadioToggleButton>
  <RadioToggleButton
   name="btnradio"
   color="outline-danger"
  >
   Radio 1
  </RadioToggleButton>
  <RadioToggleButton
   name="btnradio"
   color="outline-danger"
  >
   Radio 1
  </RadioToggleButton>
 </ButtonGroup>
</template>