Collapse
How it works
The collapse JavaScript plugin is used to show and hide
content. Buttons or anchors are used as triggers that
are mapped to specific elements you toggle. Collapsing
an element will animate the height from its
current value to 0. Given how CSS handles
animations, you cannot use padding on a
.collapse element. Instead, use the class
as an independent wrapping element.
prefers-reduced-motion media query.
See the
reduced motion section of our accessibility
documentation.
Example
Click the buttons below to show and hide another element via class changes:
.collapsehides content-
.collapsingis applied during transitions .collapse.showshows content
You can use a link with the href attribute,
or a button with the data-target attribute.
In both cases, the
data-bs-toggle="collapse" is required.
<p>
<a class="btn btn-primary" data-toggle="collapse" href="#collapseExample" role="button" aria-expanded="false" aria-controls="collapseExample">
Link with href
</a>
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#collapseExample" aria-expanded="false" aria-controls="collapseExample">
Button with data-target
</button>
</p>
<div class="collapse" id="collapseExample">
<div class="card card-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
</div>
</div>
Multiple targets
A <button> or
<a> can show and hide multiple
elements by referencing them with a selector in its
href or data-target attribute.
Multiple <button> or
<a> can show and hide an element if
they each reference it with their href or
data-target attribute
<p>
<a class="btn btn-primary" data-toggle="collapse" href="#multiCollapseExample1" role="button" aria-expanded="false" aria-controls="multiCollapseExample1">Toggle first element</a>
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#multiCollapseExample2" aria-expanded="false" aria-controls="multiCollapseExample2">Toggle second element</button>
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target=".multi-collapse" aria-expanded="false" aria-controls="multiCollapseExample1 multiCollapseExample2">Toggle both elements</button>
</p>
<div class="row">
<div class="col">
<div class="collapse multi-collapse" id="multiCollapseExample1">
<div class="card card-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
</div>
</div>
</div>
<div class="col">
<div class="collapse multi-collapse" id="multiCollapseExample2">
<div class="card card-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
</div>
</div>
</div>
</div>
Accordion example
Using the
card
component, you can extend the default collapse behavior
to create an accordion. To properly achieve the
accordion style, be sure to use
.accordion as a wrapper.
<div class="accordion" id="accordionExample">
<div class="card">
<div class="card-header p-0" id="headingOne">
<h2 class="mb-0">
<button class="btn btn-light btn-block text-start p-3 rounded-0" type="button" data-toggle="collapse" data-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
Collapsible Group Item #1
</button>
</h2>
</div>
<div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordionExample">
<div class="card-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
</div>
</div>
</div>
<div class="card">
<div class="card-header p-0" id="headingTwo">
<h2 class="mb-0">
<button class="btn btn-light btn-block text-start collapsed p-3 rounded-0" type="button" data-toggle="collapse" data-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
Collapsible Group Item #2
</button>
</h2>
</div>
<div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordionExample">
<div class="card-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
</div>
</div>
</div>
<div class="card">
<div class="card-header p-0" id="headingThree">
<h2 class="mb-0">
<button class="btn btn-light btn-block text-start collapsed p-3 rounded-0" type="button" data-toggle="collapse" data-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
Collapsible Group Item #3
</button>
</h2>
</div>
<div id="collapseThree" class="collapse" aria-labelledby="headingThree" data-parent="#accordionExample">
<div class="card-body">
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
</div>
</div>
</div>
</div>
Accessibility
Be sure to add aria-expanded to the control
element. This attribute explicitly conveys the current
state of the collapsible element tied to the control to
screen readers and similar assistive technologies. If
the collapsible element is closed by default, the
attribute on the control element should have a value of
aria-expanded="false". If you’ve set the
collapsible element to be open by default using the
show class, set
aria-expanded="true" on the control
instead. The plugin will automatically toggle this
attribute on the control based on whether or not the
collapsible element has been opened or closed (via
JavaScript, or because the user triggered another
control element also tied to the same collapsible
element). If the control element’s HTML element is not a
button (e.g., an <a> or
<div>), the attribute
role="button" should be added to the
element.
If your control element is targeting a single
collapsible element – i.e. the
data-target attribute is pointing to an
id selector – you should add the
aria-controls attribute to the control
element, containing the id of the
collapsible element. Modern screen readers and similar
assistive technologies make use of this attribute to
provide users with additional shortcuts to navigate
directly to the collapsible element itself.
Note that Bootstrap’s current implementation does not cover the various optional keyboard interactions described in the WAI-ARIA Authoring Practices 1.1 accordion pattern - you will need to include these yourself with custom JavaScript.
Usage
The collapse plugin utilizes a few classes to handle the heavy lifting:
.collapsehides the content.collapse.showshows the content-
.collapsingis added when the transition starts, and removed when it finishes
These classes can be found in
_transitions.scss.
Via data attributes
Just add data-bs-toggle="collapse" and a
data-target to the element to automatically
assign control of one or more collapsible elements. The
data-target attribute accepts a CSS
selector to apply the collapse to. Be sure to add the
class collapse to the collapsible element.
If you’d like it to default open, add the additional
class show.
To add accordion-like group management to a collapsible
area, add the data attribute
data-parent="#selector". Refer to the demo
to see this in action.
Via JavaScript
Enable manually with:
var collapseElementList = [].slice.call(document.querySelectorAll('.collapse'))
var collapseList = collapseElementList.map(function (collapseEl) {
return new bootstrap.Collapse(collapseEl)
})
Options
Options can be passed via data attributes or JavaScript.
For data attributes, append the option name to
data-, as in data-parent="".
| Name | Type | Default | Description |
|---|---|---|---|
parent |
selector | jQuery object | DOM element | false |
If parent is provided, then all collapsible
elements under the specified parent will be closed
when this collapsible item is shown. (similar to
traditional accordion behavior - this is dependent
on the card class). The attribute has
to be set on the target collapsible area.
|
toggle |
boolean | true |
Toggles the collapsible element on invocation |
Methods
Asynchronous methods and transitions
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Activates your content as a collapsible element. Accepts
an optional options object.
You can create a collapse instance with the constructor, for example:
var myCollapse = document.getElementById('myCollapse')
var bsCollapse = new bootstrap.Collapse(myCollapse, {
toggle: false
})
| Method | Description |
|---|---|
toggle |
Toggles a collapsible element to shown or hidden.
Returns to the caller before the collapsible
element has actually been shown or
hidden
(i.e. before the shown.bs.collapse or
hidden.bs.collapse event occurs).
|
show |
Shows a collapsible element.
Returns to the caller before the collapsible
element has actually been shown
(e.g., before the
shown.bs.collapse event occurs).
|
hide |
Hides a collapsible element.
Returns to the caller before the collapsible
element has actually been hidden
(e.g., before the
hidden.bs.collapse event occurs).
|
dispose |
Destroys an element's collapse. |
getInstance |
Static method which allows you to get the collapse instance associated with a DOM element. |
Events
Bootstrap’s collapse class exposes a few events for hooking into collapse functionality.
| Event type | Description |
|---|---|
show.bs.collapse |
This event fires immediately when the
show instance method is called.
|
shown.bs.collapse |
This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete). |
hide.bs.collapse |
This event is fired immediately when the
hide method has been called.
|
hidden.bs.collapse |
This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete). |
var myCollapsible = document.getElementById('myCollapsible')
myCollapsible.addEventListener('hidden.bs.collapse', function () {
// do something...
})
