--- layout: docs title: List group description: List groups are a flexible and powerful component for displaying a series of content. Modify and extend them to support just about any content within. group: components toc: true --- ## Basic example The most basic list group is an unordered list with list items and the proper classes. Build upon it with the options that follow, or with your own CSS as needed. {{< example >}}

An item
A second item
A third item
A fourth item
And a fifth one

{{< /example >}} ## Active items Add `.active` to a `.list-group-item` to indicate the current active selection. {{< example >}}

An active item
A second item
A third item
A fourth item
And a fifth one

{{< /example >}} ## Disabled items Add `.disabled` to a `.list-group-item` to make it _appear_ disabled. Note that some elements with `.disabled` will also require custom JavaScript to fully disable their click events (e.g., links). {{< example >}}

A disabled item
A second item
A third item
A fourth item
And a fifth one

{{< /example >}} ## Links and buttons Use ``s or ` {{< /example >}} ## Flush Add `.list-group-flush` to remove some borders and rounded corners to render list group items edge-to-edge in a parent container (e.g., cards). {{< example >}}

An item
A second item
A third item
A fourth item
And a fifth one

{{< /example >}} ## Numbered Add the `.list-group-numbered` modifier class (and optionally use an `

` element) to opt into numbered list group items. Numbers are generated via CSS (as opposed to a `

`s default browser styling) for better placement inside list group items and to allow for better customization. Numbers are generated by `counter-reset` on the `

`, and then styled and placed with a `::before` pseudo-element on the `

` with `counter-increment` and `content`. {{< example >}}
1. A list item
2. A list item
3. A list item
{{< /example >}} These work great with custom content as well. {{< example >}}
1. Subheading
  Content for list item
  14
2. Subheading
  Content for list item
  14
3. Subheading
  Content for list item
  14
{{< /example >}} ## Horizontal Add `.list-group-horizontal` to change the layout of list group items from vertical to horizontal across all breakpoints. Alternatively, choose a responsive variant `.list-group-horizontal-{sm|md|lg|xl|xxl}` to make a list group horizontal starting at that breakpoint's `min-width`. Currently **horizontal list groups cannot be combined with flush list groups.** **ProTip:** Want equal-width list group items when horizontal? Add `.flex-fill` to each list group item. {{< example >}} {{< list-group.inline >}} {{- range $.Site.Data.breakpoints }}
- An item
- A second item
- A third item
{{- end -}} {{< /list-group.inline >}} {{< /example >}} ## Contextual classes Use contextual classes to style list items with a stateful background and color. {{< example >}}
- A simple default list group item
- A simple {{ .name }} list group item
{{< /example >}} Contextual classes also work with `.list-group-item-action`. Note the addition of the hover styles here not present in the previous example. Also supported is the `.active` state; apply it to indicate an active selection on a contextual list group item. {{< example >}}
A simple default list group item {{< list.inline >}} {{- range (index $.Site.Data "theme-colors") }} A simple {{ .name }} list group item {{- end -}} {{< /list.inline >}}
{{< /example >}} {{< callout info >}} {{< partial "callout-warning-color-assistive-technologies.md" >}} {{< /callout >}} ## With badges Add badges to any list group item to show unread counts, activity, and more with the help of some [utilities]({{< docsref "/utilities/flex" >}}). {{< example >}}
- A list item 14
- A second list item 2
- A third list item 1
{{< /example >}} ## Custom content Add nearly any HTML within, even for linked list groups like the one below, with the help of [flexbox utilities]({{< docsref "/utilities/flex" >}}). {{< example >}}

List group item heading
3 days ago

Some placeholder content in a paragraph.
And some small print.

List group item heading
3 days ago

Some placeholder content in a paragraph.
And some muted small print.

List group item heading
3 days ago

Some placeholder content in a paragraph.
And some muted small print.
{{< /example >}} ## Checkboxes and radios Place Bootstrap's checkboxes and radios within list group items and customize as needed. You can use them without `
`s, but please remember to include an `aria-label` attribute and value for accessibility. {{< example >}}
- First checkbox
- Second checkbox
- Third checkbox
- Fourth checkbox
- Fifth checkbox
{{< /example >}} And if you want ``s as the `.list-group-item` for large hit areas, you can do that, too. {{< example >}}
First checkbox Second checkbox Third checkbox Fourth checkbox Fifth checkbox
{{< /example >}} ## Sass ### Variables {{< scss-docs name="list-group-variables" file="scss/_variables.scss" >}} ### Mixins Used in combination with `$theme-colors` to generate the [contextual variant classes](#contextual-classes) for `.list-group-item`s. {{< scss-docs name="list-group-mixin" file="scss/mixins/_list-group.scss" >}} ### Loop Loop that generates the modifier classes with the `list-group-item-variant()` mixin. {{< scss-docs name="list-group-modifiers" file="scss/_list-group.scss" >}} ## JavaScript behavior Use the tab JavaScript plugin—include it individually or through the compiled `bootstrap.js` file—to extend our list group to create tabbable panes of local content.

Home Profile Messages Settings

Some placeholder content in a paragraph relating to "Home". And some more content, used here just to pad out and fill this tab panel. In production, you would obviously have more real content here. And not just text. It could be anything, really. Text, images, forms.

Some placeholder content in a paragraph relating to "Profile". And some more content, used here just to pad out and fill this tab panel. In production, you would obviously have more real content here. And not just text. It could be anything, really. Text, images, forms.

Some placeholder content in a paragraph relating to "Messages". And some more content, used here just to pad out and fill this tab panel. In production, you would obviously have more real content here. And not just text. It could be anything, really. Text, images, forms.

Some placeholder content in a paragraph relating to "Settings". And some more content, used here just to pad out and fill this tab panel. In production, you would obviously have more real content here. And not just text. It could be anything, really. Text, images, forms.

```html

