Carousel
Angular Bootstrap 5 Carousel component
Responsive carousel built with Bootstrap 5, Angular and Material Design. Slider examples with indicators, captions, image and multiple item carousel.
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
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.
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
Use [controls]="true"
input to add the previous and next controls:
With indicators
You can also add the indicators to the carousel with [indicators]="true"
input.
With captions
Add captions to your slides easily with the
.carousel-caption
element within any mdb-carousel-item
component.
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
.
Animation
Use [animation]="'fade'"
input to change carousel animation type from
slide
to fade
.
Individual mdb-carousel-item
interval
Use [interval]
input on specific mdb-carousel-item
component to
change the amount of time to delay between automatically cycling to the next item.
Material style
If you want to make your carousel look more "material" wrap the
mdb-carousel
component with .carousel-inner
element and use the
rounded-*
and shadow-*
classes to add rounded corners and a
shadows.
Dark variant
Use [dark]="true"
input for darker controls, indicators, and captions.
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
Inputs
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 |
boolean | true |
If set to |
ride |
boolean | true |
Autoplays the carousel on load. If "false", autoplays the carousel after the user manually cycles the first item. |
wrap |
boolean | true |
Whether the carousel should cycle continuously or have hard stops. |
Outputs
Name | Type | Description |
---|---|---|
slide |
EventEmitter<void> | Fires immediately when the carousel start to slide. |
slideChange |
EventEmitter<void> | Fired when the carousel has completed its slide transition. |
Methods
Name | Description | Example |
---|---|---|
play |
Cycles through the carousel items from left to right. | carousel.play() |
stop |
Stops the carousel from cycling through items. | carousel.stop() |
prev |
Cycles to the previous item. | carousel.prev() |
next |
Cycles to the next item. | carousel.next() |
to(index: number) |
Cycles the carousel to a particular frame (0 based, similar to an array). | carousel.to(2) |
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.