collapse.md 12.5 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
Mark Otto's avatar
Mark Otto committed
3
title: Collapse
Mark Otto's avatar
Mark Otto committed
4
description: Toggle the visibility of content across your project with a few classes and our JavaScript plugins.
5
group: components
Mark Otto's avatar
Mark Otto committed
6
toc: true
Mark Otto's avatar
Mark Otto committed
7
8
---

9
10
## How it works

chocolateboy's avatar
chocolateboy committed
11
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.
12

13
14
{% include callout-info-prefersreducedmotion.md %}

Mark Otto's avatar
Mark Otto committed
15
## Example
Mark Otto's avatar
Mark Otto committed
16

Mark Otto's avatar
Mark Otto committed
17
18
19
20
Click the buttons below to show and hide another element via class changes:

- `.collapse` hides content
- `.collapsing` is applied during transitions
Starsam80's avatar
Starsam80 committed
21
- `.collapse.show` shows content
Mark Otto's avatar
Mark Otto committed
22
23
24

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.

m5o's avatar
m5o committed
25
{% capture example %}
Mark Otto's avatar
Mark Otto committed
26
<p>
27
  <a class="btn btn-primary" data-toggle="collapse" href="#collapseExample" role="button" aria-expanded="false" aria-controls="collapseExample">
Mark Otto's avatar
Mark Otto committed
28
29
30
31
32
33
34
    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">
35
  <div class="card card-body">
Mark Otto's avatar
Mark Otto committed
36
    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.
Mark Otto's avatar
Mark Otto committed
37
  </div>
Mark Otto's avatar
Mark Otto committed
38
</div>
m5o's avatar
m5o committed
39
40
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
41

42
## Multiple targets
43
44

A `<button>` or `<a>` can show and hide multiple elements by referencing them with a JQuery selector in its `href` or `data-target` attribute.
XhmikosR's avatar
XhmikosR committed
45
Multiple `<button>` or `<a>` can show and hide an element if they each reference it with their `href` or `data-target` attribute
46

m5o's avatar
m5o committed
47
{% capture example %}
48
<p>
49
  <a class="btn btn-primary" data-toggle="collapse" href="#multiCollapseExample1" role="button" aria-expanded="false" aria-controls="multiCollapseExample1">Toggle first element</a>
Chirag Modi's avatar
Chirag Modi committed
50
  <button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#multiCollapseExample2" aria-expanded="false" aria-controls="multiCollapseExample2">Toggle second element</button>
51
52
53
54
55
  <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">
56
      <div class="card card-body">
57
58
59
60
61
62
        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">
63
      <div class="card card-body">
64
65
66
67
68
        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>
m5o's avatar
m5o committed
69
70
{% endcapture %}
{% include example.html content=example %}
71

Mark Otto's avatar
Mark Otto committed
72
## Accordion example
Mark Otto's avatar
Mark Otto committed
73

