Convert DroppableEvent to typescript

Shopify · Oct 4, 2023 · a0c3c90 · a0c3c90
1 parent 7734961
commit a0c3c90
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 5 deletions.
diff --git a/.changeset/spicy-clouds-tickle.md b/.changeset/spicy-clouds-tickle.md
@@ -0,0 +1,5 @@
+---
+'@shopify/draggable': patch
+---
+
+Convert DroppableEvent to typescript
diff --git a/...roppable/DroppableEvent/DroppableEvent.js → ...roppable/DroppableEvent/DroppableEvent.ts b/...roppable/DroppableEvent/DroppableEvent.js → ...roppable/DroppableEvent/DroppableEvent.ts
@@ -1,14 +1,31 @@
 import AbstractEvent from 'shared/AbstractEvent';
 
+import {DragEvent, DragEventData} from '../../Draggable/DragEvent';
+
+interface DroppableEventData {
+  dragEvent: DragEvent<DragEventData>;
+}
+
 /**
  * Base droppable event
  * @class DroppableEvent
  * @module DroppableEvent
  * @extends AbstractEvent
  */
-export class DroppableEvent extends AbstractEvent {
+export class DroppableEvent<
+  T extends DroppableEventData,
+> extends AbstractEvent<DroppableEventData> {
   static type = 'droppable';
 
+  /**
+   * DroppableEvent constructor.
+   * @constructs DroppableEvent
+   * @param {DroppableEventData} data - Event data
+   */
+  constructor(public data: T) {
+    super(data);
+  }
+
   /**
    * Original drag event that triggered this droppable event
    * @property dragEvent
@@ -20,13 +37,17 @@ export class DroppableEvent extends AbstractEvent {
   }
 }
 
+interface DroppableStartEventData extends DroppableEventData {
+  dropzone: HTMLElement;
+}
+
 /**
  * Droppable start event
  * @class DroppableStartEvent
  * @module DroppableStartEvent
  * @extends DroppableEvent
  */
-export class DroppableStartEvent extends DroppableEvent {
+export class DroppableStartEvent extends DroppableEvent<DroppableStartEventData> {
   static type = 'droppable:start';
   static cancelable = true;
 
@@ -41,13 +62,17 @@ export class DroppableStartEvent extends DroppableEvent {
   }
 }
 
+interface DroppableDroppedEventData extends DroppableEventData {
+  dropzone: HTMLElement;
+}
+
 /**
  * Droppable dropped event
  * @class DroppableDroppedEvent
  * @module DroppableDroppedEvent
  * @extends DroppableEvent
  */
-export class DroppableDroppedEvent extends DroppableEvent {
+export class DroppableDroppedEvent extends DroppableEvent<DroppableDroppedEventData> {
   static type = 'droppable:dropped';
   static cancelable = true;
 
@@ -62,13 +87,17 @@ export class DroppableDroppedEvent extends DroppableEvent {
   }
 }
 
+interface DroppableReturnedEventData extends DroppableEventData {
+  dropzone: HTMLElement;
+}
+
 /**
  * Droppable returned event
  * @class DroppableReturnedEvent
  * @module DroppableReturnedEvent
  * @extends DroppableEvent
  */
-export class DroppableReturnedEvent extends DroppableEvent {
+export class DroppableReturnedEvent extends DroppableEvent<DroppableReturnedEventData> {
   static type = 'droppable:returned';
   static cancelable = true;
 
@@ -83,13 +112,17 @@ export class DroppableReturnedEvent extends DroppableEvent {
   }
 }
 
+interface DroppableStopEventData extends DroppableEventData {
+  dropzone: HTMLElement;
+}
+
 /**
  * Droppable stop event
  * @class DroppableStopEvent
  * @module DroppableStopEvent
  * @extends DroppableEvent
  */
-export class DroppableStopEvent extends DroppableEvent {
+export class DroppableStopEvent extends DroppableEvent<DroppableStopEventData> {
   static type = 'droppable:stop';
   static cancelable = true;
 

diff --git a/src/Droppable/DroppableEvent/index.js → src/Droppable/DroppableEvent/index.ts b/src/Droppable/DroppableEvent/index.js → src/Droppable/DroppableEvent/index.ts