@flowplayer/spins 0.1.0-rc.7 → 0.1.0-rc.8

package/dist/types.d.ts

@@ -13,6 +13,10 @@ declare const SPIN_CREATED = "spin:created";
  * Emitted when a different spin enters the viewport.
  */
 declare const SPIN_IN_VIEWPORT = "spin:viewport";
+/**
+ * Should be emitted in order to add more spins dynamically.
+ */
+declare const ADD_SPINS = "spins:add";
 
 /**
  * All supported plugin identifiers for configuring the player.
@@ -48,28 +52,38 @@ type SpinEventData = {
     config: SpinItem;
     spin: HTMLElement;
 };
+type AddSpinsEventData = SpinItem[];
 interface SpinsContainer extends HTMLDivElement {
     /**
-     * Ads a listener for the SpinsEvents["SPIN_CREATED"] event
+     * Adds a listener for the SpinsEvents["SPIN_CREATED"] event
      */
     on(e: typeof SPIN_CREATED, handler: (e: CustomEvent<SpinEventData>) => void, options?: boolean | AddEventListenerOptions): void;
     /**
-     * Ads a listener for the SpinsEvents["SPIN_IN_VIEWPORT"] event.
+     * Adds a listener for the SpinsEvents["SPIN_IN_VIEWPORT"] event.
      */
     on(e: typeof SPIN_IN_VIEWPORT, handler: (e: CustomEvent<SpinEventData>) => void, options?: boolean | AddEventListenerOptions): void;
     /**
      * Removes a listener for the SpinsEvents["SPIN_IN_VIEWPORT"] event
      */
-    off<T>(e: typeof SPIN_IN_VIEWPORT, handler: (e: CustomEvent<T>) => void): void;
+    off(e: typeof SPIN_IN_VIEWPORT, handler: (e: CustomEvent<SpinEventData>) => void): void;
     /**
      * Removes a listener for the SpinsEvents["SPIN_CREATED"] event
      */
-    off<T>(e: typeof SPIN_CREATED, handler: (e: CustomEvent<T>) => void): void;
+    off(e: typeof SPIN_CREATED, handler: (e: CustomEvent<SpinEventData>) => void): void;
+    /**
+     * Triggers dynamic addition of new spins
+     */
+    emit(e: typeof ADD_SPINS, data: AddSpinsEventData): void;
+    /**
+     * All the spins events.
+     */
+    events: typeof events;
 }
 declare const events: {
     SPIN_IN_VIEWPORT: typeof SPIN_IN_VIEWPORT;
     SPIN_CREATED: typeof SPIN_CREATED;
+    ADD_SPINS: typeof ADD_SPINS;
 };
 declare function createSpins(config: SpinsConfig): SpinsContainer;
 
-export { type SpinEventData, type SpinItem, type SpinsConfig, type SpinsContainer, createSpins, events };
+export { type AddSpinsEventData, type SpinEventData, type SpinItem, type SpinsConfig, type SpinsContainer, createSpins, events };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flowplayer/spins",
   "module": "dist/index.js",
-  "version": "0.1.0-rc.7",
+  "version": "0.1.0-rc.8",
   "type": "module",
   "types": "./dist/types.d.ts",
   "exports": {