@schukai/monster 3.64.1 → 3.65.20

package/source/components/form/popper.mjs

@@ -1,491 +1,24 @@
 /**
- * Copyright schukai GmbH and contributors 2023. All Rights Reserved.
+ * Copyright © schukai GmbH and all contributing authors, {{copyRightYear}}. All rights reserved.
  * Node module: @schukai/monster
- * 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 {
-	addAttributeToken,
-	removeAttributeToken,
-} from "../../dom/attributes.mjs";
-import { ATTRIBUTE_ROLE } from "../../dom/constants.mjs";
-import {
-	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 };
-
-/**
- * @private
- * @type {symbol}
- */
-const timerCallbackSymbol = Symbol("timerCallback");
-
-/**
- * local symbol
- * @private
- * @type {symbol}
- */
-const resizeObserverSymbol = Symbol("resizeObserver");
-
-/**
- * local symbol
- * @private
- * @type {symbol}
- */
-const closeEventHandler = Symbol("closeEventHandler");
-
-/**
- * @private
- * @type {symbol}
- */
-const controlElementSymbol = Symbol("controlElement");
-
-/**
- * @private
- * @type {symbol}
- */
-const buttonElementSymbol = Symbol("buttonElement");
-
-/**
- * local symbol
- * @private
- * @type {symbol}
- */
-const popperElementSymbol = Symbol("popperElement");
-
-/**
- * local symbol
- * @private
- * @type {symbol}
- */
-const arrowElementSymbol = Symbol("arrowElement");
-
-/**
- * This action callback executes the actions when a button is clicked.
- *
- * @callback Monster.Components.Form~exampleActionCallback
- * @param {Event} e Event
- * @memberOf Monster.Components.Form
- * @this {CustomControl}
- */
-
-/**
- * The Popper ist an element that can be used to display a popper.
  *
- * <img src="./images/popper.png">
+ * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
+ * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
  *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- * as well as [pooperjs](https://popper.js.org/docs/v2/).
+ * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
+ * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
+ * For more information about purchasing a commercial license, please contact schukai GmbH.
  *
- * You can create this control either by specifying the HTML tag <monster-popper-button />` directly in the HTML or using
- * Javascript via the `document.createElement('monster-popper');` method.
- *
- * ```html
- * <monster-popper></monster-popper>
- * ```
- *
- * Or you can create this CustomControl directly in Javascript:
- *
- * ```js
- * import {Popper} from '@schukai/component-form/source/popper.js';
- * document.createElement('monster-popper');
- * ```
- *
- * @startuml popper.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- CustomControl
- * CustomControl <|-- Popper
- * @enduml
- *
- * @copyright schukai GmbH
- * @memberOf Monster.Components.Form
- * @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/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;
-}
-
-/**
- * @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;
-		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);
-}
-
-function disconnectResizeObserver() {
-	if (this[resizeObserverSymbol] instanceof ResizeObserver) {
-		this[resizeObserverSymbol].disconnect();
-	}
-}
-
-/**
- * @private
- */
-function hide() {
-	const self = this;
-
-	fireCustomEvent(self, "monster-popper-hide", {
-		self,
-	});
-
-	self[popperElementSymbol].style.display = "none";
-	removeAttributeToken(self[controlElementSymbol], "class", "open");
-
-	setTimeout(() => {
-		fireCustomEvent(self, "monster-popper-hidden", {
-			self,
-		});
-	}, 0);
-}
-
-/**
- * @private
- * @this PopperButton
- */
-function show() {
-	const self = this;
-
-	if (self.getOption("disabled", false) === true) {
-		return;
-	}
-
-	if (self[popperElementSymbol].style.display === STYLE_DISPLAY_MODE_BLOCK) {
-		return;
-	}
-
-	fireCustomEvent(self, "monster-popper-open", {
-		self,
-	});
-
-	self[popperElementSymbol].style.visibility = "hidden";
-	self[popperElementSymbol].style.display = STYLE_DISPLAY_MODE_BLOCK;
-
-	addAttributeToken(self[controlElementSymbol], "class", "open");
-	updatePopper.call(self);
-
-	setTimeout(() => {
-		fireCustomEvent(self, "monster-popper-opened", {
-			self,
-		});
-	}, 0);
-}
-
-/**
- * @private
+ * SPDX-License-Identifier: AGPL-3.0
  */
