What does the component do?

A carousel is an interactive element for displaying multiple pieces of content within a limited area. It displays one or more pieces of content at a time and allows horizontal scrolling using navigation elements or gestures.

When should the component be used?

• When several similar pieces of content are to be displayed, but there is not enough space for all of them at once.
• When the focus is on a visual or content sequence (e.g., highlights, campaigns, products).
• When space is limited and content needs to be presented in a space-saving manner.

Rules

• No more than 7 slides should be used.
• Each slide should have a clear focus.
• Carousels should not change automatically—only manual control by the user.

Playground

The sbb-carousel is a slideshow component that can be used to display a series of items, as images, once at a time,
allowing users to cycle through them via horizontal scrolling or using controls (e.g. a paginator).

The component must be used together with a sbb-compact-paginator and a sbb-carousel-list,
which accepts one or more sbb-carousel-item.

<sbb-carousel>
  <sbb-carousel-list>
    <sbb-carousel-item>
      <img src="../img-1.jpg" alt="Image 1" height="300" width="400" />
    </sbb-carousel-item>
    <sbb-carousel-item>
      <img src="../img-2.jpg" alt="Image 2" height="300" width="400" />
    </sbb-carousel-item>
    <sbb-carousel-item>
      <img src="../img-3.jpg" alt="Image 3" height="300" width="400" />
    </sbb-carousel-item>
  </sbb-carousel-list>
  <sbb-compact-paginator></sbb-compact-paginator>
</sbb-carousel>

Slots

The content is projected in an unnamed slot.

The length and the pageSize properties of the sbb-compact-paginator are automatically set based on the number of slotted images.

The values of the accessibilityPageLabel, accessibilityPreviousPageLabel and accessibilityNextPageLabel properties
are also set, in order to automatically override the 'page' keyword to the 'slide' one.
If needed, consumers can provide their own values.

Interactions

It's possible to switch between items using the paginator controls, or, if the component is focused, using the arrow keys.

Accessibility

Following the ARIA carousel pattern,
the component has role="region" and aria-label="carousel".

To not break the accessibility when links are used together with images, please place the image within the anchor tag.

<sbb-carousel>
  <sbb-carousel-list>
    <sbb-carousel-item>
      <a href="#" target="_blank">
        <img src="../img-1.jpg" alt="SBB image" height="300" width="400" />
      </a>
    </sbb-carousel-item>
    ...
</sbb-carousel>

Properties

Slots