Collapse
Toggle the visibility of content across your project with a few classes and our JavaScript plugins.
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 it's 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.
Example
Click the buttons below to show and hide another element via class changes:
.collapse
hides content.collapsing
is applied during transitions.collapse.show
shows content
You can use a link with the href
attribute, or a button with the data-target
attribute. In both cases, the data-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">
This is where we sit down, grab a cup of coffee and dial in the details. Understanding the task at hand and ironing out the wrinkles is a key point.
</div>
</div>
Multiple targets
A <button>
or <a>
can show and hide multiple elements by referencing them with a JQuery 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">
This is where we sit down, grab a cup of coffee and dial in the details. Understanding the task at hand and ironing out the wrinkles is a key point.
</div>
</div>
</div>
<div class="col">
<div class="collapse multi-collapse" id="multiCollapseExample2">
<div class="card card-body">
This is where we sit down, grab a cup of coffee and dial in the details. Understanding the task at hand and ironing out the wrinkles is a key point.
</div>
</div>
</div>
</div>
Accordion example
Using the card component, you can extend the default collapse behavior to create an accordion.
<!-- Basics Accordion -->
<div id="basicsAccordion">
<!-- Card -->
<div class="card mb-3">
<div class="card-header card-collapse" id="basicsHeadingOne">
<h5 class="mb-0">
<button type="button" class="btn btn-link btn-block d-flex justify-content-between card-btn p-3"
data-toggle="collapse"
data-target="#basicsCollapseOne"
aria-expanded="true"
aria-controls="basicsCollapseOne">
Do you have any built-in caching?
<span class="card-btn-arrow">
<span class="fas fa-arrow-down small"></span>
</span>
</button>
</h5>
</div>
<div id="basicsCollapseOne" class="collapse show"
aria-labelledby="basicsHeadingOne"
data-parent="#basicsAccordion">
<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>
<!-- End Card -->
<!-- Card -->
<div class="card mb-3">
<div class="card-header card-collapse" id="basicsHeadingTwo">
<h5 class="mb-0">
<button type="button" class="btn btn-link btn-block d-flex justify-content-between card-btn collapsed p-3"
data-toggle="collapse"
data-target="#basicsCollapseTwo"
aria-expanded="false"
aria-controls="basicsCollapseTwo">
Can I add/upgrade my plan at any time?
<span class="card-btn-arrow">
<span class="fas fa-arrow-down small"></span>
</span>
</button>
</h5>
</div>
<div id="basicsCollapseTwo" class="collapse"
aria-labelledby="basicsHeadingTwo"
data-parent="#basicsAccordion">
<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>
<!-- End Card -->
<!-- Card -->
<div class="card mb-3">
<div class="card-header card-collapse" id="basicsHeadingThree">
<h5 class="mb-0">
<button type="button" class="btn btn-link btn-block d-flex justify-content-between card-btn collapsed p-3"
data-toggle="collapse"
data-target="#basicsCollapseThree"
aria-expanded="false"
aria-controls="basicsCollapseThree">
What access comes with my hosting plan?
<span class="card-btn-arrow">
<span class="fas fa-arrow-down small"></span>
</span>
</button>
</h5>
</div>
<div id="basicsCollapseThree" class="collapse"
aria-labelledby="basicsHeadingThree"
data-parent="#basicsAccordion">
<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>
<!-- End Card -->
<!-- Card -->
<div class="card mb-3">
<div class="card-header card-collapse" id="basicsHeadingFour">
<h5 class="mb-0">
<button type="button" class="btn btn-link btn-block d-flex justify-content-between card-btn collapsed p-3"
data-toggle="collapse"
data-target="#basicsCollapseFour"
aria-expanded="false"
aria-controls="basicsCollapseFour">
How do I change my password?
<span class="card-btn-arrow">
<span class="fas fa-arrow-down small"></span>
</span>
</button>
</h5>
</div>
<div id="basicsCollapseFour" class="collapse"
aria-labelledby="basicsHeadingFour"
data-parent="#basicsAccordion">
<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>
<!-- End Card -->
</div>
<!-- End Basics Accordion -->
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 collapsbile 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 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:
.collapse
hides the content.collapse.show
shows the content.collapsing
is added when the transition starts, and removed when it finishes
These classes can be found in assets/vendor/bootstrap/scss/_transitions.scss
.
Via data attributes
Just add data-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.
JavaScript behavior
For more information, see the official Bootstrap documentation.