Button group

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

On this page

Basic example

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

vue

<template>
  <ButtonGroup aria-label="Basic example">
    <b-button button="primary">
      Left
    </b-button>
    <b-button button="primary">
      Middle
    </b-button>
    <b-button button="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
      button="primary"
      active
    >
      Active link
    </b-button>
    <b-button button="primary">
      Middle
    </b-button>
    <b-button button="primary">
      Right
    </b-button>
  </ButtonGroup>
</template>

Mixed styles

vue

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

Outlined styles

vue

<template>
  <ButtonGroup aria-label="Basic outlined example">
    <b-button button="outline-primary">
      Left
    </b-button>
    <b-button button="outline-primary">
      Middle
    </b-button>
    <b-button button="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.

Checkbox 1 Checkbox 2 Checkbox 3

vue

<template>
  <ButtonGroup aria-label="Basic checkbox toggle button group">
    <CheckboxToggleButton
      button="outline-primary"
      checked
    >
      Checkbox 1
    </CheckboxToggleButton>
    <CheckboxToggleButton button="outline-primary">
      Checkbox 2
    </CheckboxToggleButton>
    <CheckboxToggleButton button="outline-primary">
      Checkbox 3
    </CheckboxToggleButton>
  </ButtonGroup>
</template>

Radio 1 Radio 1 Radio 1

vue

<template>
  <ButtonGroup aria-label="Basic checkbox toggle button group">
    <RadioToggleButton
      name="btnradio"
      button="outline-primary"
      checked
    >
      Radio 1
    </RadioToggleButton>
    <RadioToggleButton
      name="btnradio"
      button="outline-primary"
    >
      Radio 1
    </RadioToggleButton>
    <RadioToggleButton
      name="btnradio"
      button="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 button="primary">
        1
      </b-button>
      <b-button button="primary">
        2
      </b-button>
      <b-button button="primary">
        3
      </b-button>
      <b-button button="primary">
        4
      </b-button>
    </ButtonGroup>
    <ButtonGroup
      margin="e-2"
      aria-label="Second group"
    >
      <b-button button="secondary">
        5
      </b-button>
      <b-button button="secondary">
        6
      </b-button>
      <b-button button="secondary">
        7
      </b-button>
    </ButtonGroup>
    <ButtonGroup aria-label="Third group">
      <b-button button="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 button="primary">
        1
      </b-button>
      <b-button button="primary">
        2
      </b-button>
      <b-button button="primary">
        3
      </b-button>
      <b-button button="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 button="outline-secondary">
        1
      </b-button>
      <b-button button="outline-secondary">
        2
      </b-button>
      <b-button button="outline-secondary">
        3
      </b-button>
      <b-button button="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 button="outline-dark">
      Left
    </b-button>
    <b-button button="outline-dark">
      Middle
    </b-button>
    <b-button button="outline-dark">
      Right
    </b-button>
  </ButtonGroup>
  <br>
  <ButtonGroup
    class="btn-group"
    aria-label="Default button group"
  >
    <b-button button="outline-dark">
      Left
    </b-button>
    <b-button button="outline-dark">
      Middle
    </b-button>
    <b-button button="outline-dark">
      Right
    </b-button>
  </ButtonGroup>
  <br>
  <ButtonGroup
    size="sm"
    aria-label="Small button group"
  >
    <b-button button="outline-dark">
      Left
    </b-button>
    <b-button button="outline-dark">
      Middle
    </b-button>
    <b-button button="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"
        button="secondary"
      >
        Dropdown
      </DropdownToggle>
      <ul
        class="dropdown-menu"
        aria-labelledby="btnGroupDrop1"
      >
        <li>
          <b-a
            class="dropdown-item"
            href="#"
          >
            Dropdown link
          </b-a>
        </li>
        <li>
          <b-a
            class="dropdown-item"
            href="#"
          >
            Dropdown link
          </b-a>
        </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.