The bootstrap carousel is a slideshow for cycling within a group of content, built with CSS 3D transforms and JavaScript. It runs with a group of images, text, or html elements. It also incorporates support for previous/next buttons.
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.).
Please be informed that nested carousels are not supported, and carousels are frequently not compliant with accessibility rules.
ExampleCarousels don’t automatically normalize slide dimensions. As such, you may want to use extra utilities or custom methods to properly size content. While carousels support previous/next controls and indicators, they’re not explicitly expected. Add and customize as you see fit.
The .active
class must to be attached to one of the slides otherwise the carousel will not be visible. Additionally be sure to set a different id on the .carousel
for optional controls, particularly if you’re using many carousels on a page. Control and indicator elements must have a data-coreui-target
attribute (or href
for links) that matches the id of the .carousel
element.
Here’s a carousel with slides. Note the appearance of the .d-block
also, .w-100
on carousel images to override browser default image alignment.
Placeholder First slide
Placeholder Second slide
Placeholder Third slide
<div id="carouselExampleSlidesOnly" class="carousel slide" data-coreui-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
</div>
With controls
Adding in the previous and next controls. We recommend using <button>
elements, but you can also use <a>
elements with role="button"
.
Placeholder First slide
Placeholder Second slide
Placeholder Third slide
<div id="carouselExampleControls" class="carousel slide" data-coreui-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleControls" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleControls" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
With indicators
You can attach the indicators to the carousel, lengthwise the controls, too.
Placeholder First slide
Placeholder Second slide
Placeholder Third slide
<div id="carouselExampleIndicators" class="carousel slide" data-coreui-ride="true">
<div class="carousel-indicators">
<button type="button" data-coreui-target="#carouselExampleIndicators" data-coreui-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button>
<button type="button" data-coreui-target="#carouselExampleIndicators" data-coreui-slide-to="1" aria-label="Slide 2"></button>
<button type="button" data-coreui-target="#carouselExampleIndicators" data-coreui-slide-to="2" aria-label="Slide 3"></button>
</div>
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleIndicators" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleIndicators" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
With captions
You can add captions to slides with the .carousel-caption
element within any .carousel-item
. They can be immediately hidden on smaller viewports, as shown below, with optional display utilities. We hide them with .d-none
and draw them back on medium-sized devices with .d-md-block
.
Some representative placeholder content for the first slide.
Placeholder Second slide Second slide labelSome representative placeholder content for the second slide.
Placeholder Third slide Third slide labelSome representative placeholder content for the third slide.
<div id="carouselExampleCaptions" class="carousel slide" data-coreui-ride="false">
<div class="carousel-indicators">
<button type="button" data-coreui-target="#carouselExampleCaptions" data-coreui-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button>
<button type="button" data-coreui-target="#carouselExampleCaptions" data-coreui-slide-to="1" aria-label="Slide 2"></button>
<button type="button" data-coreui-target="#carouselExampleCaptions" data-coreui-slide-to="2" aria-label="Slide 3"></button>
</div>
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>First slide label</h5>
<p>Some representative placeholder content for the first slide.</p>
</div>
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Second slide label</h5>
<p>Some representative placeholder content for the second slide.</p>
</div>
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Third slide label</h5>
<p>Some representative placeholder content for the third slide.</p>
</div>
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleCaptions" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleCaptions" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
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.
Placeholder First slide
Placeholder Second slide
Placeholder Third slide
<div id="carouselExampleFade" class="carousel slide carousel-fade" data-coreui-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleFade" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleFade" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
Individual .carousel-item
interval
Add data-coreui-interval=""
to a .carousel-item
to change the amount of time to delay between automatically cycling to the next item.
Placeholder First slide
Placeholder Second slide
Placeholder Third slide
<div id="carouselExampleInterval" class="carousel slide" data-coreui-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active" data-coreui-interval="10000">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item" data-coreui-interval="2000">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleInterval" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleInterval" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
Disable touch swiping
Carousels support swiping left/right on touchscreen devices to move between slides. This can be disabled using the data-coreui-touch
attribute. The example below also does not include the data-coreui-ride
attribute so it doesn’t autoplay.
Placeholder First slide
Placeholder Second slide
Placeholder Third slide
<div id="carouselExampleControlsNoTouching" class="carousel slide" data-coreui-touch="false">
<div class="carousel-inner">
<div class="carousel-item active">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
<div class="carousel-item">
<img src="..." class="d-block w-100" alt="...">
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleControlsNoTouching" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleControlsNoTouching" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
Dark variant Deprecated in v5.0.0
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
.
Heads up! Dark variants for components were deprecated in v5.0.0 with the introduction of color modes. Instead of adding .carousel-dark
, set data-coreui-theme="dark"
on the root element, a parent wrapper, or the component itself.
Some representative placeholder content for the first slide.
Placeholder Second slide Second slide labelSome representative placeholder content for the second slide.
Placeholder Third slide Third slide labelSome representative placeholder content for the third slide.
<div id="carouselExampleDark" class="carousel carousel-dark slide">
<div class="carousel-indicators">
<button type="button" data-coreui-target="#carouselExampleDark" data-coreui-slide-to="0" class="active" aria-current="true" aria-label="Slide 1"></button>
<button type="button" data-coreui-target="#carouselExampleDark" data-coreui-slide-to="1" aria-label="Slide 2"></button>
<button type="button" data-coreui-target="#carouselExampleDark" data-coreui-slide-to="2" aria-label="Slide 3"></button>
</div>
<div class="carousel-inner">
<div class="carousel-item active" data-coreui-interval="10000">
<img src="..." class="bd-placeholder-img-lg d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>First slide label</h5>
<p>Some representative placeholder content for the first slide.</p>
</div>
</div>
<div class="carousel-item" data-coreui-interval="2000">
<img src="..." class="bd-placeholder-img-lg d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Second slide label</h5>
<p>Some representative placeholder content for the second slide.</p>
</div>
</div>
<div class="carousel-item">
<img src="..." class="bd-placeholder-img-lg d-block w-100" alt="...">
<div class="carousel-caption d-none d-md-block">
<h5>Third slide label</h5>
<p>Some representative placeholder content for the third slide.</p>
</div>
</div>
</div>
<button class="carousel-control-prev" type="button" data-coreui-target="#carouselExampleDark" data-coreui-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="visually-hidden">Previous</span>
</button>
<button class="carousel-control-next" type="button" data-coreui-target="#carouselExampleDark" data-coreui-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="visually-hidden">Next</span>
</button>
</div>
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
).
Heads up! In our documentation, all examples show standard CoreUI implementation. If you are using a Bootstrap-compatible version of CoreUI, remember to use the following changes:
new bootstrap.Alert(...)
instead of new coreui.Alert(...)
close.bs.alert
instead of close.coreui.alert
data-bs-toggle="..."
instead of data-coreui-toggle="..."
Utilize data attributes to control the position of the carousel. data-coreui-slide
allows the keywords prev
or next
, which changes the slide position corresponding to its current position. Alternatively, use data-coreui-slide-to
to pass a raw slide index to the carousel data-coreui-slide-to="2"
, which moves the slide position to a particular index beginning with 0
.
The data-coreui-ride="carousel"
attribute is applied to mark a carousel as animating starting at page load. It cannot be done in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.
Call carousel manually with:
const carousel = new coreui.Carousel('#myCarousel')
Options
Options can be passed using data attributes or JavaScript. To do this, append an option name to data-coreui-
, such as data-coreui-animation="{value}"
. Remember to convert the case of the option name from “camelCase” to “kebab-case” when using data attributes. For instance, you should write data-coreui-custom-class="beautifier"
rather than data-coreui-customClass="beautifier"
.
Starting with CoreUI 4.2.0, all components support an experimental reserved data attribute named data-coreui-config
, which can contain simple component configurations as a JSON string. If an element has attributes data-coreui-config='{"delay":50, "title":689}'
and data-coreui-title="Custom Title"
, then the final value for title
will be Custom Title
, as the standard data attributes will take precedence over values specified in data-coreui-config
. Moreover, existing data attributes can also hold JSON values like data-coreui-delay='{"show":50, "hide":250}'
.
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. Methods Asynchronous methods and transitions
All our API methods are asynchronous and initiate a transition. They return to the caller as soon as the transition begins but before it concludes. Furthermore, a method call on a transitioning component will be ignored.
Refer to our JavaScript documentation for further details.
You can create a carousel instance with the carousel constructor, for example, to initialize with additional options and start cycling through items:
const myCarouselElement = document.querySelector('#myCarousel')
const carousel = new coreui.Carousel(myCarouselElement, {
interval: 2000,
wrap: false
})
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: coreui.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: coreui.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.coreui.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.coreui.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.coreui.carousel
event occurs). Events
CoreUI for 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 itemAll carousel events are fired at the carousel itself (i.e. at the <div class="carousel">
).
slid.coreui.carousel
Fired when the carousel has completed its slide transition. slide.coreui.carousel
Fires immediately when the slide
instance method is invoked.
const myCarousel = document.getElementById('myCarousel')
myCarousel.addEventListener('slide.coreui.carousel', event => {
// do something...
})
Customizing SASS variables
Variables for all carousels:
$carousel-control-color: $white;
$carousel-control-width: 15%;
$carousel-control-opacity: .5;
$carousel-control-hover-opacity: .9;
$carousel-control-transition: opacity .15s ease;
$carousel-control-icon-filter: null;
$carousel-indicator-width: 30px;
$carousel-indicator-height: 3px;
$carousel-indicator-hit-area-height: 10px;
$carousel-indicator-spacer: 3px;
$carousel-indicator-opacity: .5;
$carousel-indicator-active-bg: $white;
$carousel-indicator-active-opacity: 1;
$carousel-indicator-transition: opacity .6s ease;
$carousel-caption-width: 70%;
$carousel-caption-color: $white;
$carousel-caption-padding-y: 1.25rem;
$carousel-caption-spacer: 1.25rem;
$carousel-control-icon-width: 2rem;
$carousel-control-prev-icon-bg: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='#{$carousel-control-color}'><path d='M11.354 1.646a.5.5 0 0 1 0 .708L5.707 8l5.647 5.646a.5.5 0 0 1-.708.708l-6-6a.5.5 0 0 1 0-.708l6-6a.5.5 0 0 1 .708 0'/></svg>");
$carousel-control-next-icon-bg: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='#{$carousel-control-color}'><path d='M4.646 1.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1 0 .708l-6 6a.5.5 0 0 1-.708-.708L10.293 8 4.646 2.354a.5.5 0 0 1 0-.708'/></svg>");
$carousel-transition-duration: .6s;
$carousel-transition: transform $carousel-transition-duration ease-in-out; // Define transform transition first if using multiple transitions (e.g., `transform 2s ease, opacity .5s ease-out`)
Variables for the dark carousel:
$carousel-dark-indicator-active-bg: $black; // Deprecated in v5.3.2
$carousel-dark-caption-color: $black; // Deprecated in v5.3.2
$carousel-dark-control-icon-filter: invert(1) grayscale(100); // Deprecated in v5.3.2
CoreUI vs Bootstrap
While this Carousel component is fully compatible with Bootstrap and follows its core principles, CoreUI delivers a more complete solution for modern app development.
What sets CoreUI apart from Bootstrap?
Whether you’re building internal tools, dashboards, or SaaS platforms — CoreUI combines the familiarity of Bootstrap with a more powerful, scalable, and production-ready ecosystem.
👉 Explore CoreUI Bootstrap Components
👉 Compare CoreUI vs Bootstrap
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4