Developer Docs /Backend Development /Delivery Tier /Component Development /Standard Components /Carousel Component
Carousel Component
Class Name
The Carousel Component is implemented by the class
org.onehippo.cms7.essentials.components.EssentialsCarouselComponent
Purpose
This component makes a number of related documents (max 6) available as Java beans to the rendering template. All documents are hand-picked, preferably in the Experience manager's channel editor.
The component also makes a few carousel-specific parameters available to the rendering code by means of the "cparam" rendering attribute.
Component Parameters
| Name | Description |
| documentX | X represents a number between 1 and 6 (inclusive). The value represents the repository path to the document (handle), relative to the site's content root. If the path doesn't map to a document, it is silently ignored. |
| pause | Flag indicating whether the carousel should pause or not upon hovering over it. Turned on by default. |
| cycle | Flag indicating whether or not the carousel should start over with the first document after reaching the last document. Turned on by default. |
| carouselHeight | Height (in pixel) of the carousel. Set to 250 by default. |
| carouselWidth | Width (in pixel) of the carousel. Set to 700 by default. This parameter is currentlyunused. |
| interval | Interval (in milliseconds) between swipes. Set to 5000 (5 seconds) by default. |
| carouselBackgroundColor | CSS compatible indication of the color to use as the carousel's background. By default, "#FFFFFF" (white) is used. |
| showNavigation | Flag indicating whether the carousel should display navigation links for viewing the previous/next document. Turned on by default. |
Rendering Attributes
| Name | Type | Description |
| pageable | org.onehippo.cms7.essentials.components.paging.Pageable<HippoDocument> | A pageable collection containing all HippoDocuments to be shown on the carousel. "pageable.items" are the documents to show on the carousel. |
| cparam | org.onehippo.cms7.essentials.components.info.EssentialsCarouselComponentInfo | Component parameters (see above) for use in the rendering template. |
| configuredItems | java.util.List<java.lang.Integer> | List of the document items that are configured. E.g. if document 1 and 3 are selected, the list is "1,3". |
| freeItems | java.util.List<java.lang.Integer> | List of the document items that are not configured. |