Carousel
Bootstrap 5 Carousel component
Responsive carousel built with the latest Bootstrap 5. Carousel is a slideshow cycling through different elements such as photos, videos, or text. Many examples and easy tutorials.
A slideshow component for cycling through elements—images or slides of text—like a carousel.
Note: Read the API tab to find all available options and advanced customization
*
*
UMD autoinits are enabled
by default. This means that you don't need to initialize
the component manually. However if you are using MDBootstrap ES format then you should pass
the required components to the initMDB
method.
Video tutorial
Basic example
Carousel allows to navigate through a collection of images in a sequential fashion, moving to the previous/next one through the arrows on the sides.
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.).
Note: Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards.
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-mdb-target
attribute (or href
for links) that matches the id of
the .carousel
element.
Variations
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.
With controls
Adding in the previous and next controls:
With indicators
You can also add the indicators to the carousel, alongside the controls, too.
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. We hide them initially
with .d-none
and bring them back on medium-sized devices with
.d-md-block
.
Crossfade
Use fade transition on your slides easily by adding the
.carousel-fade
class to any .carousel
.
Individual .carousel-item
interval
Add data-mdb-interval=""
to a .carousel-item
to change the amount
of time to delay between automatically cycling to the next item.
Disable touch swiping
Swiping left/right on touchscreen devices can be disabled by setting the
mdb-data-touch
attribute to false
.
Material style
If you want to make your carousel look more "material" use the rounded-*
and
shadow-*
classes to add rounded corners and a shadows.
Dark variant
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
.
Multi-item carousel
A basic example of a multi carousel with the most common use case with 3 active items (default version).
If you need more advanced options and examples of multi-item carousel have a look at Multi-item Carousel Docs
Carousel - API
Import
Importing components depends on how your application works. If you intend to use the MDBootstrap ES
format, you must
first import the component and then initialize it with the initMDB
method. If you are going to use the UMD
format,
just import the mdb-ui-kit
package.
Usage
Via data attributes
Using the Carousel component doesn't require any additional JavaScript code - simply add
data-mdb-carousel-init
attribute to
.carousel
and use other data attributes to set all options.
For ES
format, you must first import and call the initMDB
method.
Use data attributes to easily control the position of the carousel.
data-mdb-slide
accepts the keywords prev
or next
, which
alters the slide position relative to its current position. Alternatively, use
data-mdb-slide-to
to pass a raw slide index to the carousel
data-mdb-slide-to="2"
, which shifts the slide position to a particular index
beginning with 0
.
The data-mdb-ride="carousel"
attribute is used to mark a carousel as animating
starting at page load. If you don’t use data-mdb-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
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to
data-mdb-
, as in data-mdb-interval="4000"
.
Name | Type | Default | Description |
---|---|---|---|
interval |
number | boolean | 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 | 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.
|
wrap |
boolean | true |
Whether the carousel should cycle continuously or have hard stops. |
touch |
boolean | true |
Whether the carousel should support left/right swipe interactions on touchscreen devices. |
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.
Method | Description | Example |
---|---|---|
cycle |
Cycles through the carousel items from left to right. | instance.cycle() |
pause |
Stops the carousel from cycling through items. | instance.pause() |
prev |
Cycles to the previous item.
Returns to the caller before the previous item has been shown (e.g.,
before the slid.mdb.carousel event occurs).
|
instance.prev() |
next |
Cycles to the next item.
Returns to the caller before the next item has been shown (e.g., before
the slid.mdb.carousel event occurs).
|
instance.next() |
nextWhenVisible |
Don’t cycle the carousel to next when the page isn’t visible or the carousel or its
parent isn’t visible.
Returns to the caller before the next item has been shown (e.g., before
the slid.mdb.carousel event occurs).
|
instance.nextWhenVisible() |
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.mdb.carousel event occurs).
|
instance.to(0) |
dispose |
Destroys an element's carousel. | instance.dispose() |
getInstance |
Static method which allows you to get the carousel instance associated with a DOM element. | Carousel.getInstance(carouselEl) |
getOrCreateInstance |
Static method which allows you to get the carousel instance associated with a DOM element or create a new one in case it wasn't initialized. | Carousel.getOrCreateInstance(carouselEl) |
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
Event type | Description |
---|---|
slide.mdb.carousel |
Fires immediately when the slide instance method is invoked. |
slid.mdb.carousel |
Fired when the carousel has completed its slide transition. |
Change transition duration
The transition duration of .carousel-item
can be changed with the
$carousel-transition
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
).
CSS variables
As part of MDB’s evolving CSS variables approach, carousel now uses local CSS variables on
.carousel-control-prev-icon, .carousel-control-next-icon
for enhanced real-time
customization. Values for the CSS variables are set via Sass, so Sass customization is still
supported, too.