Skip to main content

au-widget-image-carousel/IImageCarouselConfig

Interfaces​

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

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.

images​
images: IImage[];

An array of images.

imageSelectorAlignment​
imageSelectorAlignment: string;
imageSelectorPosition​
imageSelectorPosition: string;

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

lightbox: boolean;

If true, enables the lightbox.

onChange?​
optional onChange?: Function[];

Functions, that executed after current image changed.

preloader​
preloader: IImageCarouselPreloaderConfig;

carousel preloader settings

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.

IImageCarouselPreloaderConfig​

Preloader configuration

Properties​

enabled​
enabled: boolean;

if true, show preloader while images not loaded

loadedCountToHide?​
optional loadedCountToHide?: number;

Number of loaded images enough to hide preloader

text?​
optional text?: string;

Preloader message

Was this page helpful?