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"
          }
        ]
      }
    }
  ]
}

Package: ui-framework

Properties

arrowButtonsEnabled

If true, enables arrow buttons next to the main image.

Declaration

arrowButtonsEnabled: boolean

Property Value

Type	Description
boolean	If true, enables arrow buttons next to the main image.

autoPlay

An image switching speed, in milliseconds. By default, this value is 0, and the autoplay is disabled.

Declaration

autoPlay: number

Property Value

Type	Description
number	An image switching speed, in milliseconds. By default, this value is 0, and the autoplay is disabled.

containerColor

The color of the image container.

Declaration

containerColor: string

Property Value

Type	Description
string	The color of the image container.

images

An array of images.

Declaration

images: Array<IImage>

Property Value

Type	Description
Array<IImage>	An array of images.

imageSelectorAlignment

Declaration

imageSelectorAlignment: string

Property Value

Type	Description
string

imageSelectorPosition

The position of the tumbnails (either "left", "bottom", "right", or "none").

Declaration

imageSelectorPosition: string

Property Value

Type	Description
string	The position of the tumbnails (either "left", "bottom", "right", or "none").

lightbox

If true, enables the lightbox.

Declaration

lightbox: boolean

Property Value

Type	Description
boolean	If true, enables the lightbox.

onChange

Functions, that executed after current image changed.

Declaration

onChange?: Function[]

Property Value

Type	Description
Function[]	Functions, that executed after current image changed.

preloader

carousel preloader settings

Declaration

preloader: IImageCarouselPreloaderConfig

Property Value

Type	Description
IImageCarouselPreloaderConfig	carousel preloader settings

resetIndexOnUpdate

If true, the first image will be selected when the image list is updated.

Declaration

resetIndexOnUpdate: boolean

Property Value

Type	Description
boolean	If true, the first image will be selected when the image list is updated.

showImageHeader

If true, image headers appear in the carousel.

Declaration

showImageHeader: boolean

Property Value

Type	Description
boolean	If true, image headers appear in the carousel.

showIndex

If true, an image number appears in the list (for example, 1/5).

Declaration

showIndex: boolean

Property Value

Type	Description
boolean	If true, an image number appears in the list (for example, 1/5).

timestamp

If true, enables the timestamp.

Declaration

timestamp: boolean

Property Value

Type	Description
boolean	If true, enables the timestamp.