2014-07-12 11:20:15 +02:00
---
2015-08-15 07:45:55 +02:00
layout: docs
2014-07-12 11:20:15 +02:00
title: Carousel
2016-10-03 03:19:47 +02:00
description: A slideshow component for cycling through elements—images or slides of text—like a carousel.
2015-08-06 02:47:45 +02:00
group: components
2017-05-28 08:01:14 +02:00
toc: true
2014-07-12 11:20:15 +02:00
---
2017-05-28 08:01:14 +02:00
## How it works
2016-12-05 05:06:45 +01:00
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 ](https://www.w3.org/TR/page-visibility/ ) 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.).
2020-10-13 15:37:21 +02:00
{{< callout info > }}
2019-01-08 17:33:28 +01:00
{{< partial " callout-info-prefersreducedmotion . md " > }}
2020-10-13 15:37:21 +02:00
{{< / callout > }}
2018-11-03 19:23:26 +01:00
2016-12-05 05:37:21 +01:00
Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards.
2014-07-13 09:54:14 +02:00
2014-09-18 00:21:31 +02:00
## Example
2014-07-13 09:54:14 +02:00
2016-12-05 05:37:21 +01:00
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.
2016-12-05 05:07:01 +01:00
2021-01-27 16:31:16 +01:00
**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. Control and indicator elements must have a `data-bs-target` attribute (or `href` for links) that matches the `id` of the `.carousel` element.
2016-12-05 05:07:01 +01:00
### Slides only
2018-02-18 19:22:41 +01:00
Here's a carousel with slides only. Note the presence of the `.d-block` and `.w-100` on carousel images to prevent browser default image alignment.
2016-12-05 05:07:01 +01:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2020-07-22 21:33:11 +02:00
< div id = "carouselExampleSlidesOnly" class = "carousel slide" data-bs-ride = "carousel" >
2017-04-11 12:12:30 +02:00
< div class = "carousel-inner" >
2016-12-05 05:07:01 +01:00
< div class = "carousel-item active" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
2016-12-05 05:07:01 +01:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
2016-12-05 05:07:01 +01:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
2016-12-05 05:07:01 +01:00
< / div >
< / div >
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2016-12-05 05:07:01 +01:00
### With controls
2021-01-27 16:31:16 +01:00
Adding in the previous and next controls. We recommend using `<button>` elements, but you can also use `<a>` elements with `role="button"` .
2016-12-05 05:07:01 +01:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2020-07-22 21:33:11 +02:00
< div id = "carouselExampleControls" class = "carousel slide" data-bs-ride = "carousel" >
2017-04-11 12:12:30 +02:00
< div class = "carousel-inner" >
2016-12-05 05:07:01 +01:00
< div class = "carousel-item active" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
2016-12-05 05:07:01 +01:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
2016-12-05 05:07:01 +01:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
2016-12-05 05:07:01 +01:00
< / div >
< / div >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleControls" data-bs-slide = "prev" >
2016-12-05 07:05:16 +01:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleControls" data-bs-slide = "next" >
2016-12-05 07:05:16 +01:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2016-12-05 05:07:01 +01:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2016-12-05 05:07:01 +01:00
### With indicators
You can also add the indicators to the carousel, alongside the controls, too.
2016-10-27 18:19:07 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2022-04-21 21:42:17 +02:00
< div id = "carouselExampleIndicators" class = "carousel slide" data-bs-ride = "true" >
2021-01-03 12:06:58 +01:00
< div class = "carousel-indicators" >
< button type = "button" data-bs-target = "#carouselExampleIndicators" data-bs-slide-to = "0" class = "active" aria-current = "true" aria-label = "Slide 1" > < / button >
< button type = "button" data-bs-target = "#carouselExampleIndicators" data-bs-slide-to = "1" aria-label = "Slide 2" > < / button >
< button type = "button" data-bs-target = "#carouselExampleIndicators" data-bs-slide-to = "2" aria-label = "Slide 3" > < / button >
< / div >
2017-04-11 12:12:30 +02:00
< div class = "carousel-inner" >
2014-12-18 03:30:16 +01:00
< div class = "carousel-item active" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
2014-03-17 03:03:53 +01:00
< / div >
2014-12-18 03:30:16 +01:00
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
2014-07-13 09:54:14 +02:00
< / div >
2014-12-18 03:30:16 +01:00
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
2014-04-01 22:03:14 +02:00
< / div >
2014-03-17 03:03:53 +01:00
< / div >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleIndicators" data-bs-slide = "prev" >
2016-12-05 07:05:16 +01:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleIndicators" data-bs-slide = "next" >
2016-12-05 07:05:16 +01:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2014-03-17 03:03:53 +01:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2014-03-17 03:03:53 +01:00
2016-12-05 05:37:21 +01:00
### With captions
2014-07-13 09:54:14 +02:00
2019-02-04 11:22:02 +01:00
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 ]({{< docsref "/utilities/display" >}} ). We hide them initially with `.d-none` and bring them back on medium-sized devices with `.d-md-block` .
2014-07-13 09:54:14 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2022-04-21 21:42:17 +02:00
< div id = "carouselExampleCaptions" class = "carousel slide" data-bs-ride = "false" >
2021-01-03 12:06:58 +01:00
< div class = "carousel-indicators" >
< button type = "button" data-bs-target = "#carouselExampleCaptions" data-bs-slide-to = "0" class = "active" aria-current = "true" aria-label = "Slide 1" > < / button >
< button type = "button" data-bs-target = "#carouselExampleCaptions" data-bs-slide-to = "1" aria-label = "Slide 2" > < / button >
< button type = "button" data-bs-target = "#carouselExampleCaptions" data-bs-slide-to = "2" aria-label = "Slide 3" > < / button >
< / div >
2019-08-30 16:21:47 +02:00
< div class = "carousel-inner" >
< div class = "carousel-item active" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
< div class = "carousel-caption d-none d-md-block" >
< h5 > First slide label< / h5 >
2020-12-11 21:05:33 +01:00
< p > Some representative placeholder content for the first slide.< / p >
2014-07-13 09:54:14 +02:00
< / div >
2019-08-30 16:21:47 +02:00
< / div >
< div class = "carousel-item" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
< div class = "carousel-caption d-none d-md-block" >
< h5 > Second slide label< / h5 >
2020-12-11 21:05:33 +01:00
< p > Some representative placeholder content for the second slide.< / p >
2014-07-13 09:54:14 +02:00
< / div >
2019-08-30 16:21:47 +02:00
< / div >
< div class = "carousel-item" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
< div class = "carousel-caption d-none d-md-block" >
< h5 > Third slide label< / h5 >
2020-12-11 21:05:33 +01:00
< p > Some representative placeholder content for the third slide.< / p >
2014-03-17 03:03:53 +01:00
< / div >
< / div >
2014-07-13 09:54:14 +02:00
< / div >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleCaptions" data-bs-slide = "prev" >
2019-08-30 16:21:47 +02:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleCaptions" data-bs-slide = "next" >
2019-08-30 16:21:47 +02:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2014-07-13 09:54:14 +02:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2014-03-17 03:03:53 +01:00
2018-01-22 07:51:08 +01:00
### Crossfade
2021-12-23 13:38:43 +01:00
Add `.carousel-fade` to your carousel to animate slides with a fade transition instead of a slide. Depending on your carousel content (e.g., text only slides), you may want to add `.bg-body` or some custom CSS to the `.carousel-item` s for proper crossfading.
2018-01-22 07:51:08 +01:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2020-07-22 21:33:11 +02:00
< div id = "carouselExampleFade" class = "carousel slide carousel-fade" data-bs-ride = "carousel" >
2018-01-22 07:51:08 +01:00
< div class = "carousel-inner" >
< div class = "carousel-item active" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
2018-01-22 07:51:08 +01:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
2018-01-22 07:51:08 +01:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
2018-01-22 07:51:08 +01:00
< / div >
< / div >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleFade" data-bs-slide = "prev" >
2018-01-22 07:51:08 +01:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleFade" data-bs-slide = "next" >
2018-01-22 07:51:08 +01:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2018-01-22 07:51:08 +01:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2018-09-18 14:55:48 +02:00
### Individual `.carousel-item` interval
2020-07-22 21:33:11 +02:00
Add `data-bs-interval=""` to a `.carousel-item` to change the amount of time to delay between automatically cycling to the next item.
2018-09-18 14:55:48 +02:00
2019-01-08 17:33:28 +01:00
{{< example > }}
2020-07-22 21:33:11 +02:00
< div id = "carouselExampleInterval" class = "carousel slide" data-bs-ride = "carousel" >
2018-09-18 14:55:48 +02:00
< div class = "carousel-inner" >
2020-07-22 21:33:11 +02:00
< div class = "carousel-item active" data-bs-interval = "10000" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
2018-09-18 14:55:48 +02:00
< / div >
2020-07-22 21:33:11 +02:00
< div class = "carousel-item" data-bs-interval = "2000" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
2018-09-18 14:55:48 +02:00
< / div >
< div class = "carousel-item" >
2019-01-08 17:33:28 +01:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
2018-09-18 14:55:48 +02:00
< / div >
< / div >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleInterval" data-bs-slide = "prev" >
2018-09-18 14:55:48 +02:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleInterval" data-bs-slide = "next" >
2018-09-18 14:55:48 +02:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
2020-07-03 13:38:11 +02:00
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2018-09-18 14:55:48 +02:00
< / div >
2019-01-08 17:33:28 +01:00
{{< / example > }}
2018-01-22 07:51:08 +01:00
2021-01-06 01:59:44 +01:00
### Disable touch swiping
2020-12-29 14:40:42 +01:00
2021-01-06 01:59:44 +01:00
Carousels support swiping left/right on touchscreen devices to move between slides. This can be disabled using the `data-bs-touch` attribute. The example below also does not include the `data-bs-ride` attribute and has `data-bs-interval="false"` so it doesn't autoplay.
2020-12-29 14:40:42 +01:00
{{< example > }}
< div id = "carouselExampleControlsNoTouching" class = "carousel slide" data-bs-touch = "false" data-bs-interval = "false" >
< div class = "carousel-inner" >
< div class = "carousel-item active" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#555" background = "#777" text = "First slide" > }}
< / div >
< div class = "carousel-item" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#444" background = "#666" text = "Second slide" > }}
< / div >
< div class = "carousel-item" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#333" background = "#555" text = "Third slide" > }}
< / div >
< / div >
2021-01-27 16:31:16 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleControlsNoTouching" data-bs-slide = "prev" >
2020-12-29 14:40:42 +01:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleControlsNoTouching" data-bs-slide = "next" >
2020-12-29 14:40:42 +01:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2020-12-29 14:40:42 +01:00
< / div >
{{< / example > }}
2020-09-24 22:16:20 +02:00
## Dark variant
Add `.carousel-dark` to the `.carousel` for darker controls, indicators, and captions. Controls have been inverted from their default white fill with the `filter` CSS property. Captions and controls have additional Sass variables that customize the `color` and `background-color` .
{{< example > }}
2020-11-06 16:21:57 +01:00
< div id = "carouselExampleDark" class = "carousel carousel-dark slide" data-bs-ride = "carousel" >
2021-01-03 12:06:58 +01:00
< div class = "carousel-indicators" >
< button type = "button" data-bs-target = "#carouselExampleDark" data-bs-slide-to = "0" class = "active" aria-current = "true" aria-label = "Slide 1" > < / button >
< button type = "button" data-bs-target = "#carouselExampleDark" data-bs-slide-to = "1" aria-label = "Slide 2" > < / button >
< button type = "button" data-bs-target = "#carouselExampleDark" data-bs-slide-to = "2" aria-label = "Slide 3" > < / button >
< / div >
2020-09-24 22:16:20 +02:00
< div class = "carousel-inner" >
2020-11-06 16:21:57 +01:00
< div class = "carousel-item active" data-bs-interval = "10000" >
2020-09-24 22:16:20 +02:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#aaa" background = "#f5f5f5" text = "First slide" > }}
< div class = "carousel-caption d-none d-md-block" >
< h5 > First slide label< / h5 >
2020-12-11 21:05:33 +01:00
< p > Some representative placeholder content for the first slide.< / p >
2020-09-24 22:16:20 +02:00
< / div >
< / div >
2020-11-06 16:21:57 +01:00
< div class = "carousel-item" data-bs-interval = "2000" >
2020-09-24 22:16:20 +02:00
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#bbb" background = "#eee" text = "Second slide" > }}
< div class = "carousel-caption d-none d-md-block" >
< h5 > Second slide label< / h5 >
2020-12-11 21:05:33 +01:00
< p > Some representative placeholder content for the second slide.< / p >
2020-09-24 22:16:20 +02:00
< / div >
< / div >
< div class = "carousel-item" >
{{< placeholder width = "800" height = "400" class = "bd-placeholder-img-lg d-block w-100" color = "#999" background = "#e5e5e5" text = "Third slide" > }}
< div class = "carousel-caption d-none d-md-block" >
< h5 > Third slide label< / h5 >
2020-12-11 21:05:33 +01:00
< p > Some representative placeholder content for the third slide.< / p >
2020-09-24 22:16:20 +02:00
< / div >
< / div >
< / div >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-prev" type = "button" data-bs-target = "#carouselExampleDark" data-bs-slide = "prev" >
2020-09-24 22:16:20 +02:00
< span class = "carousel-control-prev-icon" aria-hidden = "true" > < / span >
< span class = "visually-hidden" > Previous< / span >
2021-01-27 16:31:16 +01:00
< / button >
2021-02-11 18:48:08 +01:00
< button class = "carousel-control-next" type = "button" data-bs-target = "#carouselExampleDark" data-bs-slide = "next" >
2020-09-24 22:16:20 +02:00
< span class = "carousel-control-next-icon" aria-hidden = "true" > < / span >
< span class = "visually-hidden" > Next< / span >
2021-01-27 16:31:16 +01:00
< / button >
2020-09-24 22:16:20 +02:00
< / div >
{{< / example > }}
2018-01-22 07:51:08 +01:00
2021-02-11 04:29:59 +01:00
## Custom transition
The transition duration of `.carousel-item` can be changed with the `$carousel-transition-duration` Sass variable before compiling or custom styles if you're using the compiled CSS. If multiple transitions are applied, make sure the transform transition is defined first (eg. `transition: transform 2s ease, opacity .5s ease-out` ).
## Sass
### Variables
{{< scss-docs name = "carousel-variables" file = "scss/_variables.scss" > }}
2014-07-13 09:54:14 +02:00
## Usage
### Via data attributes
2014-03-17 03:03:53 +01:00
2020-07-22 21:33:11 +02:00
Use data attributes to easily control the position of the carousel. `data-bs-slide` accepts the keywords `prev` or `next` , which alters the slide position relative to its current position. Alternatively, use `data-bs-slide-to` to pass a raw slide index to the carousel `data-bs-slide-to="2"` , which shifts the slide position to a particular index beginning with `0` .
2014-07-13 09:54:14 +02:00
2020-07-22 21:33:11 +02:00
The `data-bs-ride="carousel"` attribute is used to mark a carousel as animating starting at page load. If you don't use `data-bs-ride="carousel"` to initialize your carousel, you have to initialize it yourself. **It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.**
2014-07-13 09:54:14 +02:00
### Via JavaScript
Call carousel manually with:
2014-03-17 03:03:53 +01:00
2020-10-19 11:56:49 +02:00
```js
2022-04-26 18:38:41 +02:00
const carousel = new bootstrap.Carousel('#myCarousel')
2020-10-19 11:56:49 +02:00
```
2014-03-17 03:03:53 +01:00
2014-07-13 09:54:14 +02:00
### Options
2022-04-21 20:41:43 +02:00
{{< markdown > }}
{{< partial " js-data-attributes . md " > }}
{{< / markdown > }}
2014-07-13 09:54:14 +02:00
2022-03-14 08:38:04 +01:00
{{< bs-table > }}
| 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 `"hover"` , pauses the cycling of the carousel on `mouseenter` and resumes the cycling of the carousel on `mouseleave` . If set to `false` , hovering over the carousel won't pause it. On touch-enabled devices, when set to `"hover"` , cycling will pause on `touchend` (once the user finished interacting with the carousel) for two intervals, before automatically resuming. This is in addition to the mouse behavior. |
2022-04-21 21:42:17 +02:00
| `ride` | string, boolean | `false` | If set to `true` , autoplays the carousel after the user manually cycles the first item. If set to `"carousel"` , autoplays the carousel on load. |
2022-03-14 08:38:04 +01:00
| `touch` | boolean | `true` | Whether the carousel should support left/right swipe interactions on touchscreen devices. |
2022-04-21 21:42:17 +02:00
| `wrap` | boolean | `true` | Whether the carousel should cycle continuously or have hard stops. |
2022-03-14 08:38:04 +01:00
{{< / bs-table > }}
2014-07-13 09:54:14 +02:00
### Methods
2020-10-13 15:37:21 +02:00
{{< callout danger > }}
2019-01-08 17:33:28 +01:00
{{< partial " callout-danger-async-methods . md " > }}
2020-10-13 15:37:21 +02:00
{{< / callout > }}
2017-03-28 23:43:16 +02:00
2018-09-15 13:44:23 +02:00
You can create a carousel instance with the carousel constructor, for example, to initialize with additional options and start cycling through items:
2014-07-13 09:54:14 +02:00
2020-10-19 11:56:49 +02:00
```js
2022-04-26 18:38:41 +02:00
const myCarouselElement = document.querySelector('#myCarousel')
const carousel = new bootstrap.Carousel(myCarouselElement, {
2018-09-15 13:44:23 +02:00
interval: 2000,
wrap: false
2014-03-17 03:03:53 +01:00
})
2020-10-19 11:56:49 +02:00
```
2014-03-17 03:03:53 +01:00
2022-03-14 08:38:04 +01:00
{{< bs-table > }}
| Method | Description |
| --- | --- |
| `cycle` | Cycles through the carousel items from left to right. |
| `dispose` | Destroys an element's carousel. (Removes stored data on the DOM element) |
| `getInstance` | Static method which allows you to get the carousel instance associated to a DOM element, you can use it like this: `bootstrap.Carousel.getInstance(element)` |
| `getOrCreateInstance` | Static method which returns a carousel instance associated to a DOM element or create a new one in case it wasn't initialized. You can use it like this: `bootstrap.Carousel.getOrCreateInstance(element)` |
2022-05-20 19:21:48 +02:00
| `next` | Cycles to the next item. **Returns to the caller before the next item has been shown** (e.g., before the `slid.bs.carousel` event occurs). |
| `nextWhenVisible` | Don't cycle carousel to next when the page isn't visible or the carousel or its parent isn't visible. **Returns to the caller before the target item has been shown** |
| `pause` | Stops the carousel from cycling through items. |
| `prev` | Cycles to the previous item. **Returns to the caller before the previous item has been shown** (e.g., before the `slid.bs.carousel` event occurs). |
| `to` | Cycles the carousel to a particular frame (0 based, similar to an array). **Returns to the caller before the target item has been shown** (e.g., before the `slid.bs.carousel` event occurs). |
2022-03-14 08:38:04 +01:00
{{< / bs-table > }}
2017-10-16 16:51:42 +02:00
2014-07-13 09:54:14 +02:00
### 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.
2017-03-22 22:42:13 +01:00
- `from` : The index of the current item
- `to` : The index of the next item
2014-07-13 09:54:14 +02:00
2015-03-01 22:44:10 +01:00
All carousel events are fired at the carousel itself (i.e. at the `<div class="carousel">` ).
2014-07-13 09:54:14 +02:00
2022-03-14 08:38:04 +01:00
{{< bs-table > }}
| Event type | Description |
| --- | --- |
| `slid.bs.carousel` | Fired when the carousel has completed its slide transition. |
2022-05-20 19:21:48 +02:00
| `slide.bs.carousel` | Fires immediately when the `slide` instance method is invoked. |
2022-03-14 08:38:04 +01:00
{{< / bs-table > }}
2014-07-13 09:54:14 +02:00
2020-10-19 11:56:49 +02:00
```js
2022-04-26 18:38:41 +02:00
const myCarousel = document.getElementById('myCarousel')
2019-05-14 11:43:12 +02:00
2022-04-26 18:38:41 +02:00
myCarousel.addEventListener('slide.bs.carousel', event => {
2019-02-10 21:25:51 +01:00
// do something...
2014-03-17 03:03:53 +01:00
})
2020-10-19 11:56:49 +02:00
```