UI Framework Reference › IImageCarouselConfig

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

• arrowButtonsEnabled: boolean

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:50

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

autoPlay

• autoPlay: number

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:48

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

containerColor

• containerColor: string

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:42

The color of the image container.

imageSelectorPosition

• imageSelectorPosition: string

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:40

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

images

• images: Array‹IImage›

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:32

An array of images.

• lightbox: boolean

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:34

If true, enables the lightbox.

resetIndexOnUpdate

• resetIndexOnUpdate: boolean

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:36

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

showImageHeader

• showImageHeader: boolean

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:46

If true, image headers appear in the carousel.

showIndex

• showIndex: boolean

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:44

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

timestamp

• timestamp: boolean

Defined in src/widgets/au-widget-image-carousel/IImageCarouselConfig.ts:38

If true, enables the timestamp.