Carousel Component carousel-component
The Core Component Carousel Component allows the content author to present content in a navigable carousel.
Usage 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 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 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 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 deep-linking
The Carousel, Tabs, and Accordion Components support linking directly to a panel within the component.
To do this:
- View the page with the component using the View as Published option in the page editor.
- Inspect the content of the page and identify the ID of the panel.
- For example
id="carousel-bfe4fa6647-item-47f1a7ca67-tabpanel"
- For example
- 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
- For example
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 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 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
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.
Properties Tab properties-tab
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.
Accessibility Tab accessibility-tab
On the Accessibility tab, values can be set for ARIA accessibility labels for the component.
- Label - Value of an aria-label attribute for the carousel, which describes the carousel’s content
- Previous - Value of an aria-label attribute for the carousel navigation’s previous button label
- Next - Value of an aria-label attribute for the carousel navigation’s next button label
- Play - Value of an aria-label attribute for the carousel navigation’s play button label
- Pause - Value of an aria-label attribute for the carousel navigation’s pause button label
- Tablist - Value of an aria-label attribute for the carousel navigation’s list of items label
- Set item’s aria label to its title - If checked, this option automatically sets the carousel items title to its aria-label description.
Select Panel select-panel
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.
Design Dialog design-dialog
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.
Properties Tab properties-tab-1
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.
- Prepend control elements - When checked, the control elements will be placed in front of the carousel items to improve accessibility.
Allowed Components Tab 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.
Styles Tab styles-tab
The Carousel Component supports the AEM Style System.
Adobe Client Data Layer data-layer
The Carousel Component supports the Adobe Client Data Layer.