List group

List groups are a flexible and powerful component for displaying a series of content. List group items can be modified to support just about any content within. They can also be used as navigation via various props.

<b-list-group>
  <b-list-group-item>Cras justo odio</b-list-group-item>
  <b-list-group-item>Dapibus ac facilisis in</b-list-group-item>
  <b-list-group-item>Morbi leo risus</b-list-group-item>
  <b-list-group-item>Porta ac consectetur ac</b-list-group-item>
  <b-list-group-item>Vestibulum at eros</b-list-group-item>
</b-list-group>

<!-- list-group.vue -->

Active items

Set the active prop on a <b-list-group-item> to indicate the current active selection.

<b-list-group>
  <b-list-group-item>Cras justo odio</b-list-group-item>
  <b-list-group-item active>Dapibus ac facilisis in</b-list-group-item>
  <b-list-group-item>Morbi leo risus</b-list-group-item>
  <b-list-group-item>Porta ac consectetur ac</b-list-group-item>
  <b-list-group-item>Vestibulum at eros</b-list-group-item>
</b-list-group>

<!-- list-group-active.vue -->

Disabled items

Set the disabled prop on a <b-list-group-item> to make it appear disabled (also works with actionalable items. see below).

<b-list-group>
  <b-list-group-item disabled>Cras justo odio</b-list-group-item>
  <b-list-group-item>Dapibus ac facilisis in</b-list-group-item>
  <b-list-group-item>Morbi leo risus</b-list-group-item>
  <b-list-group-item disabled>Porta ac consectetur ac</b-list-group-item>
  <b-list-group-item>Vestibulum at eros</b-list-group-item>
</b-list-group>

<!-- list-group-disabled.vue -->

Actionable list group items

Turn a <b-list-group-item> into an actionable link by specifying either an href prop or router-link to prop.

<b-list-group>
  <b-list-group-item href="#some-link">Awesome link</b-list-group-item>
  <b-list-group-item href="#" active>Link with active state</b-list-group-item>
  <b-list-group-item href="#">Action links are easy</b-list-group-item>
  <b-list-group-item href="#foobar" disabled>Disabled link</b-list-group-item>
</b-list-group>

<!-- list-group-link.vue -->

Or if you prefer <buttons> over links, set the button prop to true.

<b-list-group>
  <b-list-group-item button>Button item</b-list-group-item>
  <b-list-group-item button>I am a button</b-list-group-item>
  <b-list-group-item button disabled>Disabled button</b-list-group-item>
  <b-list-group-item button>This is a button too</b-list-group-item>
</b-list-group>

<!-- list-group-button.vue -->

Notes:

  • When the prop button is true, all link related props (other than active) and the tag prop will have no effect.
  • When href or to are set, the tag prop has no effect.

Contextual variants

Use contextual variants to style list items with a stateful background and color, via the variant prop.

<b-list-group>
  <b-list-group-item>This is a default list group item</b-list-group-item>
  <b-list-group-item variant="primary">This is a primary list group item</b-list-group-item>
  <b-list-group-item variant="secondary">This is a secondary list group item</b-list-group-item>
  <b-list-group-item variant="success">This is a success list group item</b-list-group-item>
  <b-list-group-item variant="danger">This is a danger list group item</b-list-group-item>
  <b-list-group-item variant="warning">This is a warning list group item</b-list-group-item>
  <b-list-group-item variant="info">This is a info list group item</b-list-group-item>
  <b-list-group-item variant="light">This is a light list group item</b-list-group-item>
  <b-list-group-item variant="dark">This is a dark list group item</b-list-group-item>
</b-list-group>

<!-- list-group-variant.vue -->

Contextual variants also work with action items. Note the addition of the hover styling here not present in the previous example. Also supported is the active state; set it to indicate an active selection on a contextual list group item.

<b-list-group>
  <b-list-group-item href="#">This is a default list group item</b-list-group-item>
  <b-list-group-item href="#" variant="primary">This is a primary list group item</b-list-group-item>
  <b-list-group-item href="#" variant="secondary">This is a secondary list group item</b-list-group-item>
  <b-list-group-item href="#" variant="success">This is a success list group item</b-list-group-item>
  <b-list-group-item href="#" variant="danger">This is a danger list group item</b-list-group-item>
  <b-list-group-item href="#" variant="warning">This is a warning list group item</b-list-group-item>
  <b-list-group-item href="#" variant="info">This is a info list group item</b-list-group-item>
  <b-list-group-item href="#" variant="light">This is a light list group item</b-list-group-item>
  <b-list-group-item href="#" variant="dark">This is a dark list group item</b-list-group-item>
</b-list-group>

<!-- list-group-variant-action.vue -->

Conveying meaning to assistive technologies

Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden using the .sr-only class.

With badges

