diff options
Diffstat (limited to 'site/content/docs/5.1/components/list-group.md')
| -rw-r--r-- | site/content/docs/5.1/components/list-group.md | 542 |
1 files changed, 542 insertions, 0 deletions
diff --git a/site/content/docs/5.1/components/list-group.md b/site/content/docs/5.1/components/list-group.md new file mode 100644 index 0000000000..c49541bdba --- /dev/null +++ b/site/content/docs/5.1/components/list-group.md @@ -0,0 +1,542 @@ +--- +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 >}} +<ul class="list-group"> + <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> +</ul> +{{< /example >}} + +## Active items + +Add `.active` to a `.list-group-item` to indicate the current active selection. + +{{< example >}} +<ul class="list-group"> + <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> +</ul> +{{< /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 >}} +<ul class="list-group"> + <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> +</ul> +{{< /example >}} + +## Links and buttons + +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. + +Be sure to **not use the standard `.btn` classes here**. + +{{< example >}} +<div class="list-group"> + <a href="#" class="list-group-item list-group-item-action active" aria-current="true"> + The current link item + </a> + <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> +</div> +{{< /example >}} + +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. + +{{< example >}} +<div class="list-group"> + <button type="button" class="list-group-item list-group-item-action active" aria-current="true"> + The current button + </button> + <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> +</div> +{{< /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 >}} +<ul class="list-group list-group-flush"> + <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> +</ul> +{{< /example >}} + +## Numbered + +Add the `.list-group-numbered` modifier class (and optionally use an `<ol>` element) to opt into numbered list group items. Numbers are generated via CSS (as opposed to a `<ol>`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 `<ol>`, and then styled and placed with a `::before` pseudo-element on the `<li>` with `counter-increment` and `content`. + +{{< example >}} +<ol class="list-group list-group-numbered"> + <li class="list-group-item">Cras justo odio</li> + <li class="list-group-item">Cras justo odio</li> + <li class="list-group-item">Cras justo odio</li> +</ol> +{{< /example >}} + +These work great with custom content as well. + +{{< example >}} +<ol class="list-group list-group-numbered"> + <li class="list-group-item d-flex justify-content-between align-items-start"> + <div class="ms-2 me-auto"> + <div class="fw-bold">Subheading</div> + Cras justo odio + </div> + <span class="badge bg-primary rounded-pill">14</span> + </li> + <li class="list-group-item d-flex justify-content-between align-items-start"> + <div class="ms-2 me-auto"> + <div class="fw-bold">Subheading</div> + Cras justo odio + </div> + <span class="badge bg-primary rounded-pill">14</span> + </li> + <li class="list-group-item d-flex justify-content-between align-items-start"> + <div class="ms-2 me-auto"> + <div class="fw-bold">Subheading</div> + Cras justo odio + </div> + <span class="badge bg-primary rounded-pill">14</span> + </li> +</ol> +{{< /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 }} +<ul class="list-group list-group-horizontal{{ .abbr }}"> + <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> +</ul> +{{- end -}} +{{< /list-group.inline >}} +{{< /example >}} + +## Contextual classes + +Use contextual classes to style list items with a stateful background and color. + +{{< example >}} +<ul class="list-group"> + <li class="list-group-item">A simple default list group item</li> +{{< 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 >}} +</ul> +{{< /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 >}} +<div class="list-group"> + <a href="#" class="list-group-item list-group-item-action">A simple default list group item</a> +{{< 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 >}} +</div> +{{< /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 >}} +<ul class="list-group"> + <li class="list-group-item d-flex justify-content-between align-items-center"> + A list item + <span class="badge bg-primary rounded-pill">14</span> + </li> + <li class="list-group-item d-flex justify-content-between align-items-center"> + A second list item + <span class="badge bg-primary rounded-pill">2</span> + </li> + <li class="list-group-item d-flex justify-content-between align-items-center"> + A third list item + <span class="badge bg-primary rounded-pill">1</span> + </li> +</ul> +{{< /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 >}} +<div class="list-group"> + <a href="#" class="list-group-item list-group-item-action active" aria-current="true"> + <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">Some placeholder content in a paragraph.</p> + <small>And some small print.</small> + </a> + <a href="#" class="list-group-item list-group-item-action"> + <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">Some placeholder content in a paragraph.</p> + <small class="text-muted">And some muted small print.</small> + </a> + <a href="#" class="list-group-item list-group-item-action"> + <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">Some placeholder content in a paragraph.</p> + <small class="text-muted">And some muted small print.</small> + </a> +</div> +{{< /example >}} + +## 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"> + <input class="form-check-input me-1" type="checkbox" value="" aria-label="..."> + First checkbox + </li> + <li class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value="" aria-label="..."> + Second checkbox + </li> + <li class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value="" aria-label="..."> + Third checkbox + </li> + <li class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value="" aria-label="..."> + Fourth checkbox + </li> + <li class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value="" aria-label="..."> + Fifth checkbox + </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"> + <input class="form-check-input me-1" type="checkbox" value=""> + First checkbox + </label> + <label class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value=""> + Second checkbox + </label> + <label class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value=""> + Third checkbox + </label> + <label class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value=""> + Fourth checkbox + </label> + <label class="list-group-item"> + <input class="form-check-input me-1" type="checkbox" value=""> + Fifth checkbox + </label> +</div> +{{< /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. + +<div class="bd-example" role="tabpanel"> + <div class="row"> + <div class="col-4"> + <div class="list-group" id="list-tab" role="tablist"> + <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> + </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"> + <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> + </div> + <div class="tab-pane fade" id="list-profile" role="tabpanel" aria-labelledby="list-profile-list"> + <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> + </div> + <div class="tab-pane fade" id="list-messages" role="tabpanel" aria-labelledby="list-messages-list"> + <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> + </div> + <div class="tab-pane fade" id="list-settings" role="tabpanel" aria-labelledby="list-settings-list"> + <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> + </div> + </div> + </div> + </div> +</div> + +```html +<div class="row"> + <div class="col-4"> + <div class="list-group" id="list-tab" role="tablist"> + <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="list-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="list-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="list-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="list-settings">Settings</a> + </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> +``` + +### 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 +<div role="tabpanel"> + <!-- List group --> + <div class="list-group" id="myList" role="tablist"> + <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> + </div> + + <!-- 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> +</div> +``` + +### Via JavaScript + +Enable tabbable list item via JavaScript (each list item needs to be activated individually): + +```js +var triggerTabList = [].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 +<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> +``` + +### 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 +<div class="list-group" id="myList" role="tablist"> + <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> +</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> + var firstTabEl = document.querySelector('#myTab a:last-child') + var firstTab = new bootstrap.Tab(firstTabEl) + + firstTab.show() +</script> +``` + +#### 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 initialised + +```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. + +<table class="table"> + <thead> + <tr> + <th style="width: 150px;">Event type</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><code>show.bs.tab</code></td> + <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> + </tr> + <tr> + <td><code>shown.bs.tab</code></td> + <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> + <td><code>hide.bs.tab</code></td> + <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> + <td><code>hidden.bs.tab</code></td> + <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> + +```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 + }) +} +``` |