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.
-
For performance reasons, carousels must be manually initialized using the carousel constructor method. Without initialization, some of the event listeners (specifically, the events needed touch/swipe support) will not be registered until a user has explicitly activated a control or indicator.
The only exception are autoplaying carousels with
the data-bs-ride="carousel" attribute as these are initialized automatically
on page load. If you're using autoplaying carousels with the data attribute, *
don't explicitly initialize the same carousels with the constructor method.*
- Nested carousels are not supported. You should also be aware that carousels in general can often cause usability and accessibility challenges.
{ {< callout info >} } { {< partial "callouts/info-prefersreducedmotion.md" >} } { {< /callout >} }
Basic examples#
Here is a basic example of a carousel with three slides. Note the previous/next
controls. We recommend using <button> elements, but you can also use <a>
elements with role="button".
{ {< example >} }
{ {< /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.
You must add the .active class 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.
Indicators#
You can add indicators to the carousel, alongside the previous/next controls. The indicators let users jump directly to a particular slide.
{ {< example >} }
{ {< /example >} }
Captions#
You can add captions to your slides with the .carousel-caption element within
any .carousel-item. They can be easily hidden on smaller viewports, as shown
below, with optional display utilities.
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-items for
proper crossfading.
{ {< example >} }
{ {< /example >} }
Autoplaying carousels#
You can make your carousels autoplay on page load by setting the ride option
to carousel. Autoplaying carousels automatically pause while hovered with the
mouse. This behavior can be controlled with the pause option. In browsers that
support the Page Visibility API, the
carousel will stop cycling when the webpage is not visible to the user (such as
when the browser tab is inactive, or when the browser window is minimized).
{ {< callout info >} } For accessibility reasons, we recommend avoiding the use of autoplaying carousels. If your page does include an autoplaying carousel, we recommend providing an additional button or control to explicitly pause/stop the carousel.
See WCAG 2.2 Success Criterion 2.2.2 Pause, Stop, Hide. { {< /callout >} }
{ {< example >} }
{ {< /example >} }
When the ride option is set to true, rather than carousel, the carousel
won't automatically start to cycle on page load. Instead, it will only start
after the first user interaction.
{ {< 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 >} }
Autoplaying carousels without controls#
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 >} }
Disable touch swiping#
Carousels support swiping left/right on touchscreen devices to move between
slides. This can be disabled by setting the touch option to false.
{ {< example >} }
{ {< /example >} }
Dark variant#
{ {< deprecated-in "5.3.0" >} }
Add .carousel-dark to the .carousel for darker controls, indicators, and
captions. Controls are inverted compared to their default white fill with the
filter CSS property. Captions and controls have additional Sass variables that
customize the color and background-color.
{ {< callout-deprecated-dark-variants "carousel" >} }
{ {< 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).
CSS#
Sass variables#
Variables for all carousels:
{ {< scss-docs name="carousel-variables" file="scss/_variables.scss" >} }
Variables for the dark carousel:
{ {< 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.
Via JavaScript#
Call carousel manually with:
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, and pass on
any additional options. For example, to manually initialize an autoplaying
carousel (assuming you're not using the data-bs-ride="carousel" attribute in
the markup itself) with a specific interval and with touch support disabled, you
can use:
const myCarouselElement = document.querySelector('#myCarousel')
const carousel = new bootstrap.Carousel(myCarouselElement, {
interval: 2000,
touch: false
})
{ {< bs-table >} }
| Method | Description |
| --- | --- |
| cycle | Starts cycling 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 creates 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, the carousel,
or the carousel's parent aren'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 itemto: The index of the next item
All carousel events are fired at the carousel itself (i.e. at the
<div class="carousel">).
{ {< 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 >} }
const myCarousel = document.getElementById('myCarousel')
myCarousel.addEventListener('slide.bs.carousel', event => {
// do something...
})