-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", {}),
-	);
-}
+import { Popper as NewPopper } from "../layout/popper.mjs";
 
-/**
- * @private
- * @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;
-}
+export { Popper };
 
 /**
- * @private
- * @return {string}
+ * @since 1.10.0
+ * @copyright schukai GmbH
+ * @deprecated since 3.65.0 use {@link Monster.Components.Layout.Popper}
  */
-function getTemplate() {
-	// language=HTML
-	return `
-        <div data-monster-role="control" part="control">
-            <slot name="button" data-monster-role="button"></slot>
-
-            <div data-monster-role="popper" part="popper" tabindex="-1" class="monster-color-primary-1">
-                <div data-monster-role="arrow"></div>
-                <div part="content" class="flex" data-monster-replace="path:content">
-                </div>
-            </div>
-        </div>
-    `;
-}
-
-registerCustomElement(Popper);
+class Popper extends NewPopper {}

package/source/components/form/reload.mjs

@@ -1,9 +1,17 @@
 /**
- * Copyright schukai GmbH and contributors 2023. All Rights Reserved.
+ * Copyright © schukai GmbH and all contributing authors, {{copyRightYear}}. All rights reserved.
  * Node module: @schukai/monster
- * This file is licensed under the AGPLv3 License.
- * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
+ * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
+ * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
+ * For more information about purchasing a commercial license, please contact schukai GmbH.
+ *
+ * SPDX-License-Identifier: AGPL-3.0
  */
