Carousel

<cs-carousel>

Experimental

Since 0.1

Carousels display a series of content slides along a horizontal or vertical axis, one or more at a time. Users can navigate between slides with controls, pagination, or autoplay.

The sun shines on the mountains and trees (by Adam Kool on Unsplash)

A river winding through an evergreen forest (by Luca Bravo on Unsplash)

The sun is setting over a lavender field (by Leonard Cotte on Unsplash)

A field of grass with the sun setting in the background (by Sapan Patel on Unsplash)

A scenic view of a mountain with clouds rolling in (by V2osk on Unsplash)

<cs-carousel pagination navigation mouse-dragging loop>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

Examples

Pagination

Use the pagination attribute to show the total number of slides and the current slide as a set of interactive dots.

<cs-carousel pagination>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

Use the navigation attribute to show previous and next buttons.

<cs-carousel navigation>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

Loop

By default, the carousel will not advance beyond the first and last slides. You can change this behavior and force the carousel to “wrap” with the loop attribute.

<cs-carousel loop navigation pagination>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

Autoplay

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. Autoplay pauses while the user interacts with the carousel.

<cs-carousel autoplay loop pagination>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

Orientation

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 an explicit height or max-height on the carousel using CSS.

<cs-carousel class="vertical" pagination orientation="vertical">
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>
<style>
  .vertical {
    max-height: 400px;
  }

  .vertical::part(carousel) {
    grid-template-areas: 'slides slides pagination';
  }

  .vertical::part(pagination) {
    flex-direction: column;
  }

  .vertical::part(navigation) {
    transform: rotate(90deg);
    display: flex;
  }
</style>

Aspect Ratio

Use the --aspect-ratio custom property to customize the size of the carousel’s viewport from the default value of 16/9.

1/1

3/2

16/9

<div>
  <cs-carousel class="aspect-ratio" navigation pagination style="--aspect-ratio: 3/2;">
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
  </cs-carousel>

  <cs-divider></cs-divider>

  <div class="cs-cluster">
    <cs-select label="Aspect ratio" name="aspect" value="3/2">
      <cs-option value="1/1">1/1</cs-option>
      <cs-option value="3/2">3/2</cs-option>
      <cs-option value="16/9">16/9</cs-option>
    </cs-select>
  </div>
</div>

<script>
  (() => {
    const carousel = document.querySelector('cs-carousel.aspect-ratio');
    const aspectRatio = document.querySelector('cs-select[name="aspect"]');

    aspectRatio.addEventListener('change', () => {
      carousel.style.setProperty('--aspect-ratio', aspectRatio.value);
    });
  })();
</script>

Multiple Slides per View

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 one slide at a time, if desired.

  Slide 1
  Slide 2
  Slide 3
  Slide 4
  Slide 5
  Slide 6

<cs-carousel navigation pagination slides-per-page="2" slides-per-move="2">
  <cs-carousel-item style="background: red;">Slide 1</cs-carousel-item>
  <cs-carousel-item style="background: orange;">Slide 2</cs-carousel-item>
  <cs-carousel-item style="background: yellow;">Slide 3</cs-carousel-item>
  <cs-carousel-item style="background: green;">Slide 4</cs-carousel-item>
  <cs-carousel-item style="background: blue;">Slide 5</cs-carousel-item>
  <cs-carousel-item style="background: purple;">Slide 6</cs-carousel-item>
</cs-carousel>

Scroll Hint

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.

<cs-carousel class="scroll-hint" pagination style="--scroll-hint: 10%;">
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

Mouse Dragging

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.

Enable mouse dragging

<div class="mouse-dragging">
  <cs-carousel pagination>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
    <cs-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"
      />
    </cs-carousel-item>
  </cs-carousel>

  <cs-divider></cs-divider>

  <cs-switch>Enable mouse dragging</cs-switch>
</div>