Home Profile Messages Settings

...

...

...

...

``` ### Using data attributes You can activate a list group navigation without writing any JavaScript by simply specifying `data-bs-toggle="list"` or on an element. Use these data attributes on `.list-group-item`. ```html

Home Profile Messages Settings

...

...

...

...

``` ### Via JavaScript Enable tabbable list item via JavaScript (each list item needs to be activated individually): ```js var triggerTabList = Array.prototype.slice.call(document.querySelectorAll('#myTab a')) triggerTabList.forEach(function (triggerEl) { var tabTrigger = new bootstrap.Tab(triggerEl) triggerEl.addEventListener('click', function (event) { event.preventDefault() tabTrigger.show() }) }) ``` You can activate individual list item in several ways: ```js var triggerEl = document.querySelector('#myTab a[href="#profile"]') bootstrap.Tab.getInstance(triggerEl).show() // Select tab by name var triggerFirstTabEl = document.querySelector('#myTab li:first-child a') bootstrap.Tab.getInstance(triggerFirstTabEl).show() // Select first tab ``` ### Fade effect To make tabs panel fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.show` to make the initial content visible. ```html

...

...

...

...

``` ### Methods #### constructor Activates a list item element and content container. Tab should have either a `data-bs-target` or an `href` targeting a container node in the DOM. ```html
Home Profile Messages Settings

...

...

...

...

``` #### show Selects the given list item and shows its associated pane. Any other list item that was previously selected becomes unselected and its associated pane is hidden. **Returns to the caller before the tab pane has actually been shown** (for example, before the `shown.bs.tab` event occurs). ```js var someListItemEl = document.querySelector('#someListItem') var tab = new bootstrap.Tab(someListItemEl) tab.show() ``` #### dispose Destroys an element's tab. #### getInstance *Static* method which allows you to get the tab instance associated with a DOM element ```js var triggerEl = document.querySelector('#trigger') var tab = bootstrap.Tab.getInstance(triggerEl) // Returns a Bootstrap tab instance ``` #### getOrCreateInstance *Static* method which allows you to get the tab instance associated with a DOM element, or create a new one in case it wasn't initialized ```js var triggerEl = document.querySelector('#trigger') var tab = bootstrap.Tab.getOrCreateInstance(triggerEl) // Returns a Bootstrap tab instance ``` ### Events When showing a new tab, the events fire in the following order: 1. `hide.bs.tab` (on the current active tab) 2. `show.bs.tab` (on the to-be-shown tab) 3. `hidden.bs.tab` (on the previous active tab, the same one as for the `hide.bs.tab` event) 4. `shown.bs.tab` (on the newly-active just-shown tab, the same one as for the `show.bs.tab` event) If no tab was already active, the `hide.bs.tab` and `hidden.bs.tab` events will not be fired.

Event type Description

show.bs.tab This event fires on tab show, but before the new tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.

shown.bs.tab This event fires on tab show after a tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.

hide.bs.tab This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively.

hidden.bs.tab This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively.

```js var tabElms = document.querySelectorAll('a[data-bs-toggle="list"]') tabElms.forEach(function(tabElm) { tabElm.addEventListener('shown.bs.tab', function (event) { event.target // newly activated tab event.relatedTarget // previous active tab }) } ```