mirror of
https://github.com/twbs/bootstrap.git
synced 2024-12-14 02:24:00 +01:00
244 lines
11 KiB
Markdown
244 lines
11 KiB
Markdown
---
|
||
layout: docs
|
||
title: Collapse
|
||
description: Toggle the visibility of content across your project with a few classes and our JavaScript plugins.
|
||
group: components
|
||
---
|
||
|
||
The Bootstrap collapse plugin allows you to toggle content on your pages with a few classes thanks to some helpful JavaScript.
|
||
|
||
## Contents
|
||
|
||
* Will be replaced with the ToC, excluding the "Contents" header
|
||
{:toc}
|
||
|
||
## 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.
|
||
|
||
{% example html %}
|
||
<p>
|
||
<a class="btn btn-primary" data-toggle="collapse" href="#collapseExample" 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-block">
|
||
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>
|
||
{% endexample %}
|
||
|
||
## Accordion example
|
||
|
||
Using the [card]({{ site.baseurl }}/components/card/) component, you can extend the default collapse behavior to create an accordion.
|
||
|
||
{% example html %}
|
||
<div id="accordion" role="tablist">
|
||
<div class="card">
|
||
<div class="card-header" role="tab" id="headingOne">
|
||
<h5 class="mb-0">
|
||
<a data-toggle="collapse" href="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
|
||
Collapsible Group Item #1
|
||
</a>
|
||
</h5>
|
||
</div>
|
||
|
||
<div id="collapseOne" class="collapse show" role="tabpanel" aria-labelledby="headingOne" data-parent="#accordion">
|
||
<div class="card-block">
|
||
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" role="tab" id="headingTwo">
|
||
<h5 class="mb-0">
|
||
<a class="collapsed" data-toggle="collapse" href="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
|
||
Collapsible Group Item #2
|
||
</a>
|
||
</h5>
|
||
</div>
|
||
<div id="collapseTwo" class="collapse" role="tabpanel" aria-labelledby="headingTwo" data-parent="#accordion">
|
||
<div class="card-block">
|
||
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" role="tab" id="headingThree">
|
||
<h5 class="mb-0">
|
||
<a class="collapsed" data-toggle="collapse" href="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
|
||
Collapsible Group Item #3
|
||
</a>
|
||
</h5>
|
||
</div>
|
||
<div id="collapseThree" class="collapse" role="tabpanel" aria-labelledby="headingThree" data-parent="#accordion">
|
||
<div class="card-block">
|
||
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>
|
||
{% endexample %}
|
||
|
||
You can also create accordions with custom markup. Add the `data-children` attribute and specify a set of sibling elements to toggle (e.g., `.item`). Then, use the same attributes and classes as shown above for connectinh toggles to their associated content.
|
||
|
||
{% example html %}
|
||
<div id="exampleAccordion" data-children=".item">
|
||
<div class="item">
|
||
<a data-toggle="collapse" data-parent="#exampleAccordion" href="#exampleAccordion1" aria-expanded="true" aria-controls="exampleAccordion1">
|
||
Toggle item
|
||
</a>
|
||
<div id="exampleAccordion1" class="collapse show" role="tabpanel">
|
||
<p class="mb-3">
|
||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed pretium lorem non vestibulum scelerisque. Proin a vestibulum sem, eget tristique massa. Aliquam lacinia rhoncus nibh quis ornare.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="item">
|
||
<a data-toggle="collapse" data-parent="#exampleAccordion" href="#exampleAccordion2" aria-expanded="false" aria-controls="exampleAccordion2">
|
||
Toggle item 2
|
||
</a>
|
||
<div id="exampleAccordion2" class="collapse" role="tabpanel">
|
||
<p class="mb-3">
|
||
Donec at ipsum dignissim, rutrum turpis scelerisque, tristique lectus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vivamus nec dui turpis. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
{% endexample %}
|
||
|
||
## Accessibility
|
||
|
||
Be sure to add `aria-expanded` to the control element. This attribute explicitly defines the current state of the collapsible element to screen readers and similar assistive technologies. If the collapsible element is closed by default, it 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 based on whether or not the collapsible element has been opened or closed.
|
||
|
||
Additionally, if your control element is targeting a single collapsible element – i.e. the `data-target` attribute is pointing to an `id` selector – you may add an additional `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.
|
||
|
||
## 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 a collapsible element. 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:
|
||
|
||
{% highlight js %}
|
||
$('.collapse').collapse()
|
||
{% endhighlight %}
|
||
|
||
### Options
|
||
|
||
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, as in `data-parent=""`.
|
||
|
||
<table class="table table-bordered table-striped table-responsive">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 100px;">Name</th>
|
||
<th style="width: 50px;">Type</th>
|
||
<th style="width: 50px;">Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>parent</td>
|
||
<td>selector</td>
|
||
<td>false</td>
|
||
<td>If a selector 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>
|
||
</tr>
|
||
<tr>
|
||
<td>toggle</td>
|
||
<td>boolean</td>
|
||
<td>true</td>
|
||
<td>Toggles the collapsible element on invocation</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
### Methods
|
||
|
||
{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
|
||
{{ callout-include | markdownify }}
|
||
|
||
#### `.collapse(options)`
|
||
|
||
Activates your content as a collapsible element. Accepts an optional options `object`.
|
||
|
||
{% highlight js %}
|
||
$('#myCollapsible').collapse({
|
||
toggle: false
|
||
})
|
||
{% endhighlight %}
|
||
|
||
#### `.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).
|
||
|
||
### Events
|
||
|
||
Bootstrap's collapse class exposes a few events for hooking into collapse functionality.
|
||
|
||
<table class="table table-bordered table-striped table-responsive">
|
||
<thead>
|
||
<tr>
|
||
<th style="width: 150px;">Event Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<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>
|
||
</tbody>
|
||
</table>
|
||
|
||
{% highlight js %}
|
||
$('#myCollapsible').on('hidden.bs.collapse', function () {
|
||
// do something…
|
||
})
|
||
{% endhighlight %}
|