<script>
  const container = document.querySelector('.mouse-dragging');
  const carousel = container.querySelector('cs-carousel');
  const toggle = container.querySelector('cs-switch');

  toggle.addEventListener('change', () => {
    carousel.toggleAttribute('mouse-dragging', toggle.checked);
  });
</script>

Adding & Removing Slides

The content of the carousel can be changed by adding or removing carousel items. The carousel will update itself automatically.

    Slide 1
    Slide 2
    Slide 3
  
    Add slide
    Remove slide
  

<div>
  <cs-carousel class="dynamic-carousel" pagination navigation loop>
    <cs-carousel-item style="background: red">Slide 1</cs-carousel-item>
    <cs-carousel-item style="background: orange">Slide 2</cs-carousel-item>
    <cs-carousel-item style="background: yellow">Slide 3</cs-carousel-item>
  </cs-carousel>

  <cs-divider></cs-divider>

  <div class="cs-cluster">
    <cs-button appearance="filled" id="dynamic-add">Add slide</cs-button>
    <cs-button appearance="filled" id="dynamic-remove">Remove slide</cs-button>
  </div>
</div>

<style>
  .dynamic-carousel {
    --aspect-ratio: 3 / 2;
  }

  .dynamic-carousel cs-carousel-item {
    flex: 0 0 100%;
    display: flex;
    align-items: center;
    justify-content: center;
    font-size: var(--cs-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 slides = () => [...dynamicCarousel.children].filter(child => !child.hasAttribute('data-clone'));

    const addSlide = () => {
      const slide = document.createElement('cs-carousel-item');
      const color = colors[++colorIndex % colors.length];
      slide.innerText = `Slide ${slides().length + 1}`;
      slide.style.setProperty('background', color);
      dynamicCarousel.addSlide(slide);
      dynamicRemove.disabled = false;
    };

    const removeSlide = () => {
      const numSlides = slides().length;

      if (numSlides > 1) {
        dynamicCarousel.removeSlide(numSlides - 1);
        colorIndex--;
      }

      dynamicRemove.disabled = numSlides - 1 <= 1;
    };

    dynamicAdd.addEventListener('click', addSlide);
    dynamicRemove.addEventListener('click', removeSlide);
  })();
</script>

Thumbnail Gallery

The carousel’s API makes it possible to extend and customize. This example syncs the active slide with a set of thumbnails, effectively creating a gallery-style carousel.

<cs-carousel class="carousel-thumbnails" navigation loop>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
  <cs-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"
    />
  </cs-carousel-item>
</cs-carousel>

<div class="thumbnails">
  <div class="scroller">
    <img
      alt="Thumbnail by 1"
      class="image active"
      src="https://images.unsplash.com/photo-1426604966848-d7adac402bff?q=10"
    />
    <img alt="Thumbnail by 2" class="image" src="https://images.unsplash.com/photo-1473448912268-2022ce9509d8?q=10" />
    <img alt="Thumbnail by 3" class="image" src="https://images.unsplash.com/photo-1499002238440-d264edd596ec?q=10" />
    <img alt="Thumbnail by 4" class="image" src="https://images.unsplash.com/photo-1475113548554-5a36f1f523d6?q=10" />
    <img alt="Thumbnail by 5" class="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;
  }

  .scroller {
    display: flex;
    gap: var(--cs-space-s);
    overflow-x: auto;
    scrollbar-width: none;
    scroll-behavior: smooth;
    scroll-padding: var(--cs-space-s);
  }

  .scroller::-webkit-scrollbar {
    display: none;
  }

  .image {
    width: 64px;
    height: 64px;
    object-fit: cover;

    opacity: 0.3;
    will-change: opacity;
    transition: 250ms opacity;

    cursor: pointer;
  }

  .image.active {
    opacity: 1;
  }
</style>

