au-widget-image-carousel/au-widget-image-carousel

Classes

AuWidgetImageCarousel

A widget that is used to display multiple images arranged as an image carousel.

For details, you can refer to the ImageCarousel widget topic.

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

Extends

AuBaseWidget

Implements

IRestorableWidget

Constructors

Constructor

new AuWidgetImageCarousel(): AuWidgetImageCarousel;

Returns

AuWidgetImageCarousel

Inherited from

AuBaseWidget.constructor

Properties

_isLoaded

_isLoaded: boolean = false;

indicates if widget got initial params and subscribed on au-responsive-images 'load' event

currentImageTitle

currentImageTitle: string = "";

The title of the current image.

images

images: IImage[] = [];

An array of images displayed in the widget.

imagesCount

imagesCount: number = 0;

The number of images displayed in the widget.

params

params: IImageCarouselConfig;

Properties of the widget.

Overrides

AuBaseWidget.params

Methods

backImage()

backImage(): void;

go to previous image

Returns

void

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

Returns an array of widget names, due to which the current widget cannot receive parameters.

Returns

string[]

Inherited from

AuBaseWidget.checkInitDependenciesWidgets

exportWidgetData()

exportWidgetData(force): Promise<ImageCarouselData>;

Parameters

Parameter	Type
`force`	`boolean`

Returns

Promise<ImageCarouselData>

Implementation of

IRestorableWidget.exportWidgetData

loadedCountChanged()

loadedCountChanged(): void;

Returns

void

nextImage()

nextImage(): void;

go to next image

Returns

void

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

AuBaseWidget.resetPreloaderState

restoreWidgetFromData()

restoreWidgetFromData(widgetData, force): Promise<void>;

Parameters

Parameter	Type
`widgetData`	`ImageCarouselData`
`force`	`boolean`

Returns

Promise<void>

Implementation of

IRestorableWidget.restoreWidgetFromData

selectImage()

selectImage(index): void;

select image by index

Parameters

Parameter	Type	Description
`index`	`number`	-

Returns

void

showPreloader()

showPreloader(
   isPreload, 
   message?, 
   timeout?): void;

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Parameters

Parameter	Type	Default value	Description
`isPreload`	`boolean`	`undefined`	If `true`, enables the preloader.
`message`	`string` \| `string`[]	`...`	A text message that appears next to the preloader.
`timeout`	`number`	`5`	-

Returns

void

Inherited from

AuBaseWidget.showPreloader

showToast()

showToast(data?, duration?): void;

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Parameters

Parameter	Type	Description
`data?`	`string`	A string message to display in the toast.
`duration?`	`number`	Defines how long to show the toast for.

Returns

void

Inherited from

AuBaseWidget.showToast

References

Renames and re-exports AuWidgetImageCarousel

Classes​