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 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.
The animation effect of this component is dependent on the user’s prefers-reduced-motion setting. See the reduced motion section of our accessibility documentation.
Collapse 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.
Accordion example
This accordion has icons that denote when it is opened or closed. They also have a maximum width of 800px.
Important: The entire row should be actionable. If a user clicks on the plus icon, the text, or even the area around the question, the hidden section should expand with simultaneously the plus + icon should become a minus – symbol in its place.
(Note: approximately 73 pixel width Rows/space between rules should remain consistent for most use cases.)
This custom accordion has two states. data-type="multiple" will allow a user to open any of the sections and they will remain open. data-type="single" will only allow one section open at a time.
Single
<div class="accordion-icons accordion-container" data-type="single">
<div>
<button id="accordion-single-example-btn-1" class="btn accordion-icons-btn" type="button" aria-expanded="false" aria-controls="accordion-single-example-expand-1">
<i class="fal fa-plus"></i>
<span>Title 1</span>
</button>
<div id="accordion-single-example-expand-1" class="accordion-icons-btn-expand" aria-labelledby="accordion-single-example-btn-1">
<p>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.</p>
</div><!-- end expand -->
</div><!-- end accordion -->
<div>
<button id="accordion-single-example-btn-2" class="btn accordion-icons-btn" type="button" aria-expanded="false" aria-controls="accordion-single-example-expand-2">
<i class="fal fa-plus"></i>
<span>Title 1</span>
</button>
<div id="accordion-single-example-expand-2" class="accordion-icons-btn-expand" aria-labelledby="accordion-single-example-btn-2">
<p>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.</p>
</div><!-- end expand -->
</div><!-- end accordion -->
<div>
<button id="accordion-single-example-btn-3" class="btn accordion-icons-btn" type="button" aria-expanded="false" aria-controls="accordion-single-example-expand-3">
<i class="fal fa-plus"></i>
<span>Title 1</span>
</button>
<div id="accordion-single-example-expand-3" class="accordion-icons-btn-expand" aria-labelledby="accordion-single-example-btn-3">
<p>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.</p>
</div><!-- end expand -->
</div><!-- end accordion -->
</div><!-- end accordion container -->Multiple
<div class="accordion-icons accordion-container" data-type="multiple">
<div>
<button id="accordion-multiple-example-btn-1" class="btn accordion-icons-btn" type="button" aria-expanded="false" aria-controls="accordion-multiple-example-expand-1">
<i class="fal fa-plus"></i>
<span>Title 1</span>
</button>
<div id="accordion-multiple-example-expand-1" class="accordion-icons-btn-expand" aria-labelledby="accordion-multiple-example-btn-1">
<p>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.</p>
</div><!-- end expand -->
</div><!-- end accordion -->
<div>
<button id="accordion-multiple-example-btn-2" class="btn accordion-icons-btn" type="button" aria-expanded="false" aria-controls="accordion-multiple-example-expand-2">
<i class="fal fa-plus"></i>
<span>Title 1</span>
</button>
<div id="accordion-multiple-example-expand-2" class="accordion-icons-btn-expand" aria-labelledby="accordion-multiple-example-btn-2">
<p>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.</p>
</div><!-- end expand -->
</div><!-- end accordion -->
<div>
<button id="accordion-multiple-example-btn-3" class="btn accordion-icons-btn" type="button" aria-expanded="false" aria-controls="accordion-multiple-example-expand-3">
<i class="fal fa-plus"></i>
<span>Title 1</span>
</button>
<div id="accordion-multiple-example-expand-3" class="accordion-icons-btn-expand" aria-labelledby="accordion-multiple-example-btn-3">
<p>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.</p>
</div><!-- end expand -->
</div><!-- end accordion -->
</div><!-- end accordion container -->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.
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:
$('.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 |
|---|---|---|---|
| parent | selector | jQuery object | DOM element | false | 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 card class). The attribute has to be set on 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.
`.collapse(options)`
Activates your content as a collapsible element. Accepts an optional options `object`.
$('#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
Cirrus'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). |
$('#myCollapsible').on('hidden.bs.collapse', function () {
// do something...
})