@schukai/monster 3.80.2 → 3.80.3

package/source/components/host/config-manager.mjs

@@ -90,7 +90,7 @@ const MODE_READ_WRITE = "readwrite";
 class ConfigManager extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/component-host/config-manager@@instance");
@@ -109,7 +109,7 @@ class ConfigManager extends CustomElement {
 	}
 
 	/**
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	ready() {
 		return Promise.all(this[initializedPromiseSymbol]);
@@ -142,7 +142,7 @@ class ConfigManager extends CustomElement {
 
 	/**
 	 * @param {string} key
-	 * @returns {Promise<unknown>}
+	 * @return {Promise<unknown>}
 	 */
 	getConfig(key) {
 		return this.ready().then(() => {
@@ -152,7 +152,7 @@ class ConfigManager extends CustomElement {
 
 	/**
 	 * @param {string} key
-	 * @returns {Promise<boolean>}
+	 * @return {Promise<boolean>}
 	 */
 	hasConfig(key) {
 		return this.ready()
@@ -170,7 +170,7 @@ class ConfigManager extends CustomElement {
 	/**
 	 * @param {string} key
 	 * @param {*} value
-	 * @returns {Promise<unknown>}
+	 * @return {Promise<unknown>}
 	 */
 	setConfig(key, value) {
 		return this.ready().then(() => {
@@ -266,7 +266,7 @@ function getObjectStore(mode) {
 }
 
 /**
- * @returns {Promise<unknown>}
+ * @return {Promise<unknown>}
  */
 function clearObjectStore() {
 	const store = getObjectStore.call(this, "readwrite");

package/source/components/host/host.mjs

@@ -113,7 +113,7 @@ const resourceManagerSymbol = Symbol("resourceManager");
 class Host extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/component-host/Host@@instance");
@@ -139,7 +139,7 @@ class Host extends CustomElement {
 
 	/**
 	 * @param key
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	getConfig(key) {
 		if (this[configManagerElementSymbol] instanceof HTMLElement === false) {
@@ -166,7 +166,7 @@ class Host extends CustomElement {
 	 *
 	 * @param {string} key
 	 * @param {*} value
-	 * @returns {Promise}
+	 * @return {Promise}
 	 */
 	setConfig(key, value) {
 		if (this[configManagerElementSymbol] instanceof HTMLElement === false) {
@@ -287,7 +287,7 @@ class Host extends CustomElement {
 
 	/**
 	 * @see {@link https://monsterjs.org/en/doc/monster/Monster.DOM.FocusManager.html|Monster.DOM.FocusManager}
-	 * @returns {*}
+	 * @return {*}
 	 */
 	get focusManager() {
 		return this[focusManagerSymbol];
@@ -295,7 +295,7 @@ class Host extends CustomElement {
 
 	/**
 	 * @see {@link https://monsterjs.org/en/doc/monster/Monster.DOM.ResourceManager.html|Monster.DOM.ResourceManager}
-	 * @returns {*}
+	 * @return {*}
 	 */
 	get resourceManager() {
 		return this[resourceManagerSymbol];
@@ -303,7 +303,7 @@ class Host extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Host}
+	 * @return {Monster.Components.Host.Host}
 	 * @throws {Error} There is no overlay element defined.
 	 */
 	toggleOverlay() {
@@ -358,7 +358,7 @@ class Host extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.I18n.Locale}
+	 * @return {Monster.I18n.Locale}
 	 */
 	get locale() {
 		return getLocaleOfDocument();
@@ -366,7 +366,7 @@ class Host extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Translations}
+	 * @return {Translations}
 	 */
 	get translations() {
 		return getDocumentTranslations();

package/source/components/host/overlay.mjs

@@ -104,15 +104,15 @@ const ATTRIBUTE_VALUE_OVERLAY_OPEN = "overlay-open";
  * @copyright schukai GmbH
  * @memberOf Monster.Components.Host
  * @summary A simple overlay component
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-open
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-open
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-close
- * @fires Monster.Components.Host.Overlay.event:monster-overlay-closed
+ * @fires monster-overlay-before-open
+ * @fires monster-overlay-open
+ * @fires monster-overlay-before-close
+ * @fires monster-overlay-closed
  */
 class Overlay extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/host/overlay@@instance");
@@ -182,7 +182,7 @@ class Overlay extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Overlay}
+	 * @return {Monster.Components.Host.Overlay}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -193,7 +193,7 @@ class Overlay extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Overlay}
+	 * @return {Monster.Components.Host.Overlay}
 	 */
 	toggle() {
 		if (this[overlayElementSymbol].classList.contains("open")) {
@@ -205,11 +205,11 @@ class Overlay extends CustomElement {
 	}
 
 	/**
-	 * @returns {Monster.Components.Host.Overlay}
-	 * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-open
-	 * @fires Monster.Components.Host.Overlay.event:monster-overlay-open
-	 * @fires Monster.Components.Host.Overlay.event:monster-overlay-before-close
-	 * @fires Monster.Components.Host.Overlay.event:monster-overlay-closed
+	 * @return {Monster.Components.Host.Overlay}
+	 * @fires monster-overlay-before-open
+	 * @fires monster-overlay-open
+	 * @fires monster-overlay-before-close
+	 * @fires monster-overlay-closed
 	 */
 	open() {
 		fireCustomEvent(this, "monster-overlay-before-open", {});
@@ -227,7 +227,7 @@ class Overlay extends CustomElement {
 	}
 
 	/**
-	 * @returns {Monster.Components.Host.Overlay}
+	 * @return {Monster.Components.Host.Overlay}
 	 */
 	close() {
 		fireCustomEvent(this, "monster-overlay-before-close", {});

package/source/components/host/toggle-button.mjs

@@ -62,7 +62,7 @@ export { ToggleButton };
 class ToggleButton extends CallButton {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/component-host/toggle-button@instance");

package/source/components/host/util.mjs

@@ -25,7 +25,7 @@ export { generateUniqueConfigKey };
  * @param {string} componentName - The name of the component.
  * @param {string} id - A unique identifier for the component.
  * @param {string} prefix - A prefix to use in the unique key.
- * @returns {string} The generated unique configuration key.
+ * @return {string} The generated unique configuration key.
  */
 function generateUniqueConfigKey(componentName, id, prefix) {
 	// Get the browser location without parameters

package/source/components/host/viewer.mjs

@@ -67,7 +67,7 @@ const viewerElementSymbol = Symbol("viewerElement");
 class Viewer extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/host/viewer@@instance");
@@ -209,7 +209,7 @@ class Viewer extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Viewer}
+	 * @return {Monster.Components.Host.Viewer}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -237,7 +237,7 @@ class Viewer extends CustomElement {
 /**
  * @private
  * @param variable
- * @returns {boolean}
+ * @return {boolean}
  */
 function isURL(variable) {
 	try {
@@ -251,7 +251,7 @@ function isURL(variable) {
 /**
  * @private
  * @param variable
- * @returns {boolean}
+ * @return {boolean}
  */
 function isBlob(variable) {
 	return variable instanceof Blob;
@@ -260,7 +260,7 @@ function isBlob(variable) {
 /**
  * @private
  * @param blob
- * @returns {Promise<unknown>}
+ * @return {Promise<unknown>}
  */
 function blobToText(blob) {
 	return new Promise((resolve, reject) => {

package/source/components/layout/collapse.mjs

@@ -93,7 +93,7 @@ const nameSymbol = Symbol("name");
 class Collapse extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/collapse@@instance");
@@ -143,7 +143,7 @@ class Collapse extends CustomElement {
 
 	/**
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -158,7 +158,7 @@ class Collapse extends CustomElement {
 	}
 
 	/**
-	 * @returns {void}
+	 * @return {void}
 	 */
 	connectedCallback() {
 		super.connectedCallback();
@@ -166,14 +166,14 @@ class Collapse extends CustomElement {
 	}
 
 	/**
-	 * @returns {void}
+	 * @return {void}
 	 */
 	disconnectedCallback() {
 		super.disconnectedCallback();
 	}
 
 	/**
-	 * @returns {Collapse}
+	 * @return {Collapse}
 	 */
 	toggle() {
 		if (this[detailsElementSymbol].classList.contains("active")) {
@@ -185,14 +185,14 @@ class Collapse extends CustomElement {
 	}
 
 	/**
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	isClosed() {
 		return !this[detailsElementSymbol].classList.contains("active");
 	}
 
 	/**
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	isOpen() {
 		return !this.isClosed();
@@ -200,9 +200,9 @@ class Collapse extends CustomElement {
 
 	/**
 	 * Open the collapse
-	 * @returns {Collapse}
-	 * @fires monster-collapse-before-open
-	 * @fires monster-collapse-open
+	 * @return {Collapse}
+	 * @fires monster-collapse-before-open This event is fired before the collapse is opened.
+	 * @fires monster-collapse-open This event is fired after the collapse is opened.
 	 */
 	open() {
 		let node;
@@ -244,9 +244,9 @@ class Collapse extends CustomElement {
 
 	/**
 	 * Close the collapse
-	 * @returns {Collapse}
-	 * @fires monster-collapse-before-close
-	 * @fires monster-collapse-closed
+	 * @return {Collapse}
+	 * @fires monster-collapse-before-close This event is fired before the collapse is closed.
+	 * @fires monster-collapse-closed This event is fired after the collapse is closed.
 	 */
 	close() {
 		if (!this[detailsElementSymbol].classList.contains("active")) {
@@ -284,7 +284,7 @@ class Collapse extends CustomElement {
 	/**
 	 * This method is called when the element is inserted into a document, including into a shadow tree.
 	 * @return {Collapse}
-	 * @fires event:monster-collapse-adjust-height
+	 * @fires monster-collapse-adjust-height This event is fired when the height is adjusted. As a detail, the height is passed.
 	 */
 	adjustHeight() {
 		adjustHeight.call(this);
@@ -294,8 +294,7 @@ class Collapse extends CustomElement {
 
 /**
  * @private
- * @returns {void}
- * @fires event:monster-collapse-adjust-height
+ * @return {void}
  */
 function adjustHeight() {
 	let height = 0;
@@ -336,7 +335,9 @@ function adjustHeight() {
 		"important",
 	);
 
-	fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {});
+	fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {
+		height,
+	});
 }
 
 function updateResizeObserverObservation() {
@@ -399,7 +400,7 @@ function initControlReferences() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getConfigKey() {
 	return generateUniqueConfigKey(this[nameSymbol], this.id, "state");
@@ -434,7 +435,7 @@ function updateStateConfig() {
 
 /**
  * @private
- * @returns {Promise}
+ * @return {Promise}
  */
 function initStateFromHostConfig() {
 	if (!this.getOption("features.persistState")) {

package/source/components/layout/details.mjs

@@ -55,7 +55,7 @@ const buttonEventHandlerSymbol = Symbol("buttonEventHandler");
 class Details extends Collapse {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/details@@instance");
@@ -93,7 +93,7 @@ class Details extends Collapse {
 	}
 
 	/**
-	 * @returns {void}
+	 * @return {void}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -104,7 +104,7 @@ class Details extends Collapse {
 	}
 
 	/**
-	 * @returns {void}
+	 * @return {void}
 	 */
 	connectedCallback() {
 		super.connectedCallback();
@@ -127,7 +127,7 @@ class Details extends Collapse {
 	}
 
 	/**
-	 * @returns {Array<CSSStyleSheet>}
+	 * @return {Array<CSSStyleSheet>}
 	 */
 	static getCSSStyleSheet() {
 		const css = super.getCSSStyleSheet();
@@ -210,7 +210,7 @@ function initButtonLabel() {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getConfigKey() {
 	return generateUniqueConfigKey("details", this.id, "state");

package/source/components/layout/iframe.mjs

@@ -69,7 +69,7 @@ const timerCallbackSymbol = Symbol("timerCallback");
 class Iframe extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/iframe@@instance");
@@ -191,7 +191,7 @@ function calcHeight() {
 /**
  * Calculate the maximum height of an element based on the window's inner height
  * @param element
- * @returns {*}
+ * @return {*}
  */
 function calculateMaximumHeight(element) {
 	let totalBottomBorder = 0;

package/source/components/layout/panel.mjs

@@ -57,7 +57,7 @@ const timerCallbackSymbol = Symbol("timerCallback");
 class Panel extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/panel");
@@ -84,7 +84,7 @@ class Panel extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Viewer}
+	 * @return {Monster.Components.Host.Viewer}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -152,7 +152,7 @@ function calcHeight() {
 /**
  * Calculate the maximum height of an element based on the window's inner height
  * @param element
- * @returns {*}
+ * @return {*}
  */
 function calculateMaximumHeight(element) {
 	let totalBottomBorder = 0;

package/source/components/layout/popper.mjs

@@ -98,7 +98,7 @@ const arrowElementSymbol = Symbol("arrowElement");
 class Popper extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/popper@@instance");

package/source/components/layout/slider.mjs

@@ -74,7 +74,7 @@ const ATTRIBUTE_CLONE_FROM = ATTRIBUTE_PREFIX + "clone-from";
 class Slider extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/slider@@instance");
@@ -170,7 +170,7 @@ class Slider extends CustomElement {
 	 * moves the slider to the given index
 	 *
 	 * @param index
-	 * @returns {void}
+	 * @return {void}
 	 */
 	moveTo(index) {
 		return moveTo.call(this, index);
@@ -366,7 +366,7 @@ function initCarousel() {
 
 /**
  * @private
- * @returns {{slides: unknown[], totalSlides: number}}
+ * @return {{slides: unknown[], totalSlides: number}}
  */
 function getSlidesAndTotal() {
 	const slides = Array.from(getSlottedElements.call(this, ":scope", null));
@@ -376,7 +376,7 @@ function getSlidesAndTotal() {
 
 /**
  * @private
- * @returns {number}
+ * @return {number}
  */
 function next() {
 	const { slides, totalSlides } = getSlidesAndTotal.call(this);
@@ -399,7 +399,7 @@ function next() {
 
 /**
  * @private
- * @returns {number}
+ * @return {number}
  */
 function prev() {
 	const prevIndex = this[configSymbol].currentIndex - 1;
@@ -584,7 +584,7 @@ function startDragging(e, type) {
  * @private
  * @param e
  * @param type
- * @returns {*|number|number}
+ * @return {*|number|number}
  */
 function getPositionX(e, type) {
 	return type === "mouse" ? e.pageX : e.touches[0].clientX;

package/source/components/layout/split-panel.mjs

@@ -80,7 +80,7 @@ const TYPE_HORIZONTAL = "horizontal";
 class SplitPanel extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/split-panel");
@@ -151,7 +151,7 @@ class SplitPanel extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Host.Viewer}
+	 * @return {Monster.Components.Host.Viewer}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -200,7 +200,7 @@ class SplitPanel extends CustomElement {
 
 /**
  * Set the dimensions of the panel based on the split type.
- * @fires Monster.Components.Layout.event:monster-dimension-changed
+ * @fires monster-dimension-changed
  */
 function applyPanelDimensions() {
 	const splitType = this.getOption("splitType");

package/source/components/layout/tabs.mjs

@@ -154,8 +154,7 @@ const resizeObserverSymbol = Symbol("resizeObserver");
 class Tabs extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
-	 * @since 1.10.0
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/layout/tabs");
@@ -316,7 +315,7 @@ class Tabs extends CustomElement {
 	 *
 	 * The tabs have to be named with the `data-monster-name` attribute.
 	 *
-	 * @returns {string|null}
+	 * @return {string|null}
 	 */
 	getActiveTab() {
 		const nodes = getSlottedElements.call(this);
@@ -664,14 +663,9 @@ function initEventHandler() {
 		}
 	};
 
-	/**
-	 * event:monster-tab-remove
-	 * @event Monster.Components.Layout.event:monster-tab-remove
-	 */
-
 	/**
 	 * @param {Event} event
-	 * @fires Monster.Components.Layout.event:monster-tab-remove
+	 * @fires monster-tab-remove
 	 */
 	this[removeTabEventHandler] = (event) => {
 		const element = findTargetElementFromEvent(

package/source/components/layout/width-toggle.mjs

@@ -70,7 +70,7 @@ const MODE_WIDE = "wide";
 class WidthToggle extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -106,7 +106,7 @@ class WidthToggle extends CustomElement {
 	}
 
 	/**
-	 * @returns {void}
+	 * @return {void}
 	 */
 	[assembleMethodSymbol]() {
 		super[assembleMethodSymbol]();
@@ -126,7 +126,7 @@ class WidthToggle extends CustomElement {
 
 	/**
 	 * @param {string} mode
-	 * @returns {WidthToggle}
+	 * @return {WidthToggle}
 	 * @throws {Error} no shadow-root is defined
 	 */
 	setWidth(mode) {
@@ -143,7 +143,7 @@ class WidthToggle extends CustomElement {
 	}
 
 	/**
-	 * @returns {CSSStyleSheet[]}
+	 * @return {CSSStyleSheet[]}
 	 */
 	static getCSSStyleSheet() {
 		return [WidthToggleStyleSheet];

package/source/components/navigation/table-of-content.mjs

@@ -83,7 +83,7 @@ const scrollableEventHandlerSymbol = Symbol("scrollableEventHandler");
 class TableOfContent extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -354,7 +354,7 @@ function initNavigation() {
  * Recursively creates a nested list (UL) from a list of heading elements.
  * @param {HTMLElement[]} nodeList - The list of heading elements.
  * @param {number} currentLevel - The current heading level we are processing.
- * @returns {{sublist: HTMLUListElement, lastIndex: number}} An object containing the sublist and the index of the last processed element.
+ * @return {{sublist: HTMLUListElement, lastIndex: number}} An object containing the sublist and the index of the last processed element.
  */
 function createListFromHeadings(nodeList, currentLevel = 1) {
 	const self = this;
@@ -409,7 +409,7 @@ function createListFromHeadings(nodeList, currentLevel = 1) {
 
 /**
  * @private
- * @returns {*[]}
+ * @return {*[]}
  */
 function getHeadings() {
 	const allHeadings = [];

package/source/components/notify/message.mjs

@@ -96,7 +96,6 @@ const removeEventHandlerSymbol = Symbol("removeEventHandler");
  * @copyright schukai GmbH
  * @memberOf Monster.Components.Notify
  * @summary A highly configurable select control
- * @fires Monster.Components.Notify.event:monster-xxxx
  */
 class Message extends CustomElement {
 	/**