[TASK] Remove the detail property from custom events

Author: deoostfrees

README.md

@@ -300,14 +300,6 @@ The following events are available:
 | `close` | Triggered after Parvus has been closed |
 | `destroy` | Triggered after Parvus has been destroyed |
 
-Except for the `close` and `destroy` events, you can access the current source element using the `event.detail.source` property.
-
-```js
-prvs.on('open', function (event) {
-  console.log(event.detail.source);
-})
-```
-
 ## Browser Support
 
 Parvus is supported on the latest versions of the following browsers:

dist/js/parvus.esm.js

@@ -465,9 +465,7 @@ function Parvus(userOptions) {
     preload(currentIndex - 1);
 
     // Create and dispatch a new event
-    fire('open', {
-      source: el
-    });
+    dispatchCustomEvent('open');
   };
 
   /**
@@ -742,11 +740,7 @@ function Parvus(userOptions) {
     updateCounter();
 
     // Create and dispatch a new event
-    fire('select', {
-      detail: {
-        source: GROUPS[activeGroup].triggerElements[currentIndex]
-      }
-    });
+    dispatchCustomEvent('select');
   };
 
   /**
@@ -1313,7 +1307,7 @@ function Parvus(userOptions) {
     LIGHTBOX_TRIGGER_ELS.forEach(remove);
 
     // Create and dispatch a new event
-    fire('destroy');
+    dispatchCustomEvent('destroy');
   };
 
   /**
@@ -1347,11 +1341,9 @@ function Parvus(userOptions) {
    * Dispatch a custom event
    *
    * @param {String} type - The type of the event to dispatch
-   * @param {Function} event - The event object
    */
-  const fire = (type, event = {}) => {
+  const dispatchCustomEvent = type => {
     const CUSTOM_EVENT = new CustomEvent(type, {
-      detail: event,
       cancelable: true
     });
     lightbox.dispatchEvent(CUSTOM_EVENT);

dist/js/parvus.esm.min.js

@@ -471,9 +471,7 @@
       preload(currentIndex - 1);
 
       // Create and dispatch a new event
-      fire('open', {
-        source: el
-      });
+      dispatchCustomEvent('open');
     };
 
     /**
@@ -748,11 +746,7 @@
       updateCounter();
 
       // Create and dispatch a new event
-      fire('select', {
-        detail: {
-          source: GROUPS[activeGroup].triggerElements[currentIndex]
-        }
-      });
+      dispatchCustomEvent('select');
     };
 
     /**
@@ -1319,7 +1313,7 @@
       LIGHTBOX_TRIGGER_ELS.forEach(remove);
 
       // Create and dispatch a new event
-      fire('destroy');
+      dispatchCustomEvent('destroy');
     };
 
     /**
@@ -1353,11 +1347,9 @@
      * Dispatch a custom event
      *
      * @param {String} type - The type of the event to dispatch
-     * @param {Function} event - The event object
      */
-    const fire = (type, event = {}) => {
+    const dispatchCustomEvent = type => {
       const CUSTOM_EVENT = new CustomEvent(type, {
-        detail: event,
         cancelable: true
       });
       lightbox.dispatchEvent(CUSTOM_EVENT);

dist/js/parvus.js

@@ -445,9 +445,7 @@ export default function Parvus (userOptions) {
     preload(currentIndex - 1)
 
     // Create and dispatch a new event
-    fire('open', {
-      source: el
-    })
+    dispatchCustomEvent('open')
   }
 
   /**
@@ -775,11 +773,7 @@ export default function Parvus (userOptions) {
     updateCounter()
 
     // Create and dispatch a new event
-    fire('select', {
-      detail: {
-        source: GROUPS[activeGroup].triggerElements[currentIndex]
-      }
-    })
+    dispatchCustomEvent('select')
   }
 
   /**
@@ -1375,7 +1369,7 @@ export default function Parvus (userOptions) {
     LIGHTBOX_TRIGGER_ELS.forEach(remove)
 
     // Create and dispatch a new event
-    fire('destroy')
+    dispatchCustomEvent('destroy')
   }
 
   /**
@@ -1409,11 +1403,9 @@ export default function Parvus (userOptions) {
    * Dispatch a custom event
    *
    * @param {String} type - The type of the event to dispatch
-   * @param {Function} event - The event object
    */
-  const fire = (type, event = {}) => {
+  const dispatchCustomEvent = (type) => {
     const CUSTOM_EVENT = new CustomEvent(type, {
-      detail: event,
       cancelable: true
     })
 

dist/js/parvus.min.js

@@ -1,8 +1,13 @@
 /**
- * Import language file
+ * Import Parvus
  *
  */
 import Parvus from '../dist/js/parvus.esm.min.js'
+
+/**
+ * Import language file
+ *
+ */
 import de from '../src/l10n/de.js'
 
 /**
@@ -36,25 +41,22 @@ setTimeout(() => {
  * Events
  *
  */
-prvs.on('open', (event) => {
-  console.log(`
-    Opened by: ${event.detail.source}
-    at index: ${prvs.currentIndex()},
-    selected slide: ${prvs.currentIndex() + 1}
-  `)
+prvs.on('open', () => {
+  console.log(`Open:
+    Index: ${prvs.currentIndex()},
+    Slide: ${prvs.currentIndex() + 1}`)
 })
 
 prvs.on('select', () => {
-  console.log(`
-    Selected index: ${prvs.currentIndex()},
-    selected slide: ${prvs.currentIndex() + 1}
-  `)
+  console.log(`Select:
+    Index: ${prvs.currentIndex()},
+    Slide: ${prvs.currentIndex() + 1}`)
 })
 
 prvs.on('close', () => {
-  console.log('Closed')
+  console.log('Close')
 })
 
 prvs.on('destroy', () => {
-  console.log('Destroyed')
+  console.log('Destroy')
 })