2014-07-13 09:59:31 +02:00
---
2015-08-15 07:45:55 +02:00
layout: docs
2014-07-13 09:59:31 +02:00
title: List group
2017-05-28 08:01:14 +02:00
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.
2015-08-06 02:47:45 +02:00
group: components
2017-05-28 08:01:14 +02:00
toc: true
2014-07-13 09:59:31 +02:00
---
2015-05-29 10:58:52 +02:00
## Basic example
2017-05-28 08:01:14 +02:00
2016-12-28 22:45:07 +01:00
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.
2014-07-13 10:12:06 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2014-03-17 03:03:53 +01:00
< ul class = "list-group" >
2020-12-11 21:05:33 +01:00
< li class = "list-group-item" > An item< / li >
< li class = "list-group-item" > A second item< / li >
< li class = "list-group-item" > A third item< / li >
< li class = "list-group-item" > A fourth item< / li >
< li class = "list-group-item" > And a fifth one< / li >
2014-03-17 03:03:53 +01:00
< / ul >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2014-07-13 10:12:06 +02:00
2016-12-28 22:45:07 +01:00
## Active items
2014-07-13 10:12:06 +02:00
2016-12-28 22:45:07 +01:00
Add `.active` to a `.list-group-item` to indicate the current active selection.
2016-10-30 22:13:06 +01:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2016-10-30 22:13:06 +01:00
< ul class = "list-group" >
2020-12-11 21:05:33 +01:00
< li class = "list-group-item active" aria-current = "true" > An active item< / li >
< li class = "list-group-item" > A second item< / li >
< li class = "list-group-item" > A third item< / li >
< li class = "list-group-item" > A fourth item< / li >
< li class = "list-group-item" > And a fifth one< / li >
2016-10-30 22:13:06 +01:00
< / ul >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2016-10-30 22:13:06 +01:00
2016-02-07 04:50:00 +01:00
## Disabled items
2014-07-13 10:12:06 +02:00
2016-12-28 22:45:07 +01:00
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).
2014-07-13 10:12:06 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2016-12-28 22:45:07 +01:00
< ul class = "list-group" >
2020-12-11 21:05:33 +01:00
< li class = "list-group-item disabled" aria-disabled = "true" > A disabled item< / li >
< li class = "list-group-item" > A second item< / li >
< li class = "list-group-item" > A third item< / li >
< li class = "list-group-item" > A fourth item< / li >
< li class = "list-group-item" > And a fifth one< / li >
2016-12-28 22:45:07 +01:00
< / ul >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2014-07-13 10:12:06 +02:00
2016-12-28 22:45:07 +01:00
## Links and buttons
2016-02-07 04:50:00 +01:00
2016-12-28 22:45:07 +01:00
Use `<a>` s or `<button>` s to create _actionable_ list group items with hover, disabled, and active states by adding `.list-group-item-action` . We separate these pseudo-classes to ensure list groups made of non-interactive elements (like `<li>` s or `<div>` s) don't provide a click or tap affordance.
2015-06-19 08:56:43 +02:00
2016-02-07 04:50:00 +01:00
Be sure to **not use the standard `.btn` classes here** .
2015-06-19 08:56:43 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2015-06-19 08:56:43 +02:00
< div class = "list-group" >
2020-02-07 12:18:30 +01:00
< a href = "#" class = "list-group-item list-group-item-action active" aria-current = "true" >
2020-12-11 21:05:33 +01:00
The current link item
2016-02-07 04:50:00 +01:00
< / a >
2020-12-11 21:05:33 +01:00
< a href = "#" class = "list-group-item list-group-item-action" > A second link item< / a >
< a href = "#" class = "list-group-item list-group-item-action" > A third link item< / a >
< a href = "#" class = "list-group-item list-group-item-action" > A fourth link item< / a >
< a href = "#" class = "list-group-item list-group-item-action disabled" tabindex = "-1" aria-disabled = "true" > A disabled link item< / a >
2015-06-19 08:56:43 +02:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2015-06-19 08:56:43 +02:00
2016-12-28 22:45:07 +01:00
With `<button>` s, you can also make use of the `disabled` attribute instead of the `.disabled` class. Sadly, `<a>` s don't support the disabled attribute.
2019-01-08 17:33:28 +01:00
{{< example > }}
2014-03-17 03:03:53 +01:00
< div class = "list-group" >
2020-02-07 12:18:30 +01:00
< button type = "button" class = "list-group-item list-group-item-action active" aria-current = "true" >
2020-12-11 21:05:33 +01:00
The current button
2016-02-07 04:50:00 +01:00
< / button >
2020-12-11 21:05:33 +01:00
< button type = "button" class = "list-group-item list-group-item-action" > A second item< / button >
< button type = "button" class = "list-group-item list-group-item-action" > A third button item< / button >
< button type = "button" class = "list-group-item list-group-item-action" > A fourth button item< / button >
< button type = "button" class = "list-group-item list-group-item-action" disabled > A disabled button item< / button >
2014-03-17 03:03:53 +01:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2014-07-13 10:12:06 +02:00
2018-01-15 00:46:58 +01:00
## 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).
2019-01-08 17:33:28 +01:00
{{< example > }}
2018-01-15 00:46:58 +01:00
< ul class = "list-group list-group-flush" >
2020-12-11 21:05:33 +01:00
< li class = "list-group-item" > An item< / li >
< li class = "list-group-item" > A second item< / li >
< li class = "list-group-item" > A third item< / li >
< li class = "list-group-item" > A fourth item< / li >
< li class = "list-group-item" > And a fifth one< / li >
2018-01-15 00:46:58 +01:00
< / ul >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2018-01-15 00:46:58 +01:00
2019-01-07 02:01:36 +01:00
## Horizontal
2020-04-13 23:40:47 +02:00
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.**
2019-01-07 02:01:36 +01:00
**ProTip:** Want equal-width list group items when horizontal? Add `.flex-fill` to each list group item.
2019-01-08 17:33:28 +01:00
{{< example > }}
{{< list-group.inline > }}
{{- range $.Site.Data.breakpoints }}
< ul class = "list-group list-group-horizontal{{ .abbr }}" >
2020-12-11 21:05:33 +01:00
< li class = "list-group-item" > An item< / li >
< li class = "list-group-item" > A second item< / li >
< li class = "list-group-item" > A third item< / li >
2019-01-07 02:01:36 +01:00
< / ul >
2019-01-08 17:33:28 +01:00
{{- end -}}
{{< / list-group.inline > }}
{{< / example > }}
2019-01-07 02:01:36 +01:00
2015-05-29 10:58:52 +02:00
## Contextual classes
2014-07-13 10:12:06 +02:00
2016-12-28 22:52:49 +01:00
Use contextual classes to style list items with a stateful background and color.
2019-01-08 17:33:28 +01:00
{{< example > }}
2016-12-28 22:52:49 +01:00
< ul class = "list-group" >
2020-12-11 21:05:33 +01:00
< li class = "list-group-item" > A simple default list group item< / li >
2019-01-08 17:33:28 +01:00
{{< list.inline > }}
{{- range (index $.Site.Data "theme-colors") }}
< li class = "list-group-item list-group-item-{{ .name }}" > A simple {{ .name }} list group item< / li >
{{- end -}}
{{< / list.inline > }}
2016-12-28 22:52:49 +01:00
< / ul >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2016-12-28 22:52:49 +01:00
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.
2014-07-13 10:12:06 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2014-03-17 03:03:53 +01:00
< div class = "list-group" >
2020-12-11 21:05:33 +01:00
< a href = "#" class = "list-group-item list-group-item-action" > A simple default list group item< / a >
2019-01-08 17:33:28 +01:00
{{< list.inline > }}
{{- range (index $.Site.Data "theme-colors") }}
< a href = "#" class = "list-group-item list-group-item-action list-group-item-{{ .name }}" > A simple {{ .name }} list group item< / a >
{{- end -}}
{{< / list.inline > }}
2014-03-17 03:03:53 +01:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2014-07-13 10:12:06 +02:00
2020-10-13 15:37:21 +02:00
{{< callout info > }}
2019-01-08 17:33:28 +01:00
{{< partial " callout-warning-color-assistive-technologies . md " > }}
2020-10-13 15:37:21 +02:00
{{< / callout > }}
2016-02-17 11:22:48 +01:00
2016-12-28 22:45:07 +01:00
## With badges
2019-02-04 11:22:02 +01:00
Add badges to any list group item to show unread counts, activity, and more with the help of some [utilities ]({{< docsref "/utilities/flex" >}} ).
2016-12-28 22:45:07 +01:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2016-12-28 22:45:07 +01:00
< ul class = "list-group" >
2017-03-19 00:30:12 +01:00
< li class = "list-group-item d-flex justify-content-between align-items-center" >
2020-12-11 21:05:33 +01:00
A list item
2019-08-04 07:23:25 +02:00
< span class = "badge bg-primary rounded-pill" > 14< / span >
2016-12-28 22:45:07 +01:00
< / li >
2017-03-19 00:30:12 +01:00
< li class = "list-group-item d-flex justify-content-between align-items-center" >
2020-12-11 21:05:33 +01:00
A second list item
2019-08-04 07:23:25 +02:00
< span class = "badge bg-primary rounded-pill" > 2< / span >
2016-12-28 22:45:07 +01:00
< / li >
2017-03-19 00:30:12 +01:00
< li class = "list-group-item d-flex justify-content-between align-items-center" >
2020-12-11 21:05:33 +01:00
A third list item
2019-08-04 07:23:25 +02:00
< span class = "badge bg-primary rounded-pill" > 1< / span >
2016-12-28 22:45:07 +01:00
< / li >
< / ul >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2016-12-28 22:45:07 +01:00
2015-05-29 10:58:52 +02:00
## Custom content
2014-07-13 10:12:06 +02:00
2019-02-04 11:22:02 +01:00
Add nearly any HTML within, even for linked list groups like the one below, with the help of [flexbox utilities ]({{< docsref "/utilities/flex" >}} ).
2014-07-13 10:12:06 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2014-03-17 03:03:53 +01:00
< div class = "list-group" >
2020-02-07 12:18:30 +01:00
< a href = "#" class = "list-group-item list-group-item-action active" aria-current = "true" >
2017-01-04 05:08:10 +01:00
< div class = "d-flex w-100 justify-content-between" >
< h5 class = "mb-1" > List group item heading< / h5 >
< small > 3 days ago< / small >
< / div >
2020-12-11 21:05:33 +01:00
< p class = "mb-1" > Some placeholder content in a paragraph.< / p >
< small > And some small print.< / small >
2014-07-13 10:12:06 +02:00
< / a >
2018-09-19 07:14:45 +02:00
< a href = "#" class = "list-group-item list-group-item-action" >
2017-01-04 05:08:10 +01:00
< 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 >
2020-12-11 21:05:33 +01:00
< p class = "mb-1" > Some placeholder content in a paragraph.< / p >
< small class = "text-muted" > And some muted small print.< / small >
2014-07-13 10:12:06 +02:00
< / a >
2018-09-19 07:14:45 +02:00
< a href = "#" class = "list-group-item list-group-item-action" >
2017-01-04 05:08:10 +01:00
< 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 >
2020-12-11 21:05:33 +01:00
< p class = "mb-1" > Some placeholder content in a paragraph.< / p >
< small class = "text-muted" > And some muted small print.< / small >
2014-03-17 03:03:53 +01:00
< / a >
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2017-04-02 11:21:04 +02:00
2019-10-02 21:19:45 +02:00
## Checkboxes and radios
Place Bootstrap's checkboxes and radios within list group items and customize as needed. You can use them without `<label>` s, but please remember to include an `aria-label` attribute and value for accessibility.
{{< example > }}
< ul class = "list-group" >
< li class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" aria-label = "..." >
2020-12-11 21:05:33 +01:00
First checkbox
2019-10-02 21:19:45 +02:00
< / li >
< li class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" aria-label = "..." >
2020-12-11 21:05:33 +01:00
Second checkbox
2019-10-02 21:19:45 +02:00
< / li >
< li class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" aria-label = "..." >
2020-12-11 21:05:33 +01:00
Third checkbox
2019-10-02 21:19:45 +02:00
< / li >
< li class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" aria-label = "..." >
2020-12-11 21:05:33 +01:00
Fourth checkbox
2019-10-02 21:19:45 +02:00
< / li >
< li class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" aria-label = "..." >
2020-12-11 21:05:33 +01:00
Fifth checkbox
2019-10-02 21:19:45 +02:00
< / li >
< / ul >
{{< / example > }}
And if you want `<label>` s as the `.list-group-item` for large hit areas, you can do that, too.
{{< example > }}
< div class = "list-group" >
< label class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" >
2020-12-11 21:05:33 +01:00
First checkbox
2019-10-02 21:19:45 +02:00
< / label >
< label class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" >
2020-12-11 21:05:33 +01:00
Second checkbox
2019-10-02 21:19:45 +02:00
< / label >
< label class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" >
2020-12-11 21:05:33 +01:00
Third checkbox
2019-10-02 21:19:45 +02:00
< / label >
< label class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" >
2020-12-11 21:05:33 +01:00
Fourth checkbox
2019-10-02 21:19:45 +02:00
< / label >
< label class = "list-group-item" >
2020-06-09 15:44:20 +02:00
< input class = "form-check-input me-1" type = "checkbox" value = "" >
2020-12-11 21:05:33 +01:00
Fifth checkbox
2019-10-02 21:19:45 +02:00
< / label >
< / div >
{{< / example > }}
2017-04-02 11:21:04 +02:00
## 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.
< div class = "bd-example" role = "tabpanel" >
< div class = "row" >
< div class = "col-4" >
< div class = "list-group" id = "list-tab" role = "tablist" >
2020-07-22 21:33:11 +02:00
< a class = "list-group-item list-group-item-action active" id = "list-home-list" data-bs-toggle = "tab" href = "#list-home" role = "tab" aria-controls = "list-home" > Home< / a >
< a class = "list-group-item list-group-item-action" id = "list-profile-list" data-bs-toggle = "tab" href = "#list-profile" role = "tab" aria-controls = "list-profile" > Profile< / a >
< a class = "list-group-item list-group-item-action" id = "list-messages-list" data-bs-toggle = "tab" href = "#list-messages" role = "tab" aria-controls = "list-messages" > Messages< / a >
< a class = "list-group-item list-group-item-action" id = "list-settings-list" data-bs-toggle = "tab" href = "#list-settings" role = "tab" aria-controls = "list-settings" > Settings< / a >
2017-04-02 11:21:04 +02:00
< / div >
< / div >
< div class = "col-8" >
< div class = "tab-content" id = "nav-tabContent" >
< div class = "tab-pane fade show active" id = "list-home" role = "tabpanel" aria-labelledby = "list-home-list" >
2020-12-11 21:05:33 +01:00
< p > 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.< / p >
2017-04-02 11:21:04 +02:00
< / div >
< div class = "tab-pane fade" id = "list-profile" role = "tabpanel" aria-labelledby = "list-profile-list" >
2020-12-11 21:05:33 +01:00
< p > 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.< / p >
2017-04-02 11:21:04 +02:00
< / div >
< div class = "tab-pane fade" id = "list-messages" role = "tabpanel" aria-labelledby = "list-messages-list" >
2020-12-11 21:05:33 +01:00
< p > 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.< / p >
2017-04-02 11:21:04 +02:00
< / div >
< div class = "tab-pane fade" id = "list-settings" role = "tabpanel" aria-labelledby = "list-settings-list" >
2020-12-11 21:05:33 +01:00
< p > 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.< / p >
2017-04-02 11:21:04 +02:00
< / div >
< / div >
< / div >
< / div >
< / div >
2020-10-19 11:56:49 +02:00
```html
2017-04-02 11:21:04 +02:00
< div class = "row" >
< div class = "col-4" >
< div class = "list-group" id = "list-tab" role = "tablist" >
2020-07-22 21:33:11 +02:00
< a class = "list-group-item list-group-item-action active" id = "list-home-list" data-bs-toggle = "list" href = "#list-home" role = "tab" aria-controls = "home" > Home< / a >
< a class = "list-group-item list-group-item-action" id = "list-profile-list" data-bs-toggle = "list" href = "#list-profile" role = "tab" aria-controls = "profile" > Profile< / a >
< a class = "list-group-item list-group-item-action" id = "list-messages-list" data-bs-toggle = "list" href = "#list-messages" role = "tab" aria-controls = "messages" > Messages< / a >
< a class = "list-group-item list-group-item-action" id = "list-settings-list" data-bs-toggle = "list" href = "#list-settings" role = "tab" aria-controls = "settings" > Settings< / a >
2017-04-02 11:21:04 +02:00
< / div >
< / div >
< div class = "col-8" >
< div class = "tab-content" id = "nav-tabContent" >
< div class = "tab-pane fade show active" id = "list-home" role = "tabpanel" aria-labelledby = "list-home-list" > ...< / div >
< div class = "tab-pane fade" id = "list-profile" role = "tabpanel" aria-labelledby = "list-profile-list" > ...< / div >
< div class = "tab-pane fade" id = "list-messages" role = "tabpanel" aria-labelledby = "list-messages-list" > ...< / div >
< div class = "tab-pane fade" id = "list-settings" role = "tabpanel" aria-labelledby = "list-settings-list" > ...< / div >
< / div >
< / div >
< / div >
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
### Using data attributes
2020-07-22 21:33:11 +02:00
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` .
2017-04-02 11:21:04 +02:00
2020-10-19 11:56:49 +02:00
```html
2020-10-27 10:24:28 +01:00
< div role = "tabpanel" >
<!-- List group -->
< div class = "list-group" id = "myList" role = "tablist" >
2020-07-22 21:33:11 +02:00
< a class = "list-group-item list-group-item-action active" data-bs-toggle = "list" href = "#home" role = "tab" > Home< / a >
< a class = "list-group-item list-group-item-action" data-bs-toggle = "list" href = "#profile" role = "tab" > Profile< / a >
< a class = "list-group-item list-group-item-action" data-bs-toggle = "list" href = "#messages" role = "tab" > Messages< / a >
< a class = "list-group-item list-group-item-action" data-bs-toggle = "list" href = "#settings" role = "tab" > Settings< / a >
2020-10-27 10:24:28 +01:00
< / div >
2017-04-02 11:21:04 +02:00
2020-10-27 10:24:28 +01:00
<!-- Tab panes -->
< div class = "tab-content" >
< div class = "tab-pane active" id = "home" role = "tabpanel" > ...< / div >
< div class = "tab-pane" id = "profile" role = "tabpanel" > ...< / div >
< div class = "tab-pane" id = "messages" role = "tabpanel" > ...< / div >
< div class = "tab-pane" id = "settings" role = "tabpanel" > ...< / div >
< / div >
2017-04-02 11:21:04 +02:00
< / div >
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
### Via JavaScript
Enable tabbable list item via JavaScript (each list item needs to be activated individually):
2020-10-19 11:56:49 +02:00
```js
2019-08-04 11:55:37 +02:00
var triggerTabList = [].slice.call(document.querySelectorAll('#myTab a'))
triggerTabList.forEach(function (triggerEl) {
var tabTrigger = new bootstrap.Tab(triggerEl)
2020-11-21 16:00:38 +01:00
triggerEl.addEventListener('click', function (event) {
event.preventDefault()
2019-08-04 11:55:37 +02:00
tabTrigger.show()
})
2017-04-02 11:21:04 +02:00
})
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
You can activate individual list item in several ways:
2020-10-19 11:56:49 +02:00
```js
2019-08-04 11:55:37 +02:00
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
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
### 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.
2020-10-19 11:56:49 +02:00
```html
2017-04-02 11:21:04 +02:00
< div class = "tab-content" >
< div class = "tab-pane fade show active" id = "home" role = "tabpanel" > ...< / div >
< div class = "tab-pane fade" id = "profile" role = "tabpanel" > ...< / div >
< div class = "tab-pane fade" id = "messages" role = "tabpanel" > ...< / div >
< div class = "tab-pane fade" id = "settings" role = "tabpanel" > ...< / div >
< / div >
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
### Methods
2019-08-04 11:55:37 +02:00
#### constructor
2017-04-02 11:21:04 +02:00
2020-07-22 21:33:11 +02:00
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.
2017-04-02 11:21:04 +02:00
2020-10-19 11:56:49 +02:00
```html
2017-04-02 11:21:04 +02:00
< div class = "list-group" id = "myList" role = "tablist" >
2020-07-22 21:33:11 +02:00
< a class = "list-group-item list-group-item-action active" data-bs-toggle = "list" href = "#home" role = "tab" > Home< / a >
< a class = "list-group-item list-group-item-action" data-bs-toggle = "list" href = "#profile" role = "tab" > Profile< / a >
< a class = "list-group-item list-group-item-action" data-bs-toggle = "list" href = "#messages" role = "tab" > Messages< / a >
< a class = "list-group-item list-group-item-action" data-bs-toggle = "list" href = "#settings" role = "tab" > Settings< / a >
2017-04-02 11:21:04 +02:00
< / div >
< div class = "tab-content" >
< div class = "tab-pane active" id = "home" role = "tabpanel" > ...< / div >
< div class = "tab-pane" id = "profile" role = "tabpanel" > ...< / div >
< div class = "tab-pane" id = "messages" role = "tabpanel" > ...< / div >
< div class = "tab-pane" id = "settings" role = "tabpanel" > ...< / div >
< / div >
< script >
2019-08-04 11:55:37 +02:00
var firstTabEl = document.querySelector('#myTab a:last-child')
var firstTab = new bootstrap.Tab(firstTabEl)
firstTab.show()
2017-04-02 11:21:04 +02:00
< / script >
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
2019-08-04 11:55:37 +02:00
#### show
2017-04-02 11:21:04 +02:00
2017-04-08 22:58:20 +02:00
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).
2017-04-02 11:21:04 +02:00
2020-10-19 11:56:49 +02:00
```js
2019-08-04 11:55:37 +02:00
var someListItemEl = document.querySelector('#someListItem')
var tab = new bootstrap.Tab(someListItemEl)
tab.show()
2020-10-19 11:56:49 +02:00
```
2019-08-04 11:55:37 +02:00
#### dispose
Destroys an element's tab.
#### getInstance
*Static* method which allows you to get the tab instance associated with a DOM element
2020-10-19 11:56:49 +02:00
```js
2019-08-04 11:55:37 +02:00
var triggerEl = document.querySelector('#trigger')
var tab = bootstrap.Tab.getInstance(triggerEl) // Returns a Bootstrap tab instance
2020-10-19 11:56:49 +02:00
```
2017-04-02 11:21:04 +02:00
### 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)
2017-04-08 22:58:20 +02:00
If no tab was already active, the `hide.bs.tab` and `hidden.bs.tab` events will not be fired.
2017-04-02 11:21:04 +02:00
v5: Forms update (#28450)
* Initial spike of consolidated form checks
* Stub out forms rearrangement
- Prepping to drop non-custom file and range inputs
- Prepping to merge custom and native checks and radios (with switches)
- Prepping to merge custom select with form select
- Moving docs arround so forms has it's own area given volume of CSS
* Move input group Sass file to forms subdir
* Start to split and move the docs around
* Simpler imports
* Copyediting
* delete overview file
* Remove commented out code
* remove the custom-forms import
* rewrite flex-check as form-check, replace all custom properties
* Remove old forms doc
* stub out new subpage link section
* update migration guide
* Update nav, forms overview in page nav, and descriptions
* fix check bg position
* fix margin-top calculation
* rename .custom-select to .form-select
* Update validation styles for new checks
* add some vertical margin, fix inline checks
* fix docs examples
* better way to do this contents stuff, redo the toc while i'm at it
* page restyle for docs while here
* un-callout that, edit text
* redo padding on toc
* fix toc
* start to cleanup checks docs
* Rewrite Markdown tables into HTML
* Redesign tables, redo their docs
* Replace Open Iconic icons with custom Bootstrap icons
* Redesign the docs navbar, add a subheader, redo the sidebar
* Redesign docs homepage a bit
* Simplify table style overrides for docs tables
* Simplify docs typography for page titles and reading line length
* Stub out icons page
* Part of sidebar update, remove migration from nav.yml
* Move toc CSS to separate partial
* Change appearance of overview page
* fix sidebar arrow direction
* Add footer to docs layout
* Update descriptions
* Drop the .form-group class for margin utilities
* Remove lingering form-group-margin-bottom var
* improve footer spacing
* add headings to range page
* uncomment form range css
* Rename .custom-range to .form-range
* Drop unused docs var
* Uncomment the comment
* Remove unused variable
* Fix radio image sizing
* Reboot update: reset horizontal ul and ol padding
* de-dupe IDs
* tweak toc styles
* nvm, fix dropdown versions stuff
* remove sidebar nav toggle for now
* broken html
* fix more broken html, move css
* scss linting
* comment out broken helper docs
* scope styles
* scope styles
* Fixes #25540 and fixes #26407 for v5 only
* Update sidebar once more
* Match new sidenav order
* fix syntax error
* Rename custom-file to form-file, update paths, update migration docs for previous changes in #28696
* rename back
* fix size and alignment
* rename that back too
2019-07-12 23:52:33 +02:00
< table class = "table" >
2017-04-02 11:21:04 +02:00
< thead >
2017-04-28 00:57:10 +02:00
< tr >
< th style = "width: 150px;" > Event type< / th >
< th > Description< / th >
< / tr >
2017-04-02 11:21:04 +02:00
< / thead >
< tbody >
< tr >
2020-06-27 13:28:21 +02:00
< td > < code > show.bs.tab< / code > < / td >
2017-04-02 11:21:04 +02:00
< td > This event fires on tab show, but before the new tab has been shown. Use < code > event.target< / code > and < code > event.relatedTarget< / code > to target the active tab and the previous active tab (if available) respectively.< / td >
2017-04-28 00:57:10 +02:00
< / tr >
< tr >
2020-06-27 13:28:21 +02:00
< td > < code > shown.bs.tab< / code > < / td >
2017-04-02 11:21:04 +02:00
< td > This event fires on tab show after a tab has been shown. Use < code > event.target< / code > and < code > event.relatedTarget< / code > to target the active tab and the previous active tab (if available) respectively.< / td >
< / tr >
< tr >
2020-06-27 13:28:21 +02:00
< td > < code > hide.bs.tab< / code > < / td >
2017-04-02 11:21:04 +02:00
< td > This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use < code > event.target< / code > and < code > event.relatedTarget< / code > to target the current active tab and the new soon-to-be-active tab, respectively.< / td >
< / tr >
< tr >
2020-06-27 13:28:21 +02:00
< td > < code > hidden.bs.tab< / code > < / td >
2017-04-02 11:21:04 +02:00
< td > This event fires after a new tab is shown (and thus the previous active tab is hidden). Use < code > event.target< / code > and < code > event.relatedTarget< / code > to target the previous active tab and the new active tab, respectively.< / td >
< / tr >
< / tbody >
< / table >
2020-10-19 11:56:49 +02:00
```js
2020-07-22 21:33:11 +02:00
var tabEl = document.querySelector('a[data-bs-toggle="list"]')
2020-11-21 16:00:38 +01:00
tabEl.addEventListener('shown.bs.tab', function (event) {
event.target // newly activated tab
event.relatedTarget // previous active tab
2017-04-02 11:21:04 +02:00
})
2020-10-19 11:56:49 +02:00
```
