Convert CollidableEvent to typescript

Shopify · Sep 28, 2023 · bb23ff2 · bb23ff2
1 parent 9154a96
commit bb23ff2
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/.changeset/calm-kangaroos-jump.md b/.changeset/calm-kangaroos-jump.md
@@ -0,0 +1,5 @@
+---
+'@shopify/draggable': patch
+---
+
+Convert CollidableEvent to typescript
diff --git a/...idable/CollidableEvent/CollidableEvent.js → ...idable/CollidableEvent/CollidableEvent.ts b/...idable/CollidableEvent/CollidableEvent.js → ...idable/CollidableEvent/CollidableEvent.ts
@@ -1,14 +1,31 @@
 import AbstractEvent from 'shared/AbstractEvent';
 
+import {DragEvent, DragEventData} from '../../../Draggable/DragEvent';
+
+interface CollidableEventData {
+  dragEvent: DragEvent<DragEventData>;
+}
+
 /**
  * Base collidable event
  * @class CollidableEvent
  * @module CollidableEvent
  * @extends AbstractEvent
  */
-export class CollidableEvent extends AbstractEvent {
+export class CollidableEvent<
+  T extends CollidableEventData,
+> extends AbstractEvent<CollidableEventData> {
   static type = 'collidable';
 
+  /**
+   * CollidableEvent constructor.
+   * @constructs CollidableEvent
+   * @param {CollidableEventData} data - Event data
+   */
+  constructor(public data: T) {
+    super(data);
+  }
+
   /**
    * Drag event that triggered this colliable event
    * @property dragEvent
@@ -20,13 +37,17 @@ export class CollidableEvent extends AbstractEvent {
   }
 }
 
+interface CollidableInEventData extends CollidableEventData {
+  collidingElement: HTMLElement;
+}
+
 /**
  * Collidable in event
  * @class CollidableInEvent
  * @module CollidableInEvent
  * @extends CollidableEvent
  */
-export class CollidableInEvent extends CollidableEvent {
+export class CollidableInEvent extends CollidableEvent<CollidableInEventData> {
   static type = 'collidable:in';
 
   /**
@@ -40,13 +61,17 @@ export class CollidableInEvent extends CollidableEvent {
   }
 }
 
+interface CollidableOutEventData extends CollidableEventData {
+  collidingElement: HTMLElement;
+}
+
 /**
  * Collidable out event
  * @class CollidableOutEvent
  * @module CollidableOutEvent
  * @extends CollidableEvent
  */
-export class CollidableOutEvent extends CollidableEvent {
+export class CollidableOutEvent extends CollidableEvent<CollidableOutEventData> {
   static type = 'collidable:out';
 
   /**

diff --git a/...ugins/Collidable/CollidableEvent/index.js → ...ugins/Collidable/CollidableEvent/index.ts b/...ugins/Collidable/CollidableEvent/index.js → ...ugins/Collidable/CollidableEvent/index.ts