13 KiB
Executable File
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Carousel | A slideshow component for cycling through elements—images or slides of text—like a carousel. | bootstrap-components | true |
How it works
The carousel is a slideshow for cycling through a series of content, built with CSS 3D transforms and a bit of JavaScript. It works with a series of images, text, or custom markup. It also includes support for previous/next controls and indicators.
In browsers where the Page Visibility API is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.).
Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards.
Lastly, if you're building our JavaScript from source, it [requires util.js]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/javascript/#util).
Example
Carousels don't automatically normalize slide dimensions. As such, you may need to use additional utilities or custom styles to appropriately size content. While carousels support previous/next controls and indicators, they're not explicitly required. Add and customize as you see fit.
The .active class needs to be added to one of the slides otherwise the carousel will not be visible. Also be sure to set a unique id on the .carousel for optional controls, especially if you're using multiple carousels on a single page.
Slides only
Here's a carousel with slides only. Note the presence of the .d-block and .img-fluid on carousel images to prevent browser default image alignment.
{% example html %}
With controls
Adding in the previous and next controls:
{% example html %}
{% endexample %}With indicators
You can also add the indicators to the carousel, alongside the controls, too.
{% example html %}
{% endexample %}With captions
Add captions to your slides easily with the .carousel-caption element within any .carousel-item. They can be easily hidden on smaller viewports, as shown below, with optional [display utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/display/). We hide them initially with .d-none and bring them back on medium-sized devices with .d-md-block.
{% highlight html %}
...
...
Crossfade
Add .carousel-fade to your carousel to animate slides with a fade transition instead of a slide.
{% example html %}
{% endexample %}Usage
Via data attributes
Use data attributes to easily control the position of the carousel. data-slide accepts the keywords prev or next, which alters the slide position relative to its current position. Alternatively, use data-slide-to to pass a raw slide index to the carousel data-slide-to="2", which shifts the slide position to a particular index beginning with 0.
The data-ride="carousel" attribute is used to mark a carousel as animating starting at page load. It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.
Via JavaScript
Call carousel manually with:
{% highlight js %} $('.carousel').carousel() {% endhighlight %}
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-interval="".
| Name | Type | Default | Description |
|---|---|---|---|
| interval | number | 5000 | The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle. |
| keyboard | boolean | true | Whether the carousel should react to keyboard events. |
| pause | string | boolean | "hover" | If set to On touch-enabled devices, when set to |
| ride | string | false | Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load. |
| wrap | boolean | true | Whether the carousel should cycle continuously or have hard stops. |
Methods
{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} {{ callout-include | markdownify }}
.carousel(options)
Initializes the carousel with an optional options object and starts cycling through items.
{% highlight js %} $('.carousel').carousel({ interval: 2000 }) {% endhighlight %}
.carousel('cycle')
Cycles through the carousel items from left to right.
.carousel('pause')
Stops the carousel from cycling through items.
.carousel(number)
Cycles the carousel to a particular frame (0 based, similar to an array). Returns to the caller before the target item has been shown (i.e. before the slid.bs.carousel event occurs).
.carousel('prev')
Cycles to the previous item. Returns to the caller before the previous item has been shown (i.e. before the slid.bs.carousel event occurs).
.carousel('next')
Cycles to the next item. Returns to the caller before the next item has been shown (i.e. before the slid.bs.carousel event occurs).
.carousel('dispose')
Destroys an element's carousel.
Events
Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:
direction: The direction in which the carousel is sliding (either"left"or"right").relatedTarget: The DOM element that is being slid into place as the active item.from: The index of the current itemto: The index of the next item
All carousel events are fired at the carousel itself (i.e. at the <div class="carousel">).
| Event Type | Description |
|---|---|
| slide.bs.carousel | This event fires immediately when the slide instance method is invoked. |
| slid.bs.carousel | This event is fired when the carousel has completed its slide transition. |
{% highlight js %} $('#myCarousel').on('slide.bs.carousel', function () { // do something… }) {% endhighlight %}