<script>
  {
    const carousel = document.querySelector('.carousel-thumbnails');
    const scroller = document.querySelector('.scroller');
    const thumbnails = document.querySelectorAll('.image');

    scroller.addEventListener('click', e => {
      const target = e.target;

      if (target.matches('.image')) {
        const index = [...thumbnails].indexOf(target);
        carousel.goToSlide(index);
      }
    });

    carousel.addEventListener('cs-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>

API

Importing

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.

npm

Self-Hosted

React

import '@cruglobal/cornerstone-components/components/carousel/carousel.js';

import './cornerstone/components/carousel/carousel.js';

import CsCarousel from '@cruglobal/cornerstone-components/react/carousel/index.js';

Slots

Learn more about using slots.

Name	Description
(default)	The carousel's main content, one or more `<cs-carousel-item>` elements.
`next-icon`	Optional next icon to use instead of the default. Works best with `<cs-icon>`.
`previous-icon`	Optional previous icon to use instead of the default. Works best with `<cs-icon>`.

Attributes & Properties

Learn more about attributes and properties.

Property	Attribute	Description	Type	Default	Reflects
`autoplay`	`autoplay`	When set, the slides will scroll automatically when the user is not interacting with them.	`boolean`	`false`	Yes
`autoplayInterval`	`autoplay-interval`	Specifies the amount of time, in milliseconds, between each automatic scroll.	`number`	`3000`	—
`loop`	`loop`	When set, allows the user to navigate the carousel in the same direction indefinitely.	`boolean`	`false`	Yes
`mouseDragging`	`mouse-dragging`	When set, it is possible to scroll through the slides by dragging them with the mouse.	`boolean`	`false`	Yes
`navigation`	`navigation`	When set, show the carousel's navigation.	`boolean`	`false`	Yes
`orientation`	`orientation`	Specifies the orientation in which the carousel will lay out.	`'horizontal' \| 'vertical'`	`'horizontal'`	—
`pagination`	`pagination`	When set, show the carousel's pagination indicators.	`boolean`	`false`	Yes
`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`.	`number`	`1`	—
`slidesPerPage`	`slides-per-page`	Specifies how many slides should be shown at a given time.	`number`	`1`	—

Methods

Learn more about methods.

Name	Description	Arguments
`addSlide()`	Adds a carousel item as the last real slide.	`slide: CsCarouselItem`
`goToSlide()`	Scrolls the carousel to the slide specified by `index`.	`index: number, behavior: ScrollBehavior`
`next()`	Move the carousel forward by `slides-per-move` slides.	`behavior: ScrollBehavior`
`previous()`	Move the carousel backward by `slides-per-move` slides.	`behavior: ScrollBehavior`
`removeSlide()`	Removes the real slide at the specified index.	`index: number`

Events

Learn more about events.

Name	Description
`cs-slide-change`	Emitted when the active slide changes.

CSS Custom Properties

Learn more about CSS custom properties.

Name	Description	Default
`--aspect-ratio`	The aspect ratio of each slide.	`16/9`
`--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.	`var(--cs-space-m)`

CSS Parts

Learn more about CSS parts.

Name	Description	CSS selector
`carousel`	The component's outer wrapper.	`::part(carousel)`
`navigation`	The navigation wrapper.	`::part(navigation)`
`navigation-button`	The navigation button.	`::part(navigation-button)`
`navigation-button-next`	Applied to the next button.	`::part(navigation-button-next)`
`navigation-button-previous`	Applied to the previous button.	`::part(navigation-button-previous)`
`pagination`	The pagination indicators wrapper.	`::part(pagination)`
`pagination-item`	The pagination indicator.	`::part(pagination-item)`
`pagination-item-active`	Applied when the item is active.	`::part(pagination-item-active)`
`scroll-container`	The scroll container that wraps the slides.	`::part(scroll-container)`

Dependencies

This component automatically imports the following elements. Sub-dependencies, if any exist, are included in this list.

<cs-icon>

SSR

Learn more about Server-Side Rendering (SSR).

<cs-carousel> displays its first slide during SSR, but won't be interactive until it hydrates on the client.

Quick Links

Recent Searches