The Core Component Carousel Component allows the content author to present content in a navigable carousel.
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.
For more information about Core Component versions and releases, see the document Core Components Versions.
Sample Component Output
The following is a sample taken from We.Retail.
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.
The edit dialog allows the content author to add, rename, and rearrange slides as well as define the auto-transition settings.
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.
On the Properties tab, the content author can set the slides to automatically transition.
- 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.
The slide advance controls are not enabled when in Edit mode. Use Preview 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.
The content author can use the Select Panel option on the component toolbar to change to a different slide for editing as well as to easily rearrange the order of the slides.
Once selecting the Select Panel option in the component toolbar, the configured slides are displayed as a drop-down.
- The list is ordered by the assigned arrangement of the slides and is reflected in the numbering.
- The component type of the slide is displayed first, followed by the description of the slide in lighter font.
- Tapping or clicking an entry in the dropdown, switches the view in the editor to that slide.
- The slide can be reordered in-place by using the drag handles.
The design dialog allows the template author to define which components can be added as slides to the carousel component as well as define auto-transition defaults and which custom styles are available to the content author.
The Properties tab is used to define the default settings for the slide transitions when a content author adds the carousel component to a page.
- Automatically transition slides - Defines if by default the option to automatically advance the carousel to the next slide is enabled when the content author adds the carousel component to a page.
- Transition Delay - Defines the default value of the transition delay between slides (in milliseconds) when a content author adds the carousel component to a page.
- Disable automatic pause on hover - Defines if by default the option to disable the automatic slide pausing is enabled when Automatically transition slides is selected by the content author.
Allowed Components Tab
The Allowed Components tab is used to define which components can be added as slides to the Carousel Component by the content author.
The Allowed Components tab functions in the same way as the tab of the same name when defining the policy and properties of a Layout Container in the Template Editor.
The Carousel Component supports the AEM Style System.