@schukai/monster 3.54.0 → 3.55.0

package/source/components/form/popper.mjs

@@ -4,27 +4,27 @@
  * This file is licensed under the AGPLv3 License.
  * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
  */
-import { instanceSymbol } from "../../constants.mjs";
+import {instanceSymbol} from "../../constants.mjs";
 import {
-	addAttributeToken,
-	removeAttributeToken,
+    addAttributeToken,
+    removeAttributeToken,
 } from "../../dom/attributes.mjs";
-import { ATTRIBUTE_ROLE } from "../../dom/constants.mjs";
+import {ATTRIBUTE_ROLE} from "../../dom/constants.mjs";
 import {
-	assembleMethodSymbol,
-	registerCustomElement,
+    assembleMethodSymbol,
+    registerCustomElement,
 } from "../../dom/customelement.mjs";
-import { fireCustomEvent } from "../../dom/events.mjs";
-import { getDocument } from "../../dom/util.mjs";
-import { DeadMansSwitch } from "../../util/deadmansswitch.mjs";
-import { Button } from "./button.mjs";
-import { STYLE_DISPLAY_MODE_BLOCK } from "./constants.mjs";
-import { positionPopper } from "./util/floating-ui.mjs";
-import { CustomControl } from "../../dom/customcontrol.mjs";
-import { PopperStyleSheet } from "./stylesheet/popper.mjs";
-import { isArray } from "../../types/is.mjs";
-
-export { Popper };
+import {fireCustomEvent} from "../../dom/events.mjs";
+import {getDocument} from "../../dom/util.mjs";
+import {DeadMansSwitch} from "../../util/deadmansswitch.mjs";
+import {Button} from "./button.mjs";
+import {STYLE_DISPLAY_MODE_BLOCK} from "./constants.mjs";
+import {positionPopper} from "./util/floating-ui.mjs";
+import {CustomControl} from "../../dom/customcontrol.mjs";
+import {PopperStyleSheet} from "./stylesheet/popper.mjs";
+import {isArray} from "../../types/is.mjs";
+
+export {Popper};
 
 /**
  * @private
@@ -116,277 +116,285 @@ const arrowElementSymbol = Symbol("arrowElement");
  * @summary A popper button
  */
 class Popper extends CustomControl {
-	/**
-	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
-	 */
-	static get [instanceSymbol]() {
-		return Symbol.for("@schukai/component-form/popper@@instance");
-	}
-
-	/**
-	 * To set the options via the html tag the attribute `data-monster-options` must be used.
-	 * @see {@link https://monsterjs.org/en/doc/#configurate-a-monster-control}
-	 *
-	 * The individual configuration values can be found in the table.
-	 *
-	 * @property {Object} templates - The templates for the control.
-	 * @property {string} templates.main - The main template.
-	 * @property {string} mode - The mode of the popper. Possible values are `click`, `enter` `hover`, `manual`, `focus`, "auto" or a combination of them.
-	 * @property {string} content - The content of the popper.
-	 * @property {object} popper - The popper options.
-	 * @property {string} popper.placement - The placement of the popper. Possible values are `top`, `bottom`, `left` and `right`.
-	 * @property {Array<function>} popper.middleware - The middleware functions of the popper.
-	 * @property {Array<function>} popper.middlewareInit - The middleware init functions of the popper.
-	 * @property {Object} features - The features of the popper.
-	 * @property {boolean} features.preventPropagateOpenEvents - Prevents the open event from being sent.
-	 * @extends {Button}
-	 */
-	get defaults() {
-		return Object.assign({}, super.defaults, {
-			templates: {
-				main: getTemplate(),
-			},
-			mode: "hover focus",
-			content: "<slot>Should I Stay or Should I Go?</slot>",
-			popper: {
-				placement: "top",
-				middleware: ["autoPlacement", "offset:10", "arrow"],
-			},
-			features: {
-				preventOpenEventSent: false,
-			},
-		});
-	}
-
-	/**
-	 *
-	 * @return {Monster.Components.Form.Popper}
-	 */
-	[assembleMethodSymbol]() {
-		super[assembleMethodSymbol]();
-		initControlReferences.call(this);
-		initEventhandler.call(this);
-
-		return this;
-	}
-
-	/**
-	 * @return {string}
-	 */
-	static getTag() {
-		return "monster-popper";
-	}
-
-	/**
-	 * @return {Array<CSSStyleSheet>}
-	 */
-	static getCSSStyleSheet() {
-		return [PopperStyleSheet];
-	}
-
-	/**
-	 * @return {void}
-	 */
-	connectedCallback() {
-		super.connectedCallback();
-
-		const document = getDocument();
-
-		for (const [, type] of Object.entries(["click", "touch"])) {
-			// close on outside ui-events
-			document.addEventListener(type, this[closeEventHandler]);
-		}
-
-		updatePopper.call(this);
-		attachResizeObserver.call(this);
-	}
-
-	/**
-	 * @return {void}
-	 */
-	disconnectedCallback() {
-		super.disconnectedCallback();
-
-		// close on outside ui-events
-		for (const [, type] of Object.entries(["click", "touch"])) {
-			document.removeEventListener(type, this[closeEventHandler]);
-		}
-
-		disconnectResizeObserver.call(this);
-	}
-
-	/**
-	 *
-	 * @return {Monster.Components.Form.Popper}
-	 */
-	showDialog() {
-		show.call(this);
-		return this;
-	}
-
-	/**
-	 *
-	 * @return {Monster.Components.Form.Popper}
-	 */
-	hideDialog() {
-		hide.call(this);
-		return this;
-	}
-
-	/**
-	 *
-	 * @return {Monster.Components.Form.Popper}
-	 */
-	toggleDialog() {
-		if (this[popperElementSymbol].style.display === STYLE_DISPLAY_MODE_BLOCK) {
-			this.hideDialog();
-		} else {
-			this.showDialog();
-		}
-		return this;
-	}
+    /**
+     * This method is called by the `instanceof` operator.
+     * @returns {symbol}
+     */
+    static get [instanceSymbol]() {
+        return Symbol.for("@schukai/monster/components/form/popper@@instance");
+    }
+
+    /**
+     * To set the options via the html tag the attribute `data-monster-options` must be used.
+     * @see {@link https://monsterjs.org/en/doc/#configurate-a-monster-control}
+     *
+     * The individual configuration values can be found in the table.
+     *
+     * @property {Object} templates - The templates for the control.
+     * @property {string} templates.main - The main template.
+     * @property {string} mode - The mode of the popper. Possible values are `click`, `enter` `hover`, `manual`, `focus`, "auto" or a combination of them.
+     * @property {string} content - The content of the popper.
+     * @property {object} popper - The popper options.
+     * @property {string} popper.placement - The placement of the popper. Possible values are `top`, `bottom`, `left` and `right`.
+     * @property {Array<function>} popper.middleware - The middleware functions of the popper.
+     * @property {Array<function>} popper.middlewareInit - The middleware init functions of the popper.
+     * @property {Object} features - The features of the popper.
+     * @property {boolean} features.preventPropagateOpenEvents - Prevents the open event from being sent.
+     * @extends {Button}
+     */
+    get defaults() {
+        return Object.assign({}, super.defaults, {
+            templates: {
+                main: getTemplate(),
+            },
+            mode: "hover focus",
+            content: "<slot>Should I Stay or Should I Go?</slot>",
+            popper: {
+                placement: "top",
+                middleware: ["autoPlacement", "offset:10", "arrow"],
+            },
+            features: {
+                preventOpenEventSent: false,
+            },
+        });
+    }
+
+    /**
+     *
+     * @return {Monster.Components.Form.Popper}
+     */
+    [assembleMethodSymbol]() {
+        super[assembleMethodSymbol]();
+        initControlReferences.call(this);
+        initEventHandler.call(this);
+
+        return this;
+    }
+
+    /**
+     * @return {string}
+     */
+    static getTag() {
+        return "monster-popper";
+    }
+
+    /**
+     * @return {Array<CSSStyleSheet>}
+     */
+    static getCSSStyleSheet() {
+        return [PopperStyleSheet];
+    }
+
+    /**
+     * @return {void}
+     */
+    connectedCallback() {
+        super.connectedCallback();
+
+        const document = getDocument();
+
+        for (const [, type] of Object.entries(["click", "touch"])) {
+            // close on outside ui-events
+            document.addEventListener(type, this[closeEventHandler]);
+        }
+
+        updatePopper.call(this);
+        attachResizeObserver.call(this);
+    }
+
+    /**
+     * @return {void}
+     */
+    disconnectedCallback() {
+        super.disconnectedCallback();
+
+        // close on outside ui-events
+        for (const [, type] of Object.entries(["click", "touch"])) {
+            document.removeEventListener(type, this[closeEventHandler]);
+        }
+
+        disconnectResizeObserver.call(this);
+    }
+
+    /**
+     *
+     * @return {Monster.Components.Form.Popper}
+     */
+    showDialog() {
+        show.call(this);
+        return this;
+    }
+
+    /**
+     *
+     * @return {Monster.Components.Form.Popper}
+     */
+    hideDialog() {
+        hide.call(this);
+        return this;
+    }
+
+    /**
+     *
+     * @return {Monster.Components.Form.Popper}
+     */
+    toggleDialog() {
+        if (this[popperElementSymbol].style.display === STYLE_DISPLAY_MODE_BLOCK) {
+            this.hideDialog();
+        } else {
+            this.showDialog();
+        }
+        return this;
+    }
 }
 
 /**
  * @private
  * @return {Monster.Components.Form.Popper}
  */
