Merge pull request #1080 from Patternslib/basepattern-await-init

Basepattern await init

Author: thet

src/core/base.js

@@ -46,7 +46,7 @@ const initBasePattern = function ($el, options, trigger) {
 };
 
 const Base = async function ($el, options, trigger) {
-    if (!$el) {
+    if (($el?.jquery && $el.length === 0) || !$el) {
         log.warn("No element given to pattern.");
         return;
     }

src/core/base.test.js

@@ -69,6 +69,17 @@ describe("pat-base: The Base class for patterns", function () {
         expect(tmp.el).toBeFalsy();
     });
 
+    it("Does nothing when initialized with an empty jQuery object", function () {
+        const Tmp = Base.extend({
+            name: "example",
+            init: () => {},
+        });
+        const tmp = new Tmp($());
+        expect(tmp instanceof Tmp).toBeTruthy();
+        expect(tmp.$el).toBeFalsy();
+        expect(tmp.el).toBeFalsy();
+    });
+
     it("will automatically register a pattern in the registry when extended", function () {
         jest.spyOn(registry, "register");
         var NewPattern = Base.extend({

src/core/basepattern.js

@@ -71,6 +71,18 @@ class BasePattern {
     init() {
         // Extend this method in your pattern.
     }
+
+    /**
+     * Listen to an event on the element only once.
+     *
+     * @param {string} event_name - Name of the event to listen to.
+     * @param {function} callback - Callback to call when the event is thrown.
+     */
+    one(event_name, event_callback) {
+        this.el.addEventListener(`${event_name}.${this.name}.patterns`, event_callback, {
+            once: true,
+        });
+    }
 }
 
 export default BasePattern;

src/core/basepattern.test.js

@@ -143,4 +143,21 @@ describe("Basepattern class tests", function () {
         // gh-copilot wrote this line.
         expect(el["pattern-example"]).toBeInstanceOf(Pat);
     });
+
+    it("6.1 - Registers a one-time event listener on the element.", 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);
+
+        // If test reaches this expect statement, the init event catched.
+        expect(true).toBe(true);
+    });
 });

src/core/events.test.js

@@ -1,4 +1,5 @@
 import Base from "./base";
+import { BasePattern } from "./basepattern";
 import events from "./events";
 import utils from "./utils";
 
@@ -77,6 +78,22 @@ describe("core.events tests", () => {
             // If test reaches this expect statement, all is fine.
             expect(true).toBe(true);
         });
+
+        it("Awaits a class based pattern to be initialized", async () => {
+            class Pat extends BasePattern {
+                static name = "tmp";
+                static trigger = ".pat-tmp";
+                init() {}
+            }
+
+            const el = document.createElement("div");
+            const instance = new Pat(el);
+
+            await events.await_pattern_init(instance);
+
+            // If test reaches this expect statement, all is fine.
+            expect(true).toBe(true);
+        });
     });
 
     describe("2 - event factories", () => {