+
 import { instanceSymbol } from "../../constants.mjs";
 import { addAttributeToken } from "../../dom/attributes.mjs";
 import {
@@ -164,7 +172,7 @@ class Reload extends CustomElement {
 	}
 
 	/**
-	 *
+	 * @return {void}
 	 */
 	[initMethodSymbol]() {
 		super[initMethodSymbol]();

package/source/components/form/select.mjs

@@ -1,9 +1,17 @@
 /**
- * Copyright schukai GmbH and contributors 2023. All Rights Reserved.
+ * Copyright © schukai GmbH and all contributing authors, {{copyRightYear}}. All rights reserved.
  * Node module: @schukai/monster
- * This file is licensed under the AGPLv3 License.
- * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
+ * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
+ * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
+ * For more information about purchasing a commercial license, please contact schukai GmbH.
+ *
+ * SPDX-License-Identifier: AGPL-3.0
  */
+
 import { instanceSymbol } from "../../constants.mjs";
 import { internalSymbol } from "../../constants.mjs";
 import { buildMap } from "../../data/buildmap.mjs";
@@ -656,31 +664,34 @@ class Select extends CustomControl {
 		if (url !== undefined && url !== null) {
 			url = validateString(url);
 		}
-		
+
 		hide.call(this);
 
 		return new Promise((resolve, reject) => {
-			fetchData.call(this, url).then((map) => {
-				if (
-					isObject(map) ||
-					isArray(map) ||
-					map instanceof Set ||
-					map instanceof Map
-				) {
-					this.importOptions(map);
-					setTimeout(() => {
-						setStatusOrRemoveBadges.call(this,"closed");
-						resolve();
-					}, 10);
-					return;
-				}
+			fetchData
+				.call(this, url)
+				.then((map) => {
+					if (
+						isObject(map) ||
+						isArray(map) ||
+						map instanceof Set ||
+						map instanceof Map
+					) {
+						this.importOptions(map);
+						setTimeout(() => {
+							setStatusOrRemoveBadges.call(this, "closed");
+							resolve();
+						}, 10);
+						return;
+					}
 
-				setStatusOrRemoveBadges.call(this, "error");
-				reject(new Error("invalid response"));
-			}).catch((e) => {
-				setStatusOrRemoveBadges.call(this, "error");
-				reject(e);
-			});
+					setStatusOrRemoveBadges.call(this, "error");
+					reject(new Error("invalid response"));
+				})
+				.catch((e) => {
+					setStatusOrRemoveBadges.call(this, "error");
+					reject(e);
+				});
 		});
 	}
 
@@ -1961,15 +1972,15 @@ function fetchData(url) {
 
 	const fetchOptions = this.getOption("fetch", {});
 
-	let delayWatch=false;
-	
+	let delayWatch = false;
+
 	// if fetch short time, do not show loading badge, because of flickering
 	setTimeout(() => {
-		if(delayWatch===true) return;
+		if (delayWatch === true) return;
 		setStatusOrRemoveBadges.call(this, "loading");
-		delayWatch=true;
-	},500);
-	
+		delayWatch = true;
+	}, 500);
+
 	url = new Formatter({ filter: this.getOption("filter.defaultValue") }).format(
 		url,
 	);
@@ -1978,7 +1989,7 @@ function fetchData(url) {
 	return global
 		.fetch(url, fetchOptions)
 		.then((response) => {
-			delayWatch=true;
+			delayWatch = true;
 			const contentType = response.headers.get("content-type");
 			if (contentType && contentType.indexOf("application/json") !== -1) {
 				return response.text();
@@ -1994,7 +2005,7 @@ function fetchData(url) {
 			}
 		})
 		.catch((e) => {
-			delayWatch=true;
+			delayWatch = true;
 			throw e;
 		});
 }
@@ -2004,7 +2015,7 @@ function fetchData(url) {
  */
 function hide() {
 	this[popperElementSymbol].style.display = "none";
-	setStatusOrRemoveBadges.call(this,"closed");
+	setStatusOrRemoveBadges.call(this, "closed");
 	removeAttributeToken(this[controlElementSymbol], "class", "open");
 }
 

package/source/components/form/shadow-reload.mjs

@@ -1,9 +1,17 @@
 /**
- * Copyright schukai GmbH and contributors 2023. All Rights Reserved.
+ * Copyright © schukai GmbH and all contributing authors, {{copyRightYear}}. All rights reserved.
  * Node module: @schukai/monster
- * This file is licensed under the AGPLv3 License.
- * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
+ * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
+ * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
+ * For more information about purchasing a commercial license, please contact schukai GmbH.
+ *
+ * SPDX-License-Identifier: AGPL-3.0
  */
+
 import { instanceSymbol } from "../../constants.mjs";
 import { registerCustomElement } from "../../dom/customelement.mjs";
 import { Reload } from "./reload.mjs";

package/source/components/form/state-button.mjs

@@ -1,9 +1,17 @@
 /**
- * Copyright schukai GmbH and contributors 2023. All Rights Reserved.
+ * Copyright © schukai GmbH and all contributing authors, {{copyRightYear}}. All rights reserved.
  * Node module: @schukai/monster
- * This file is licensed under the AGPLv3 License.
- * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * This source code is licensed under the GNU Affero General Public License version 3 (AGPLv3).
+ * The full text of the license can be found at: https://www.gnu.org/licenses/agpl-3.0.en.html
+ *
+ * For those who do not wish to adhere to the AGPLv3, a commercial license is available.
+ * Acquiring a commercial license allows you to use this software without complying with the AGPLv3 terms.
+ * For more information about purchasing a commercial license, please contact schukai GmbH.
+ *
+ * SPDX-License-Identifier: AGPL-3.0
  */
+
 import { instanceSymbol } from "../../constants.mjs";
 import { registerCustomElement } from "../../dom/customelement.mjs";
 import { isInteger } from "../../types/is.mjs";