25/4/2020 Collapse · Bootstrap

Collapse
Search...
Toggle the visibility of content across your project with a few classes and
our JavaScript plugins.
Getting started

Layout
Fast, secure, and scalable
Content CI/CD for all your software
projects. Try Buildkite
today.
Components
ads via Carbon
Alerts

Badge

Breadcrumb

Buttons How it works

Button group The collapse JavaScript plugin is used to show and hide content. Buttons or anchors are used as
Card triggers that are mapped to specific elements you toggle. Collapsing an element will animate the
Carousel 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.
Collapse

Dropdowns

Forms The animation effect of this component is dependent on the prefers-reduced-motion media
Input group query. See the reduced motion section of our accessibility documentation.

Jumbotron

List group

Media object
Example
Modal
Click the buttons below to show and hide another element via class changes:
Navs

Navbar .collapse hides content

Pagination .collapsing is applied during transitions

Popovers .collapse.show shows content

Progress You can use a link with the href attribute, or a button with the data-target attribute. In both cases,
Scrollspy the data-toggle="collapse" is required.
Spinners

Toasts
Link with href Button with data-target
Tooltips

Utilities
Copy
Extend <p>
<a class="btn btn-primary" data-toggle="collapse" href="#collapseExample"
Migration
role="button" aria-expanded="false" aria-controls="collapseExample">
About 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>

https://getbootstrap.com/docs/4.4/components/collapse/ 1/7
25/4/2020 Collapse · Bootstrap

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

Toggle first element Toggle second element Toggle both elements

Copy
<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.

Collapsible Group Item #1

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.

Collapsible Group Item #2

https://getbootstrap.com/docs/4.4/components/collapse/ 2/7
25/4/2020 Collapse · Bootstrap

Collapsible Group Item #3

Copy

https://getbootstrap.com/docs/4.4/components/collapse/ 3/7
25/4/2020 Collapse · Bootstrap

<div class="accordion" id="accordionExample">

<div class="card">
<div class="card-header" id="headingOne">
<h2 class="mb-0">
<button class="btn btn-link" 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" id="headingTwo">
<h2 class="mb-0">
<button class="btn btn-link collapsed" 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" id="headingThree">
<h2 class="mb-0">
<button class="btn btn-link collapsed" 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>

https://getbootstrap.com/docs/4.4/components/collapse/ 4/7
25/4/2020 Collapse · Bootstrap

</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 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 _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.

Via JavaScript
Enable manually with:

Copy
$('.collapse').collapse()

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

https://getbootstrap.com/docs/4.4/components/collapse/ 5/7
25/4/2020 Collapse · Bootstrap

Name Type Default Description

parent selector false If parent is provided, then all collapsible elements under the
| jQuery specified parent will be closed when this collapsible item is
object | shown. (similar to traditional accordion behavior - this is
DOM dependent on the card class). The attribute has to be set on
element 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.

See our JavaScript documentation for more information.

.collapse(options)
Activates your content as a collapsible element. Accepts an optional options object.

Copy
$('#myCollapsible').collapse({
toggle: false
})

.collapse('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).

.collapse('show')
Shows a collapsible element. Returns to the caller before the collapsible element has actually
been shown (i.e. before the shown.bs.collapse event occurs).

.collapse('hide')
Hides a collapsible element. Returns to the caller before the collapsible element has actually been
hidden (i.e. before the hidden.bs.collapse event occurs).

.collapse('dispose')
Destroys an element’s collapse.

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).

https://getbootstrap.com/docs/4.4/components/collapse/ 6/7
25/4/2020 Collapse · Bootstrap

$('#myCollapsible').on('hidden.bs.collapse', function () { Copy

// do something...
})

https://getbootstrap.com/docs/4.4/components/collapse/ 7/7