@inappstory/react-sdk 1.8.0-rc.1 → 1.8.0-rc.2

package/plugins/banners/types/bannerPlace.d.ts

@@ -6,16 +6,22 @@ import { BannerPlaceAppearance } from "./bannerPlaceAppearance";
  * @enum {string}
  */
 export enum BannerPlaceViewModelEvent {
-    /** Emitted when playback starts */
-    Play = "play",
-    /** Emitted when playback stops */
-    Stop = "stop",
     /** Emitted when banner loading starts */
     LoadStart = "loadStart",
     /** Emitted when banner loading completes */
     LoadEnd = "loadEnd",
     /** Emitted when banner loading fails */
-    LoadError = "loadError"
+    LoadError = "loadError",
+    /** Emitted when changed active banner */
+    ActiveIndexChange = "activeIndexChange",
+    /** Emitted before transition to the next slide after the duration has elapsed */
+    AutoplayTimeLeft = "autoplayTimeLeft",
+    /** Emitted when the banner is in the viewport and started. */
+    ShowBanner = "showBanner",
+    /** Emitted when the banner is in the viewport and error occurs on start. */
+    ShowBannerFailed = "showBannerFailed",
+    /** Emitted when interacting with banner widgets */
+    BannerWidget = "bannerWidget"
 }
 
 /**
@@ -135,6 +141,12 @@ export interface BannerPlace {
      */
     get activeIndex(): number;
 
+    /**
+     * Gets pagination bullets length
+     * @returns {number}
+     */
+    get paginationBullets(): number;
+
     /**
      * Sets the slider controller implementation
      * @param {IBannerPlaceSliderController} sliderController - The slider controller to use
@@ -148,14 +160,31 @@ export interface BannerPlace {
     updateAppearance(appearance: BannerPlaceAppearance): void;
 
     /**
-     * Starts playback of all banners
+     * Resume autoplay
      */
-    play(): void;
+    resume(): void;
 
     /**
-     * Stops playback of all banners
+     * Pause autoplay
      */
-    stop(): void;
+    pause(): void;
+
+    /**
+     * Run transition to next slide.
+     */
+    showNext(): void;
+
+    /**
+     * Run transition to previous slide.
+     */
+    showPrevious(): void;
+
+    /**
+     * Run transition to the slide by index
+     * @param {number} index - Slide index
+     * @param {number} speed - Transition duration
+     */
+    showByIndex(index: number, speed?: number): void;
 
     /**
      * Reloads banners for this place
@@ -181,6 +210,11 @@ export interface BannerPlace {
      * @emits BannerPlaceViewModelEvent.LoadStart
      * @emits BannerPlaceViewModelEvent.LoadEnd
      * @emits BannerPlaceViewModelEvent.LoadError
+     * @emits BannerPlaceViewModelEvent.ActiveIndexChange
+     * @emits BannerPlaceViewModelEvent.AutoplayTimeLeft
+     * @emits BannerPlaceViewModelEvent.ShowBanner
+     * @emits BannerPlaceViewModelEvent.ShowBannerFailed
+     * @emits BannerPlaceViewModelEvent.BannerWidget
      */
     fetchBanners(): Promise<Banner[]>;
 }

package/plugins/banners/types/iasBannerPlace.d.ts

@@ -52,6 +52,18 @@ interface IasBannerPlaceProps {
      */
     onLoadError?: (error: Error) => void;
 
+    /**
+     * Callback triggered when when changed active banner
+     * @optional
+     */
+    onActiveIndexChange?: () => void;
+
+    /**
+     * Callback triggered before transition to the next slide after the duration has elapsed
+     * @optional
+     */
+    onAutoplayTimeLeft?: () => void;
+
     /**
      * Callback triggered when banner place is ready
      * @param {BannerPlace} bannerPlace - The initialized banner place instance