Files
Sith/core/static/bundled/utils/web-components.ts

78 lines
2.3 KiB
TypeScript

/**
* Class decorator to register components easily
* It's a wrapper around window.customElements.define
* What's nice about it is that you don't separate the component registration
* and the class definition
**/
export function registerComponent(name: string, options?: ElementDefinitionOptions) {
return (component: CustomElementConstructor) => {
try {
window.customElements.define(name, component, options);
} catch (e) {
if (e instanceof DOMException) {
console.warn(e.message);
return;
}
throw e;
}
};
}
/**
* Abstract class used to create HTML tags inheriting from HTMLElements
* You should not use this class outside of typing !
*
* Please, see the `inheritHtmlElement` factory if you want to use this class.
**/
export abstract class InheritedHtmlElement<
K extends keyof HTMLElementTagNameMap,
> extends HTMLElement {
abstract readonly inheritedTagName: K;
protected node: HTMLElementTagNameMap[K];
connectedCallback(autoAddNode?: boolean) {
this.node = document.createElement(this.inheritedTagName);
const attributes: Attr[] = []; // We need to make a copy to delete while iterating
for (const attr of this.attributes) {
if (attr.name in this.node) {
attributes.push(attr);
}
}
for (const attr of attributes) {
this.removeAttributeNode(attr);
this.node.setAttributeNode(attr);
}
this.node.innerHTML = this.innerHTML;
this.innerHTML = "";
// Automatically add node to DOM if autoAddNode is true or unspecified
if (autoAddNode === undefined || autoAddNode) {
this.appendChild(this.node);
}
}
}
/**
* Safari doesn't support inheriting from HTML tags on web components
* The technique is to:
* create a new web component
* create the desired type inside
* pass all attributes to the child component
* store is at as `node` inside the parent
*
* Since we can't use the generic type to instantiate the node, we create a generator function
*
* ```js
* class MyClass extends inheritHtmlElement("select") {
* // do whatever
* }
* ```
**/
export function inheritHtmlElement<K extends keyof HTMLElementTagNameMap>(tagName: K) {
return class InheritedHtmlElementImpl extends InheritedHtmlElement<K> {
readonly inheritedTagName = tagName;
};
}