Carousel Component

Last update: June 24, 2025

CREATED FOR:

  • Developer
  • Admin
  • User

The Core Component Carousel Component allows the content author to present content in a navigable carousel.

TIP
Have you considered Edge Delivery Services for AEM?
You can continue using the methods described in this document for existing projects. However for new projects, Adobe recommends leveraging Edge Delivery Services.

Usage

Using the Carousel Component, the content author to organize content in a rotating carousel of slides.

The edit dialog allows the content author to create, name, and order multiple slides as well as enable auto-transition with delay. Using the design dialog, the template author can define which components can be added to the carousel, enable or disable automatic transitions, and customize the styles.

Version and Compatibility

The current version of the Carousel Component is v1, which was introduced with release 2.2.0 of the Core Components in October 2018, and is described in this document.

The following table details all supported versions of the component, the AEM versions with which the versions of the component is compatible, and links to documentation for previous versions.

Component Version
AEM 6.4
AEM 6.5
AEM 6.5 LTS
AEM as a Cloud Service
v1
Compatible with
release 2.17.4 and prior
Compatible
Compatible
Compatible

For more information about Core Component versions and releases, see the document Core Components Versions.

Sample Component Output

To experience the Carousel Component as well as see examples of its configuration options as well as HTML and JSON output, visit the Component Library.

Technical Details

The latest technical documentation about the Carousel Component can be found on GitHub.

Further details about developing Core Components can be found in the Core Components developer documentation.

Deep Linking to a Panel

The Carousel, Tabs, and Accordion Components support linking directly to a panel within the component.

To do this:

  1. View the page with the component using the View as Published option in the page editor.
  2. Inspect the content of the page and identify the ID of the panel.
    • For example id="carousel-bfe4fa6647-item-47f1a7ca67-tabpanel"
  3. The ID becomes the anchor you can append to the URL using a hash (#).
    • For example https://wknd.site/content/wknd/language-masters/en/magazine/western-australia.html#carousel-bfe4fa6647-item-47f1a7ca67-tabpanel

Navigating to the URL with the panel ID as anchor, the browser will scroll directly to the particular component and display the specified panel. If the panel is configured not to be displayed by default, it will be scrolled to automatically.

Carousel and Responsive Design

All Core Components are designed to be fully responsive, ensuring a seamless experience across devices.

Some some advanced components like the Carousel Component may require specific consideration within the context of the implementing project in order to maintain responsiveness in all conditions. Please see the document Responsive Design of the Core Components for more information.

Edit Dialog

The edit dialog allows the content author to add, rename, and rearrange slides as well as define the auto-transition settings.

Items Tab

Items tab of the edit dialog of the Carousel Component

Use the Add button to open the component selector to choose which component to add as a tab. Once added, an entry is added to the list, which contains the following columns:

  • Icon - The icon of the component type of the tab for easy identification in the list. Mouse over to see the full component name as a tooltip.
  • Description - The description used as the text of the tab, defaulting to the name of the component selected for the tab.
  • Delete - Tap or click to delete the tab from the tabs component.
  • Reorder - Tap or click and drag to order the tabs.
TIP
If the viewport of the page is reduced so that the edit dialog becomes full screen, the Add button will be hidden. Components can still be added to the Carousel Component by dragging from the components browser and dropping on the Carousel Component in the page editor.

Properties Tab

Properties tab of the edit dialog of the Carousel Component

On the Properties tab, the content author can set the slides to automatically transition.

  • Active Item - The content author can define which tab is active when the page is loaded.

  • Automatically transition slides - When active, the component will automatically advance to the next slide after a specified delay.

  • Transition Delay - When Automatically transition slides is selected, this value is used to define the delay between transitions (in milliseconds).

  • Disable automatic pause on hover - When Automatically transition slides is selected, the carousel transition will automatically pause whenever the cursor hovers over the carousel. Select this option so that the transition will not pause.

  • ID - This option allows to control the unique identifier of the component in the HTML and in the Data Layer.

    • If left blank, a unique ID is automatically generated for you and can be found by inspecting the resulting page.
    • If an ID is specified, it is the responsibility of the author to make sure that it is unique.
    • Changing the ID can have an impact on CSS, JS and Data Layer tracking.
NOTE
The slide advance controls are not enabled when in Edit mode. Use Preview mode or the View as Published option to interact with the carousel as a reader of the published content would.
The auto-advance feature is not enabled when in Edit mode. Use View as Published option to see the auto-advance feature as a reader of the published content would.