Stripped personal data from development repository
view | history | commit | commitdiff
Samo Penic
2019-02-20 83c3f647c35477564b77cbc5b36d37d793d5442a
commit | author | age
83c3f6 1 ---
SP 2 layout: docs
3 title: Collapse
4 description: Toggle the visibility of content across your project with a few classes and our JavaScript plugins.
5 group: components
6 toc: true
7 ---
8
9 ## How it works
10
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 {% include callout-info-prefersreducedmotion.md %}
14
15 ## Example
16
17 Click the buttons below to show and hide another element via class changes:
18
19 - `.collapse` hides content
20 - `.collapsing` is applied during transitions
21 - `.collapse.show` shows content
22
23 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.
24
25 {% capture example %}
26 <p>
27   <a class="btn btn-primary" data-toggle="collapse" href="#collapseExample" role="button" aria-expanded="false" aria-controls="collapseExample">
28     Link with href
29   </a>
30   <button class="btn btn-primary" type="button" data-toggle="collapse" data-target="#collapseExample" aria-expanded="false" aria-controls="collapseExample">
31     Button with data-target
32   </button>
33 </p>
34 <div class="collapse" id="collapseExample">
35   <div class="card card-body">
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.
37   </div>
38 </div>
39 {% endcapture %}
40 {% include example.html content=example %}
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.
45 Multiple `<button>` or `<a>` can show and hide an element if they each reference it with their `href` or `data-target` attribute
46
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>
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   <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>
52 </p>
53 <div class="row">
54   <div class="col">
55     <div class="collapse multi-collapse" id="multiCollapseExample1">
56       <div class="card card-body">
57         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.
58       </div>
59     </div>
60   </div>
61   <div class="col">
62     <div class="collapse multi-collapse" id="multiCollapseExample2">
63       <div class="card card-body">
64         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.
65       </div>
66     </div>
67   </div>
68 </div>
69 {% endcapture %}
70 {% include example.html content=example %}
71
72 ## Accordion example
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.
75
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">
82           Collapsible Group Item #1
83         </button>
84       </h2>
85     </div>
86
87     <div id="collapseOne" class="collapse show" aria-labelledby="headingOne" data-parent="#accordionExample">
88       <div class="card-body">
89         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.
90       </div>
91     </div>
92   </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">
97           Collapsible Group Item #2
98         </button>
99       </h2>
100     </div>
101     <div id="collapseTwo" class="collapse" aria-labelledby="headingTwo" data-parent="#accordionExample">
102       <div class="card-body">
103         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.
104       </div>
105     </div>
106   </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">
111           Collapsible Group Item #3
112         </button>
113       </h2>
114     </div>
115     <div id="collapseThree" class="collapse" aria-labelledby="headingThree" data-parent="#accordionExample">
116       <div class="card-body">
117         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.
118       </div>
119     </div>
120   </div>
121 </div>
122 {% endcapture %}
123 {% include example.html content=example %}
124
125 ## Accessibility
126
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 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.
130
131 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.
132
133 ## Usage
134
135 The collapse plugin utilizes a few classes to handle the heavy lifting:
136
137 - `.collapse` hides the content
138 - `.collapse.show` shows the content
139 - `.collapsing` is added when the transition starts, and removed when it finishes
140
141 These classes can be found in `_transitions.scss`.
142
143 ### Via data attributes
144
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`.
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.
148
149 ### Via JavaScript
150
151 Enable manually with:
152
153 {% highlight js %}
154 $('.collapse').collapse()
155 {% endhighlight %}
156
157 ### Options
158
159 Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-parent=""`.
160
161 <table class="table table-bordered table-striped">
162   <thead>
163     <tr>
164       <th style="width: 100px;">Name</th>
165       <th style="width: 50px;">Type</th>
166       <th style="width: 50px;">Default</th>
167       <th>Description</th>
168     </tr>
169   </thead>
170   <tbody>
171     <tr>
172       <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     </tr>
177     <tr>
178       <td>toggle</td>
179       <td>boolean</td>
180       <td>true</td>
181       <td>Toggles the collapsible element on invocation</td>
182     </tr>
183   </tbody>
184 </table>
185
186 ### Methods
187
188 {% include callout-danger-async-methods.md %}
189
190 #### `.collapse(options)`
191
192 Activates your content as a collapsible element. Accepts an optional options `object`.
193
194 {% highlight js %}
195 $('#myCollapsible').collapse({
196   toggle: false
197 })
198 {% endhighlight %}
199
200 #### `.collapse('toggle')`
201
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).
203
204 #### `.collapse('show')`
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).
207
208 #### `.collapse('hide')`
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).
211
212 #### `.collapse('dispose')`
213
214 Destroys an element's collapse.
215
216 ### Events
217
218 Bootstrap's collapse class exposes a few events for hooking into collapse functionality.
219
220 <table class="table table-bordered table-striped">
221   <thead>
222     <tr>
223       <th style="width: 150px;">Event Type</th>
224       <th>Description</th>
225     </tr>
226   </thead>
227   <tbody>
228     <tr>
229       <td>show.bs.collapse</td>
230       <td>This event fires immediately when the <code>show</code> instance method is called.</td>
231     </tr>
232     <tr>
233       <td>shown.bs.collapse</td>
234       <td>This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).</td>
235     </tr>
236     <tr>
237       <td>hide.bs.collapse</td>
238       <td>This event is fired immediately when the <code>hide</code> method has been called.</td>
239     </tr>
240     <tr>
241       <td>hidden.bs.collapse</td>
242       <td>This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).</td>
243     </tr>
244   </tbody>
245 </table>
246
247 {% highlight js %}
248 $('#myCollapsible').on('hidden.bs.collapse', function () {
249   // do something…
250 })
251 {% endhighlight %}