--- layout: docs title: Carousel description: A slideshow component for cycling through elements—images or slides of text—like a carousel. group: components toc: 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](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.). {{< callout info >}} {{< partial "callouts/info-prefersreducedmotion.md" >}} {{< /callout >}} Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards. ## 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. Control and indicator elements must have a `data-bs-target` attribute (or `href` for links) that matches the `id` of the `.carousel` element. ### Slides only 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. {{< example >}} {{< /example >}} ### With controls Adding in the previous and next controls. We recommend using ` {{< /example >}} ### With indicators You can also add the indicators to the carousel, alongside the controls, too. {{< example >}} {{< /example >}} ### 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]({{< docsref "/utilities/display" >}}). We hide them initially with `.d-none` and bring them back on medium-sized devices with `.d-md-block`. {{< example >}} {{< /example >}} ### Crossfade 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. {{< example >}} {{< /example >}} ### Individual `.carousel-item` interval Add `data-bs-interval=""` to a `.carousel-item` to change the amount of time to delay between automatically cycling to the next item. {{< example >}} {{< /example >}} ### Disable touch swiping 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 so it doesn't autoplay. {{< example >}} {{< /example >}} ## 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 >}} {{< /example >}} ## 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 (e.g. `transition: transform 2s ease, opacity .5s ease-out`). ## Sass ### Variables Variables for all carousels: {{< scss-docs name="carousel-variables" file="scss/_variables.scss" >}} Variables for the [dark carousel](#dark-variant): {{< scss-docs name="carousel-dark-variables" file="scss/_variables.scss" >}} ## Usage ### Via data attributes 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`. 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.** ### Via JavaScript Call carousel manually with: ```js const carousel = new bootstrap.Carousel('#myCarousel') ``` ### Options {{< markdown >}} {{< partial "js-data-attributes.md" >}} {{< /markdown >}} {{< bs-table >}} | Name | Type | Default | Description | | --- | --- | --- | --- | | `interval` | number | `5000` | The amount of time to delay between automatically cycling an item. | | `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. | | `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. | | `touch` | boolean | `true` | Whether the carousel should support left/right swipe interactions on touchscreen devices. | | `wrap` | boolean | `true` | Whether the carousel should cycle continuously or have hard stops. | {{< /bs-table >}} ### Methods {{< callout danger >}} {{< partial "callouts/danger-async-methods.md" >}} {{< /callout >}} You can create a carousel instance with the carousel constructor, for example, to initialize with additional options and start cycling through items: ```js const myCarouselElement = document.querySelector('#myCarousel') const carousel = new bootstrap.Carousel(myCarouselElement, { interval: 2000, wrap: false }) ``` {{< 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)`. | | `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). | {{< /bs-table >}} ### 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 item - `to`: The index of the next item All carousel events are fired at the carousel itself (i.e. at the `
`). {{< bs-table >}} | Event type | Description | | --- | --- | | `slid.bs.carousel` | Fired when the carousel has completed its slide transition. | | `slide.bs.carousel` | Fires immediately when the `slide` instance method is invoked. | {{< /bs-table >}} ```js const myCarousel = document.getElementById('myCarousel') myCarousel.addEventListener('slide.bs.carousel', event => { // do something... }) ```