<wa-carousel>
Carousels display an arbitrary number of content slides along a horizontal or vertical axis.
<wa-carousel pagination navigation mouse-dragging loop> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel>
Use the pagination
attribute to show the total number of slides and the current slide as a set of
interactive dots.
<wa-carousel pagination> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel>
Use the navigation
attribute to show previous and next buttons.
<wa-carousel navigation> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel>
By default, the carousel will not advanced beyond the first and last slides. You can change this behavior and
force the carousel to "wrap" with the loop
attribute.
<wa-carousel loop navigation pagination> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel>
The carousel will automatically advance when the autoplay
attribute is used. To change how long a
slide is shown before advancing, set autoplay-interval
to the desired number of milliseconds. For
best results, use the loop
attribute when autoplay is enabled. Note that autoplay will pause
while the user interacts with the carousel.
<wa-carousel autoplay loop pagination> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel>
The carousel uses
scroll snap to position slides
at various snap positions. This allows users to scroll through the slides very naturally, especially on touch
devices. Unfortunately, desktop users won't be able to click and drag with a mouse, which can feel unnatural.
Adding the mouse-dragging
attribute can help with this.
This example is best demonstrated using a mouse. Try clicking and dragging the slide to move it. Then toggle the switch and try again.
<div class="mouse-dragging"> <wa-carousel pagination> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel> <wa-divider></wa-divider> <wa-switch>Enable mouse dragging</wa-switch> </div> <script> const container = document.querySelector('.mouse-dragging'); const carousel = container.querySelector('wa-carousel'); const toggle = container.querySelector('wa-switch'); toggle.addEventListener('wa-change', () => { carousel.toggleAttribute('mouse-dragging', toggle.checked); }); </script>
The slides-per-page
attribute makes it possible to display multiple slides at a time. You can
also use the slides-per-move
attribute to advance more than once slide at a time, if desired.
<wa-carousel navigation pagination slides-per-page="2" slides-per-move="2"> <wa-carousel-item style="background: red;">Slide 1</wa-carousel-item> <wa-carousel-item style="background: orange;">Slide 2</wa-carousel-item> <wa-carousel-item style="background: yellow;">Slide 3</wa-carousel-item> <wa-carousel-item style="background: green;">Slide 4</wa-carousel-item> <wa-carousel-item style="background: blue;">Slide 5</wa-carousel-item> <wa-carousel-item style="background: purple;">Slide 6</wa-carousel-item> </wa-carousel>
The content of the carousel can be changed by adding or removing carousel items. The carousel will update itself automatically.
<wa-carousel class="dynamic-carousel" pagination navigation> <wa-carousel-item style="background: red">Slide 1</wa-carousel-item> <wa-carousel-item style="background: orange">Slide 2</wa-carousel-item> <wa-carousel-item style="background: yellow">Slide 3</wa-carousel-item> </wa-carousel> <div class="carousel-options"> <wa-button id="dynamic-add">Add slide</wa-button> <wa-button id="dynamic-remove">Remove slide</wa-button> </div> <style> .dynamic-carousel { --aspect-ratio: 3 / 2; } .dynamic-carousel ~ .carousel-options { display: flex; justify-content: center; gap: var(--wa-space-xs); margin-top: var(--wa-space-l); } .dynamic-carousel wa-carousel-item { flex: 0 0 100%; display: flex; align-items: center; justify-content: center; font-size: var(--wa-font-size-2xl); } </style> <script> (() => { const dynamicCarousel = document.querySelector('.dynamic-carousel'); const dynamicAdd = document.querySelector('#dynamic-add'); const dynamicRemove = document.querySelector('#dynamic-remove'); const colors = ['red', 'orange', 'yellow', 'green', 'blue', 'purple']; let colorIndex = 2; const addSlide = () => { const slide = document.createElement('wa-carousel-item'); const color = colors[++colorIndex % colors.length]; slide.innerText = `Slide ${dynamicCarousel.children.length + 1}`; slide.style.setProperty('background', color); dynamicCarousel.appendChild(slide); dynamicRemove.disabled = false; }; const removeSlide = () => { const slide = dynamicCarousel.children[dynamicCarousel.children.length - 1]; const numSlides = dynamicCarousel.querySelectorAll('wa-carousel-item').length; if (numSlides > 1) { slide.remove(); colorIndex--; } dynamicRemove.disabled = numSlides - 1 <= 1; }; dynamicAdd.addEventListener('click', addSlide); dynamicRemove.addEventListener('click', removeSlide); })(); </script>
Setting the orientation
attribute to vertical
will render the carousel in a vertical
layout. If the content of your slides vary in height, you will need to set amn explicit height
or
max-height
on the carousel using CSS.
<wa-carousel class="vertical" pagination orientation="vertical"> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel> <style> .vertical { max-height: 400px; } .vertical::part(base) { grid-template-areas: 'slides slides pagination'; } .vertical::part(pagination) { flex-direction: column; } .vertical::part(navigation) { transform: rotate(90deg); display: flex; } </style>
Use the --aspect-ratio
custom property to customize the size of the carousel's viewport from the
default value of 16/9.
<wa-carousel class="aspect-ratio" navigation pagination style="--aspect-ratio: 3/2;"> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel> <wa-divider></wa-divider> <wa-select label="Aspect ratio" name="aspect" value="3/2"> <wa-option value="1/1">1/1</wa-option> <wa-option value="3/2">3/2</wa-option> <wa-option value="16/9">16/9</wa-option> </wa-select> <script> (() => { const carousel = document.querySelector('wa-carousel.aspect-ratio'); const aspectRatio = document.querySelector('wa-select[name="aspect"]'); aspectRatio.addEventListener('wa-change', () => { carousel.style.setProperty('--aspect-ratio', aspectRatio.value); }); })(); </script>
Use the --scroll-hint
custom property to add inline padding in horizontal carousels and block
padding in vertical carousels. This will make the closest slides slightly visible, hinting that there are more
items in the carousel.
<wa-carousel class="scroll-hint" pagination style="--scroll-hint: 10%;"> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel>
The carousel has a robust API that makes it possible to extend and customize. This example syncs the active slide with a set of thumbnails, effectively creating a gallery-style carousel.
<wa-carousel class="carousel-thumbnails" navigation loop> <wa-carousel-item> <img alt="The sun shines on the mountains and trees (by Adam Kool on Unsplash)" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A river winding through an evergreen forest (by Luca Bravo on Unsplash)" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="The sun is setting over a lavender field (by Leonard Cotte on Unsplash)" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> </wa-carousel-item> <wa-carousel-item> <img alt="A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </wa-carousel-item> </wa-carousel> <div class="thumbnails"> <div class="thumbnails__scroller"> <img alt="Thumbnail by 1" class="thumbnails__image active" src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10" /> <img alt="Thumbnail by 2" class="thumbnails__image" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" /> <img alt="Thumbnail by 3" class="thumbnails__image" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" /> <img alt="Thumbnail by 4" class="thumbnails__image" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" /> <img alt="Thumbnail by 5" class="thumbnails__image" src="https://images.unsplash.com/photo-1470071459604-3b5ec3a7fe05?q=10" /> </div> </div> <style> .carousel-thumbnails { --slide-aspect-ratio: 3 / 2; } .thumbnails { display: flex; justify-content: center; } .thumbnails__scroller { display: flex; gap: var(--wa-space-s); overflow-x: auto; scrollbar-width: none; scroll-behavior: smooth; scroll-padding: var(--wa-space-s); } .thumbnails__scroller::-webkit-scrollbar { display: none; } .thumbnails__image { width: 64px; height: 64px; object-fit: cover; opacity: 0.3; will-change: opacity; transition: 250ms opacity; cursor: pointer; } .thumbnails__image.active { opacity: 1; } </style> <script> { const carousel = document.querySelector('.carousel-thumbnails'); const scroller = document.querySelector('.thumbnails__scroller'); const thumbnails = document.querySelectorAll('.thumbnails__image'); scroller.addEventListener('click', e => { const target = e.target; if (target.matches('.thumbnails__image')) { const index = [...thumbnails].indexOf(target); carousel.goToSlide(index); } }); carousel.addEventListener('wa-slide-change', e => { const slideIndex = e.detail.index; [...thumbnails].forEach((thumb, i) => { thumb.classList.toggle('active', i === slideIndex); if (i === slideIndex) { thumb.scrollIntoView({ block: 'nearest' }); } }); }); } </script>
Name | Description |
---|---|
(default) |
The carousel's main content, one or more <wa-carousel-item> elements.
|
next-icon
|
Optional next icon to use instead of the default. Works best with <wa-icon> .
|
previous-icon
|
Optional previous icon to use instead of the default. Works best with <wa-icon> .
|
Name | Description | Reflects | |
---|---|---|---|
loop loop
|
When set, allows the user to navigate the carousel in the same direction indefinitely.
Type
boolean
Default
false
|
|
|
navigation navigation
|
When set, show the carousel's navigation.
Type
boolean
Default
false
|
|
|
pagination pagination
|
When set, show the carousel's pagination indicators.
Type
boolean
Default
false
|
|
|
autoplay autoplay
|
When set, the slides will scroll automatically when the user is not interacting with them.
Type
boolean
Default
false
|
|
|
autoplayInterval autoplay-interval
|
Specifies the amount of time, in milliseconds, between each automatic scroll.
Type
number
Default
3000
|
||
slidesPerPage slides-per-page
|
Specifies how many slides should be shown at a given time.
Type
number
Default
1
|
||
slidesPerMove slides-per-move
|
Specifies the number of slides the carousel will advance when scrolling, useful when specifying a
slides-per-page greater than one. It can't be higher than slides-per-page .
Type
number
Default
1
|
||
orientation orientation
|
Specifies the orientation in which the carousel will lay out.
Type
'horizontal' | 'vertical'
Default
'horizontal'
|
||
mouseDragging mouse-dragging
|
When set, it is possible to scroll through the slides by dragging them with the mouse.
Type
boolean
Default
false
|
|
Name | Description | Arguments |
---|---|---|
previous() |
Move the carousel backward by slides-per-move slides. |
behavior: ScrollBehavior
|
next() |
Move the carousel forward by slides-per-move slides. |
behavior: ScrollBehavior
|
goToSlide() |
Scrolls the carousel to the slide specified by index . |
index: number, behavior: ScrollBehavior
|
Name | Description |
---|---|
wa-slide-change |
Emitted when the active slide changes. |
Name | Description |
---|---|
--aspect-ratio |
The aspect ratio of each slide.
Default
16/9
|
--navigation-color |
The color of the navigation arrows.
|
--pagination-color |
The color of the dots indicating the number of slides.
|
--pagination-color-active |
The color of the dot indicating the active slide.
|
--scroll-hint |
The amount of padding to apply to the scroll area, allowing adjacent slides to become partially
visible as a scroll hint.
|
--slide-gap |
The space between each slide.
|
Name | Description |
---|---|
base |
The carousel's internal wrapper. |
scroll-container |
The scroll container that wraps the slides. |
pagination |
The pagination indicators wrapper. |
pagination-item |
The pagination indicator. |
pagination-item--active |
Applied when the item is active. |
navigation |
The navigation wrapper. |
navigation-button |
The navigation button. |
navigation-button--previous |
Applied to the previous button. |
navigation-button--next |
Applied to the next button. |
This component automatically imports the following elements. Subdependencies, if any exist, will also be included in this list.
The autoloader is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.
To manually import this component from the CDN, use the following code.
import 'https://early.webawesome.com/webawesome@3.0.0-alpha.4/dist/components/carousel/carousel.js';