Interface: IImageCarouselConfig
Provides properties for the image-carousel
widget.
You can use these properties in params of the AuWidgetImageCarousel class.
{
"widgets": [
{
"name": "images",
"type": "image-carousel",
"params": {
"images": [
{
"title": "Front Side",
"url": "http://example.com/some/url/1/front.jpg"
},
{
"title": "Back Side",
"url": "http://example.com/some/url/1/back.jpg"
}
]
}
}
]
}
Hierarchy
- IImageCarouselConfig
Index
Properties
- arrowButtonsEnabled
- autoPlay
- containerColor
- imageSelectorPosition
- images
- lightbox
- resetIndexOnUpdate
- showImageHeader
- showIndex
- timestamp
Properties
arrowButtonsEnabled
• arrowButtonsEnabled: boolean
If true
, enables arrow buttons next to the main image.
autoPlay
• autoPlay: number
An image switching speed, in milliseconds. By default, this value is 0
, and the autoplay is disabled.
containerColor
• containerColor: string
The color of the image container.
imageSelectorPosition
• imageSelectorPosition: string
The position of the tumbnails (either "left"
, "bottom"
, "right"
, or "none"
).
images
• images: Array‹IImage›
An array of images.
lightbox
• lightbox: boolean
If true
, enables the lightbox.
resetIndexOnUpdate
• resetIndexOnUpdate: boolean
If true
, the first image will be selected when the image list is updated.
showImageHeader
• showImageHeader: boolean
If true
, image headers appear in the carousel.
showIndex
• showIndex: boolean
If true
, an image number appears in the list (for example, 1/5).
timestamp
• timestamp: boolean
If true
, enables the timestamp.