74
Using the [card]({{ site.baseurl }}/docs/{{ site.docs_version }}/components/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.
Mark Otto's avatar
Mark Otto committed
75

m5o's avatar
m5o committed
76
{% capture example %}
77
<div class="accordion" id="accordionExample">
78
  <div class="card">
79
    <div class="card-header" id="headingOne">
80
      <h2 class="mb-0">
81
        <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
Mark Otto's avatar
Mark Otto committed
82
          Collapsible Group Item #1
83
        </button>
84
      </h2>
Mark Otto's avatar
Mark Otto committed
85
    </div>
Johann-S's avatar
Johann-S committed
86

87
    <div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordionExample">
88
      <div class="card-body">
89
90
        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>
Mark Otto's avatar
Mark Otto committed
91
92
    </div>
  </div>
93
  <div class="card">
94
    <div class="card-header" id="headingTwo">
95
      <h2 class="mb-0">
96
        <button class="btn btn-link collapsed" type="button" data-toggle="collapse" data-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
Mark Otto's avatar
Mark Otto committed
97
          Collapsible Group Item #2
98
        </button>
99
      </h2>
Mark Otto's avatar
Mark Otto committed
100
    </div>
101
    <div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordionExample">
102
      <div class="card-body">
103
104
        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>
Mark Otto's avatar
Mark Otto committed
105
106
    </div>
  </div>
107
  <div class="card">
108
    <div class="card-header" id="headingThree">
109
      <h2 class="mb-0">
110
        <button class="btn btn-link collapsed" type="button" data-toggle="collapse" data-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
Mark Otto's avatar
Mark Otto committed
111
          Collapsible Group Item #3
112
        </button>
113
      </h2>
Mark Otto's avatar
Mark Otto committed
114
    </div>
115
    <div id="collapseThree" class="collapse" aria-labelledby="headingThree" data-parent="#accordionExample">
116
      <div class="card-body">
117
118
        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>
Mark Otto's avatar
Mark Otto committed
119
120
121
    </div>
  </div>
</div>
m5o's avatar
m5o committed
122
123
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
124

125
126
## Accessibility

127
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.
128

129
130
131
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](https://www.w3.org/TR/wai-aria-practices-1.1/#accordion) - you will need to include these yourself with custom JavaScript.
Mark Otto's avatar
Mark Otto committed
132

Mark Otto's avatar
Mark Otto committed
133
134
135
136
137
## Usage

The collapse plugin utilizes a few classes to handle the heavy lifting:

- `.collapse` hides the content
Starsam80's avatar
Starsam80 committed
138
- `.collapse.show` shows the content
Mark Otto's avatar
Mark Otto committed
139
140
- `.collapsing` is added when the transition starts, and removed when it finishes

141
These classes can be found in `_transitions.scss`.
Mark Otto's avatar
Mark Otto committed
142

Mark Otto's avatar
Mark Otto committed
143
144
### Via data attributes

145
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`.
Mark Otto's avatar
Mark Otto committed
146

147
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.
Mark Otto's avatar
Mark Otto committed
148
149
150
151

### Via JavaScript

Enable manually with:
Mark Otto's avatar
Mark Otto committed
152
153
154
155
156

{% highlight js %}
$('.collapse').collapse()
{% endhighlight %}

Mark Otto's avatar
Mark Otto committed
157
158
159
160
### Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-parent=""`.

Mark Otto's avatar
Mark Otto committed
161
<table class="table table-bordered table-striped">
162
  <thead>
163
164
165
166
167
168
    <tr>
      <th style="width: 100px;">Name</th>
      <th style="width: 50px;">Type</th>
      <th style="width: 50px;">Default</th>
      <th>Description</th>
    </tr>
169
170
  </thead>
  <tbody>
171
172
    <tr>
      <td>parent</td>
173
      <td>selector | jQuery object | DOM element </td>
174
      <td>false</td>
175
      <td>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 <code>card</code> class). The attribute has to be set on the target collapsible area.</td>
176
177
178
179
180
181
182
    </tr>
    <tr>
      <td>toggle</td>
      <td>boolean</td>
      <td>true</td>
      <td>Toggles the collapsible element on invocation</td>
    </tr>
183
184
  </tbody>
</table>
Mark Otto's avatar
Mark Otto committed
185
186
187

### Methods

188
{% include callout-danger-async-methods.md %}
189

190
#### `.collapse(options)`
Mark Otto's avatar
Mark Otto committed
191
192
193

Activates your content as a collapsible element. Accepts an optional options `object`.

Mark Otto's avatar
Mark Otto committed
194
195
196
197
198
199
{% highlight js %}
$('#myCollapsible').collapse({
  toggle: false
})
{% endhighlight %}

200
#### `.collapse('toggle')`
Mark Otto's avatar
Mark Otto committed
201

Jqmey's avatar
Jqmey committed
202
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).
Mark Otto's avatar
Mark Otto committed
203

204
#### `.collapse('show')`
Mark Otto's avatar
Mark Otto committed
205

206
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).
Mark Otto's avatar
Mark Otto committed
207

208
#### `.collapse('hide')`
Mark Otto's avatar
Mark Otto committed
209

210
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).
Mark Otto's avatar
Mark Otto committed
211

212
#### `.collapse('dispose')`
213
214
215

Destroys an element's collapse.

Mark Otto's avatar
Mark Otto committed
216
217
218
219
### Events

Bootstrap's collapse class exposes a few events for hooking into collapse functionality.

Mark Otto's avatar
Mark Otto committed
220
<table class="table table-bordered table-striped">
221
  <thead>
222
223
224
225
    <tr>
      <th style="width: 150px;">Event Type</th>
      <th>Description</th>
    </tr>
226
227
  </thead>
  <tbody>
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    <tr>
      <td>show.bs.collapse</td>
      <td>This event fires immediately when the <code>show</code> instance method is called.</td>
    </tr>
    <tr>
      <td>shown.bs.collapse</td>
      <td>This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).</td>
    </tr>
    <tr>
      <td>hide.bs.collapse</td>
      <td>This event is fired immediately when the <code>hide</code> method has been called.</td>
    </tr>
    <tr>
      <td>hidden.bs.collapse</td>
      <td>This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).</td>
    </tr>
244
245
  </tbody>
</table>
Mark Otto's avatar
Mark Otto committed
246

Mark Otto's avatar
Mark Otto committed
247
248
{% highlight js %}
$('#myCollapsible').on('hidden.bs.collapse', function () {
XhmikosR's avatar
XhmikosR committed
249
  // do something...
Mark Otto's avatar
Mark Otto committed
250
251
})
{% endhighlight %}