Carousel Component
Class Name
The Carousel Component is provided by the following class:
org.onehippo.cms7.essentials.components.EssentialsCarouselComponent
Overview
The Carousel Component exposes up to six related documents as Java beans to the rendering template. Editors select these documents manually, typically using the Channel Editor in Bloomreach Content.
The component also supplies carousel-specific parameters to the rendering template through the cparam rendering attribute.
Component Parameters
The following parameters control the behavior and appearance of the Carousel Component:
| Name | Description |
|---|---|
| documentX | X is an integer from 1 to 6. Each value is a repository path to a document handle, relative to the site's content root. If the path does not resolve to a document, it is ignored. |
| pause | Boolean flag. When enabled (default), the carousel pauses when the user hovers over it. |
| cycle | Boolean flag. When enabled (default), the carousel loops back to the first document after the last document. |
| carouselHeight | Height of the carousel in pixels. Default is 250. |
| carouselWidth | Width of the carousel in pixels. Default is 700. This parameter is currently not used. |
| interval | Time in milliseconds between carousel transitions. Default is 5000 (5 seconds). |
| carouselBackgroundColor | CSS-compatible background color for the carousel. Default is "#FFFFFF" (white). |
| showNavigation | Boolean flag. When enabled (default), navigation links for previous/next documents are displayed. |
Rendering Attributes
The Carousel Component provides the following rendering attributes to the template:
| Name | Type | Description |
|---|---|---|
| pageable | org.onehippo.cms7.essentials.components.paging.Pageable | A pageable collection of HippoDocuments for display in the carousel. Access the documents with pageable.items. |
| cparam | org.onehippo.cms7.essentials.components.info.EssentialsCarouselComponentInfo | The component parameters, as described above, available for use in the rendering template. |
| configuredItems | java.util.List<java.lang.Integer> | List of configured document item numbers. For example, if document 1 and 3 are selected, the list is [1, 3]. |
| freeItems | java.util.List<java.lang.Integer> | List of document item numbers that are not configured. |