-function initEventhandler() {
-	this[closeEventHandler] = (event) => {
-		const path = event.composedPath();
-
-		for (const [, element] of Object.entries(path)) {
-			if (element === this) {
-				return;
-			}
-		}
-		hide.call(this);
-	};
-
-	let modes = null;
-	const modeOption = this.getOption("mode");
-	if (typeof modeOption === "string") {
-		modes = modeOption.split(" ");
-	}
-
-	if (
-		modes === null ||
-		modes === undefined ||
-		isArray(modes) === false ||
-		modes.length === 0
-	) {
-		modes = ["manual"];
-	}
-
-	for (const [, mode] of Object.entries(modes)) {
-		initEventHandlerByMode.call(this, mode);
-	}
-
-	return this;
+function initEventHandler() {
+    this[closeEventHandler] = (event) => {
+        const path = event.composedPath();
+
+        for (const [, element] of Object.entries(path)) {
+            if (element === this) {
+                return;
+            }
+        }
+        hide.call(this);
+    };
+
+    let modes = null;
+    const modeOption = this.getOption("mode");
+    if (typeof modeOption === "string") {
+        modes = modeOption.split(" ");
+    }
+
+    if (
+        modes === null ||
+        modes === undefined ||
+        isArray(modes) === false ||
+        modes.length === 0
+    ) {
+        modes = ["manual"];
+    }
+
+    for (const [, mode] of Object.entries(modes)) {
+        initEventHandlerByMode.call(this, mode);
+    }
+
+    return this;
 }
 
+/**
+ * @private
+ * @param mode
+ * @return {Monster.Components.Form.Popper}
+ * @throws Error
+ */
 function initEventHandlerByMode(mode) {
-	switch (mode) {
-		case "manual":
-			break;
-
-		case "focus":
-			this[buttonElementSymbol].addEventListener("focus", (event) => {
-				if (this.getOption("features.preventOpenEventSent") === true) {
-					event.preventDefault();
-				}
-				this.showDialog();
-			});
-			this[buttonElementSymbol].addEventListener("blur", (event) => {
-				if (this.getOption("features.preventOpenEventSent") === true) {
-					event.preventDefault();
-				}
-				this.hideDialog();
-			});
-			break;
-
-		case "click":
-			this[buttonElementSymbol].addEventListener("click", (event) => {
-				if (this.getOption("features.preventOpenEventSent") === true) {
-					event.preventDefault();
-				}
-				this.toggleDialog();
-			});
-			break;
-		case "enter":
-			this[buttonElementSymbol].addEventListener("mouseenter", (event) => {
-				if (this.getOption("features.preventOpenEventSent") === true) {
-					event.preventDefault();
-				}
-				this.showDialog();
-			});
-			break;
-
-		case "auto": // is hover
-			this[buttonElementSymbol].addEventListener("mouseenter", (event) => {
-				if (this.getOption("features.preventOpenEventSent") === true) {
-					event.preventDefault();
-				}
-				this.showDialog();
-			});
-			this[buttonElementSymbol].addEventListener("mouseleave", (event) => {
-				if (this.getOption("features.preventOpenEventSent") === true) {
-					event.preventDefault();
-				}
-				this.hideDialog();
-			});
-			break;
-	}
+    switch (mode) {
+        case "manual":
+            break;
+
+        case "focus":
+            this[buttonElementSymbol].addEventListener("focus", (event) => {
+                if (this.getOption("features.preventOpenEventSent") === true) {
+                    event.preventDefault();
+                }
+                this.showDialog();
+            });
+            this[buttonElementSymbol].addEventListener("blur", (event) => {
+                if (this.getOption("features.preventOpenEventSent") === true) {
+                    event.preventDefault();
+                }
+                this.hideDialog();
+            });
+            break;
+
+        case "click":
+            this[buttonElementSymbol].addEventListener("click", (event) => {
+                if (this.getOption("features.preventOpenEventSent") === true) {
+                    event.preventDefault();
+                }
+                this.toggleDialog();
+            });
+            break;
+        case "enter":
+            this[buttonElementSymbol].addEventListener("mouseenter", (event) => {
+                if (this.getOption("features.preventOpenEventSent") === true) {
+                    event.preventDefault();
+                }
+                this.showDialog();
+            });
+            break;
+
+        case "auto": // is hover
+            this[buttonElementSymbol].addEventListener("mouseenter", (event) => {
+                if (this.getOption("features.preventOpenEventSent") === true) {
+                    event.preventDefault();
+                }
+                this.showDialog();
+            });
+            this[buttonElementSymbol].addEventListener("mouseleave", (event) => {
+                if (this.getOption("features.preventOpenEventSent") === true) {
+                    event.preventDefault();
+                }
+                this.hideDialog();
+            });
+            break;
+        default:
+            throw new Error(`Unknown mode ${mode}`);
+    }
 }
 
 /**
  * @private
  */
 function attachResizeObserver() {
-	// against flickering
-	this[resizeObserverSymbol] = new ResizeObserver((entries) => {
-		if (this[timerCallbackSymbol] instanceof DeadMansSwitch) {
-			try {
-				this[timerCallbackSymbol].touch();
-				return;
-			} catch (e) {
-				delete this[timerCallbackSymbol];
-			}
-		}
-
-		this[timerCallbackSymbol] = new DeadMansSwitch(200, () => {
-			updatePopper.call(this);
-		});
-	});
-
-	this[resizeObserverSymbol].observe(this.parentElement);
+    // against flickering
+    this[resizeObserverSymbol] = new ResizeObserver((entries) => {
+        if (this[timerCallbackSymbol] instanceof DeadMansSwitch) {
+            try {
+                this[timerCallbackSymbol].touch();
+                return;
+            } catch (e) {
+                delete this[timerCallbackSymbol];
+            }
+        }
+
+        this[timerCallbackSymbol] = new DeadMansSwitch(200, () => {
+            updatePopper.call(this);
+        });
+    });
+
+    this[resizeObserverSymbol].observe(this.parentElement);
 }
 
 function disconnectResizeObserver() {
-	if (this[resizeObserverSymbol] instanceof ResizeObserver) {
-		this[resizeObserverSymbol].disconnect();
-	}
+    if (this[resizeObserverSymbol] instanceof ResizeObserver) {
+        this[resizeObserverSymbol].disconnect();
+    }
 }
 
 /**
  * @private
  */
 function hide() {
-	const self = this;
+    const self = this;
 
-	fireCustomEvent(self, "monster-popper-hide", {
-		self,
-	});
+    fireCustomEvent(self, "monster-popper-hide", {
+        self,
+    });
 
-	self[popperElementSymbol].style.display = "none";
-	removeAttributeToken(self[controlElementSymbol], "class", "open");
+    self[popperElementSymbol].style.display = "none";
+    removeAttributeToken(self[controlElementSymbol], "class", "open");
 
-	setTimeout(() => {
-		fireCustomEvent(self, "monster-popper-hidden", {
-			self,
-		});
-	}, 0);
+    setTimeout(() => {
+        fireCustomEvent(self, "monster-popper-hidden", {
+            self,
+        });
+    }, 0);
 }
 
 /**
@@ -394,51 +402,51 @@ function hide() {
  * @this PopperButton
  */
 function show() {
-	const self = this;
+    const self = this;
 
-	if (self.getOption("disabled", false) === true) {
-		return;
-	}
+    if (self.getOption("disabled", false) === true) {
+        return;
+    }
 
-	if (self[popperElementSymbol].style.display === STYLE_DISPLAY_MODE_BLOCK) {
-		return;
-	}
+    if (self[popperElementSymbol].style.display === STYLE_DISPLAY_MODE_BLOCK) {
+        return;
+    }
 
-	fireCustomEvent(self, "monster-popper-open", {
-		self,
-	});
+    fireCustomEvent(self, "monster-popper-open", {
+        self,
+    });
 
-	self[popperElementSymbol].style.visibility = "hidden";
-	self[popperElementSymbol].style.display = STYLE_DISPLAY_MODE_BLOCK;
+    self[popperElementSymbol].style.visibility = "hidden";
+    self[popperElementSymbol].style.display = STYLE_DISPLAY_MODE_BLOCK;
 
-	addAttributeToken(self[controlElementSymbol], "class", "open");
-	updatePopper.call(self);
+    addAttributeToken(self[controlElementSymbol], "class", "open");
+    updatePopper.call(self);
 
-	setTimeout(() => {
-		fireCustomEvent(self, "monster-popper-opened", {
-			self,
-		});
-	}, 0);
+    setTimeout(() => {
+        fireCustomEvent(self, "monster-popper-opened", {
+            self,
+        });
+    }, 0);
 }
 
 /**
  * @private
  */
 function updatePopper() {
-	if (this[popperElementSymbol].style.display !== STYLE_DISPLAY_MODE_BLOCK) {
-		return;
-	}
-
-	if (this.getOption("disabled", false) === true) {
-		return;
-	}
-
-	positionPopper.call(
-		this,
-		this[controlElementSymbol],
-		this[popperElementSymbol],
-		this.getOption("popper", {}),
-	);
+    if (this[popperElementSymbol].style.display !== STYLE_DISPLAY_MODE_BLOCK) {
+        return;
+    }
+
+    if (this.getOption("disabled", false) === true) {
+        return;
+    }
+
+    positionPopper.call(
+        this,
+        this[controlElementSymbol],
+        this[popperElementSymbol],
+        this.getOption("popper", {}),
+    );
 }
 
 /**
@@ -446,19 +454,19 @@ function updatePopper() {
  * @return {Monster.Components.Form.Popper}
  */
 function initControlReferences() {
-	this[controlElementSymbol] = this.shadowRoot.querySelector(
-		`[${ATTRIBUTE_ROLE}=control]`,
-	);
-	this[buttonElementSymbol] = this.shadowRoot.querySelector(
-		`[${ATTRIBUTE_ROLE}=button]`,
-	);
-	this[popperElementSymbol] = this.shadowRoot.querySelector(
-		`[${ATTRIBUTE_ROLE}=popper]`,
-	);
-	this[arrowElementSymbol] = this.shadowRoot.querySelector(
-		`[${ATTRIBUTE_ROLE}=arrow]`,
-	);
-	return this;
+    this[controlElementSymbol] = this.shadowRoot.querySelector(
+        `[${ATTRIBUTE_ROLE}=control]`,
+    );
+    this[buttonElementSymbol] = this.shadowRoot.querySelector(
+        `[${ATTRIBUTE_ROLE}=button]`,
+    );
+    this[popperElementSymbol] = this.shadowRoot.querySelector(
+        `[${ATTRIBUTE_ROLE}=popper]`,
+    );
+    this[arrowElementSymbol] = this.shadowRoot.querySelector(
+        `[${ATTRIBUTE_ROLE}=arrow]`,
+    );
+    return this;
 }
 
 /**
@@ -466,8 +474,8 @@ function initControlReferences() {
  * @return {string}
  */
 function getTemplate() {
-	// language=HTML
-	return `
+    // language=HTML
+    return `
         <div data-monster-role="control" part="control">
             <slot name="button" data-monster-role="button"></slot>