tech(core basepattern): Provide emit_update helper method on pattern instances to easily emit a pat-update event and already fill the most important properties. Expects an optional action parameter and an optional options object.

Author: thet

src/core/basepattern.js

@@ -104,6 +104,16 @@ class BasePattern {
         // Extend this method in your pattern.
     }
 
+    emit_update(action = undefined, options = {}) {
+        options = {
+            pattern: this.name,
+            dom: this.el,
+            action: action,
+            ...options,
+        }
+        this.el.dispatchEvent(events.update_event(options));
+    }
+
     /**
      * Listen to an event on the element only once.
      *

src/core/basepattern.test.js

@@ -364,4 +364,29 @@ describe("Basepattern class tests", function () {
         // If test reaches this expect statement, the init event catched.
         expect(true).toBe(true);
     });
+
+    it("7 - Emit update event.", async function () {
+        const events = (await import("./events")).default;
+        class Pat extends BasePattern {
+            static name = "example";
+            static trigger = ".example";
+        }
+
+        const el = document.createElement("div");
+        el.classList.add("example");
+
+        const pat = new Pat(el);
+        await events.await_pattern_init(pat);
+
+        let event;
+        el.addEventListener("pat-update", (e) => {
+            event = e;
+        });
+
+        pat.emit_update("test");
+
+        expect(event.detail.pattern).toBe("example");
+        expect(event.detail.dom).toBe(el);
+        expect(event.detail.action).toBe("test");
+    });
 });