This module extends the standard Carousel to
ensure that only one item is shown at a time in the carousel (regardless of available horizontal space). It
was written to display document
modules that can render previews of individual items.
- Copyright:
- Copyright (C) 2005-2020 Alfresco Software Limited
- License:
- GNU Lesser General Public License, see: Open Source Licensing
- Source:
Members
-
cssRequirements :object[]
-
An array of the CSS files to use with this widget.
Type:
- object[]
- Default Value:
- [{cssFile:"./css/DocumentCarousel.css"}]
- Source:
-
<readonly> defaultNextArrow :object
-
This is the default next arrow for the DocumentCarousel. It can be overridden using the nextArrow property. It should not be used directly.
Type:
- object
- Since:
- 1.0.41
- Source:
-
<readonly> defaultPrevArrow :object
-
This is the default previous arrow for the DocumentCarousel. It can be overridden using the previousArrow property. It should not be used directly.
Type:
- object
- Since:
- 1.0.41
- Source:
Methods
-
calculateSizes()
-
Extends the inherited function to ensure that only 1 item is shown at a time.
-
onNextClick()
-
Extends the inherited function to publish the current item index. This is done so that when used in the filmstrip view the content carousel is kept up-to-date.
-
onPrevClick()
-
Extends the inherited function to publish the current item index. This is done so that when used in the filmstrip view the content carousel is kept up-to-date.
-
postCreate()
-
Calls processWidgets
-
renderDisplayedItems()
-
Extends the inherited function to publish a topic indicating that the items being played should be stopped.
- Since:
- 1.0.51
- Source:
Fires:
-
resize()
-
Extends the inherited function to set the width of each item DOM node to the viewing frame.