This article covers a Bloomreach Experience Manager version 11. There's an updated version available that covers our most recent release.

Carousel Component

Class Name

The Carousel Component is implemented by the class



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 Channel 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 currently unused.
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 Component parameters (see above) for use in the rendering template.
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?

    We rely on cookies

    to optimize our communication and to enhance your customer experience. By clicking on the Accept and Close button, you agree to the collection of cookies. You can also adjust your preferences by clicking on Manage Preferences. For more information please see our Privacy policy.

    Manage cookies
    Accept & close

    Cookies preferences

    Accept & close