Add badges to any list group item to show unread counts, activity, and more with the help of some utility classes.

<b-list-group>
  <b-list-group-item class="d-flex justify-content-between align-items-center">
    Cras justo odio
    <b-badge variant="primary" pill>14</b-badge>
  </b-list-group-item>
  <b-list-group-item class="d-flex justify-content-between align-items-center">
    Dapibus ac facilisis in
    <b-badge variant="primary" pill>2</b-badge>
  </b-list-group-item>
  <b-list-group-item class="d-flex justify-content-between align-items-center">
    Morbi leo risus
    <b-badge variant="primary" pill>1</b-badge>
  </b-list-group-item>
</b-list-group>

<!-- list-group-badges.vue -->

List groups inside cards

Incorporate list groups into cards. Use the <b-list-group> prop flush prop when using cards with no-body to make the sides of the list group flush with the card.

<b-card-group deck>
  <b-card header="<b>Card with list group</b>">
    <b-list-group>
      <b-list-group-item href="#">Cras justo odio</b-list-group-item>
      <b-list-group-item href="#">Dapibus ac facilisis in</b-list-group-item>
      <b-list-group-item href="#">Vestibulum at eros</b-list-group-item>
    </b-list-group>
    <p class="card-text mt-2">
      Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex
      nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua
      consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris
      ad sit ipsum anim Lorem.
    </p>
  </b-card>
  <b-card no-body header="<b>Card with flush list group</b>">
    <b-list-group flush>
      <b-list-group-item href="#">Cras justo odio</b-list-group-item>
      <b-list-group-item href="#">Dapibus ac facilisis in</b-list-group-item>
      <b-list-group-item href="#">Vestibulum at eros</b-list-group-item>
    </b-list-group>
    <b-card-body>
      Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex
      nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua
      consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris
      ad sit ipsum anim Lorem.
    </b-card-body>
  </b-card>
</b-card-group>


<!-- list-group-card.vue -->

Custom content

Add nearly any HTML or component within, even for linked list groups like the one below, with the help of flexbox utility classes.

<b-list-group>
  <b-list-group-item href="#" active class="flex-column align-items-start">
    <div class="d-flex w-100 justify-content-between">
      <h5 class="mb-1">List group item heading</h5>
      <small>3 days ago</small>
    </div>
    <p class="mb-1">
      Donec id elit non mi porta gravida at eget metus. Maecenas
      sed diam eget risus varius blandit.
    </p>
    <small>Donec id elit non mi porta.</small>
  </b-list-group-item>
  <b-list-group-item href="#" class="flex-column align-items-start">
    <div class="d-flex w-100 justify-content-between">
      <h5 class="mb-1">List group item heading</h5>
      <small class="text-muted">3 days ago</small>
    </div>
    <p class="mb-1">
      Donec id elit non mi porta gravida at eget metus. Maecenas
      sed diam eget risus varius blandit.
    </p>
    <small class="text-muted">Donec id elit non mi porta.</small>
  </b-list-group-item>
  <b-list-group-item href="#" disabled class="flex-column align-items-start">
    <div class="d-flex w-100 justify-content-between">
      <h5 class="mb-1">Disabled List group item</h5>
      <small class="text-muted">3 days ago</small>
    </div>
    <p class="mb-1">
      Donec id elit non mi porta gravida at eget metus. Maecenas
      sed diam eget risus varius blandit.
    </p>
    <small class="text-muted">Donec id elit non mi porta.</small>
  </b-list-group-item>
</b-list-group>

<!-- list-group-content.vue -->

Component Reference

<b-list-group>

Properties

PropertyTypeDefault Value
tagStringdiv
flushBooleanfalse
Trying to get native browser events working on your component? Use the .native modifier to capture browser native events such as: @click.native="...", @mouseover.native="...", etc. See the the official Vue.js documentation for more information.

<b-list-group-item>

Properties

PropertyTypeDefault Value
tagStringdiv
actionBoolean
buttonBoolean
variantString
hrefString
relString
targetString_self
activeBooleanfalse
active-classStringactive
appendBooleanfalse
disabledBooleanfalse
eventString or Arrayclick
exactBooleanfalse
exact-active-classStringactive
replaceBooleanfalse
router-tagStringa
toString or Object

Importing Individual Components

ComponentImport Path
<b-list-group>bootstrap-vue/es/components/list-group/list-group
<b-list-group-item>bootstrap-vue/es/components/list-group/list-group-item

Example:

import bListGroup from 'bootstrap-vue/es/components/list-group/list-group';
Vue.component('b-list-group', bListGroup);

Importing List Group as a Vue plugin

This plugin includes all of the above listed individual components. Plugins also include any component aliases.

import { ListGroup } from 'bootstrap-vue/es/components';
Vue.use(ListGroup);