@schukai/monster 4.75.0 → 4.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/source/dom/util.mjs +70 -0
- package/test/cases/dom/util.mjs +27 -2
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"author":"Volker Schukai","dependencies":{"@floating-ui/dom":"^1.7.4","@popperjs/core":"^2.11.8"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","homepage":"https://monsterjs.org/","keywords":["framework","web","dom","css","sass","mobile-first","app","front-end","templates","schukai","core","shopcloud","alvine","monster","buildmap","stack","observer","observable","uuid","node","nodelist","css-in-js","logger","log","theme"],"license":"AGPL 3.0","main":"source/monster.mjs","module":"source/monster.mjs","name":"@schukai/monster","repository":{"type":"git","url":"https://gitlab.schukai.com/oss/libraries/javascript/monster.git"},"type":"module","version":"4.
|
|
1
|
+
{"author":"Volker Schukai","dependencies":{"@floating-ui/dom":"^1.7.4","@popperjs/core":"^2.11.8"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","homepage":"https://monsterjs.org/","keywords":["framework","web","dom","css","sass","mobile-first","app","front-end","templates","schukai","core","shopcloud","alvine","monster","buildmap","stack","observer","observable","uuid","node","nodelist","css-in-js","logger","log","theme"],"license":"AGPL 3.0","main":"source/monster.mjs","module":"source/monster.mjs","name":"@schukai/monster","repository":{"type":"git","url":"https://gitlab.schukai.com/oss/libraries/javascript/monster.git"},"type":"module","version":"4.76.0"}
|
package/source/dom/util.mjs
CHANGED
|
@@ -23,6 +23,7 @@ export {
|
|
|
23
23
|
getContainingDocument,
|
|
24
24
|
getRegisteredCustomElements,
|
|
25
25
|
findElementWithSelectorUpwards,
|
|
26
|
+
waitForCustomElement,
|
|
26
27
|
};
|
|
27
28
|
|
|
28
29
|
/**
|
|
@@ -323,3 +324,72 @@ function getRegisteredCustomElements() {
|
|
|
323
324
|
|
|
324
325
|
return Array.from(new Set(customElementTags));
|
|
325
326
|
}
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* Waits until a specific custom element instance is defined and upgraded.
|
|
330
|
+
*
|
|
331
|
+
* @param {HTMLElement} element
|
|
332
|
+
* @param {Object} [options]
|
|
333
|
+
* @param {string} [options.method] - Optional method to wait for on the instance.
|
|
334
|
+
* @param {string} [options.tagName] - Optional tag name override.
|
|
335
|
+
* @param {number|null} [options.timeout=2000] - Timeout in ms; set null to disable.
|
|
336
|
+
* @return {Promise<HTMLElement>}
|
|
337
|
+
* @since 4.1.0
|
|
338
|
+
*/
|
|
339
|
+
function waitForCustomElement(
|
|
340
|
+
element,
|
|
341
|
+
{ method = null, tagName = null, timeout = 2000 } = {},
|
|
342
|
+
) {
|
|
343
|
+
if (!(element instanceof HTMLElement)) {
|
|
344
|
+
return Promise.reject(
|
|
345
|
+
new Error("Invalid argument. Expected an HTMLElement."),
|
|
346
|
+
);
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
const name = (tagName || element.tagName || "").toLowerCase();
|
|
350
|
+
if (!name.includes("-")) {
|
|
351
|
+
return Promise.reject(
|
|
352
|
+
new Error("Invalid argument. Expected a custom element tag name."),
|
|
353
|
+
);
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
const window = getWindow();
|
|
357
|
+
const registry = window.customElements;
|
|
358
|
+
if (!registry) {
|
|
359
|
+
return Promise.reject(new Error("customElements is not supported."));
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
return registry.whenDefined(name).then(
|
|
363
|
+
() =>
|
|
364
|
+
new Promise((resolve, reject) => {
|
|
365
|
+
if (typeof registry.upgrade === "function") {
|
|
366
|
+
registry.upgrade(element);
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
const start = Date.now();
|
|
370
|
+
const check = () => {
|
|
371
|
+
if (!method || typeof element[method] === "function") {
|
|
372
|
+
resolve(element);
|
|
373
|
+
return;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
if (
|
|
377
|
+
typeof timeout === "number" &&
|
|
378
|
+
timeout >= 0 &&
|
|
379
|
+
Date.now() - start > timeout
|
|
380
|
+
) {
|
|
381
|
+
reject(
|
|
382
|
+
new Error(
|
|
383
|
+
`Timed out waiting for "${method}" on <${name}>.`,
|
|
384
|
+
),
|
|
385
|
+
);
|
|
386
|
+
return;
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
window.requestAnimationFrame(check);
|
|
390
|
+
};
|
|
391
|
+
|
|
392
|
+
window.requestAnimationFrame(check);
|
|
393
|
+
}),
|
|
394
|
+
);
|
|
395
|
+
}
|
package/test/cases/dom/util.mjs
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
|
-
getDocument,
|
|
2
|
+
getDocument,
|
|
3
|
+
getWindow,
|
|
4
|
+
getDocumentFragmentFromString,
|
|
5
|
+
waitForCustomElement,
|
|
3
6
|
} from "../../../source/dom/util.mjs";
|
|
4
7
|
|
|
5
8
|
import {getContainingDocument} from "../../../source/dom/util.mjs";
|
|
@@ -111,5 +114,27 @@ describe('DOM', function () {
|
|
|
111
114
|
expect(containingDocument).to.be.null;
|
|
112
115
|
});
|
|
113
116
|
});
|
|
117
|
+
|
|
118
|
+
describe('waitForCustomElement()', () => {
|
|
119
|
+
it('should resolve for a specific instance once defined', async () => {
|
|
120
|
+
const tagName = `test-tabs-${Date.now()}`;
|
|
121
|
+
const element = document.createElement(tagName);
|
|
122
|
+
document.body.appendChild(element);
|
|
123
|
+
|
|
124
|
+
const promise = waitForCustomElement(element, { method: 'ping' });
|
|
125
|
+
|
|
126
|
+
class TestTabs extends HTMLElement {
|
|
127
|
+
ping() {
|
|
128
|
+
return 'pong';
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
customElements.define(tagName, TestTabs);
|
|
133
|
+
|
|
134
|
+
const ready = await promise;
|
|
135
|
+
expect(ready).to.equal(element);
|
|
136
|
+
expect(ready.ping()).to.equal('pong');
|
|
137
|
+
});
|
|
138
|
+
});
|
|
114
139
|
|
|
115
|
-
});
|
|
140
|
+
});
|