@schukai/monster 3.80.1 → 3.80.3

package/source/components/datatable/filter.mjs

@@ -162,7 +162,7 @@ class Filter extends CustomElement {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/filter@@instance");
@@ -171,7 +171,7 @@ class Filter extends CustomElement {
 	/**
 	 *
 	 * @param {string} message
-	 * @returns {Monster.Components.Datatable.Filter}
+	 * @return {Monster.Components.Datatable.Filter}
 	 */
 	showFailureMessage(message) {
 		this[searchButtonElementSymbol].setState(
@@ -186,7 +186,7 @@ class Filter extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Datatable.Filter}
+	 * @return {Monster.Components.Datatable.Filter}
 	 */
 	resetFailureMessage() {
 		this[searchButtonElementSymbol].hideMessage();
@@ -196,7 +196,7 @@ class Filter extends CustomElement {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Datatable.Filter}
+	 * @return {Monster.Components.Datatable.Filter}
 	 */
 	showSuccess() {
 		this[searchButtonElementSymbol].setState(
@@ -458,7 +458,7 @@ function initFilter() {
 /**
  *
  * @param {string} input
- * @returns {*}
+ * @return {*}
  */
 function escapeAttributeValue(input) {
 	if (input === undefined || input === null) {
@@ -476,7 +476,7 @@ function escapeAttributeValue(input) {
 /**
  *
  * @param {HTMLElement} element
- * @returns {boolean}
+ * @return {boolean}
  */
 function getVisibilityFromSlotAttribute(element) {
 	return !(
@@ -832,7 +832,7 @@ function updateFilterTabs() {
 /**
  * @private
  * @param showEffect
- * @returns {Promise<*>}
+ * @return {Promise<*>}
  */
 function doSearch({ showEffect } = { showEffect: true }) {
 	this.resetFailureMessage();
@@ -909,7 +909,7 @@ function doSearch({ showEffect } = { showEffect: true }) {
 /**
  * @private
  * @param queries
- * @returns {*|string}
+ * @return {*|string}
  */
 function buildSearchQuery(queries) {
 	if (!isArray(queries) || queries.length === 0) {
@@ -931,7 +931,7 @@ function buildSearchQuery(queries) {
 
 /**
  * @private
- * @returns {Promise<unknown>}
+ * @return {Promise<unknown>}
  */
 function collectSearchQueries() {
 	const currentHash = parseBracketedKeyValueHash(getGlobal().location.hash);
@@ -1041,7 +1041,7 @@ function collectSearchQueries() {
 /**
  * @private
  * @param label
- * @returns {null|Array|undefined|string}
+ * @return {null|Array|undefined|string}
  */
 function getControlValuesFromLabel(label) {
 	const foundControl = label.firstElementChild;
@@ -1080,7 +1080,7 @@ function getControlValuesFromLabel(label) {
 
 /**
  * @private
- * @returns {Promise<unknown>}
+ * @return {Promise<unknown>}
  */
 function initFromConfig() {
 	const host = findElementWithSelectorUpwards(this, "monster-host");

package/source/components/datatable/pagination.mjs

@@ -93,7 +93,7 @@ class Pagination extends CustomElement {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/pagination");
@@ -207,7 +207,7 @@ class Pagination extends CustomElement {
 
 	/**
 	 * @private
-	 * @returns {CSSStyleSheet}
+	 * @return {CSSStyleSheet}
 	 */
 	static getControlCSSStyleSheet() {
 		return PaginationStyleSheet;
@@ -356,7 +356,7 @@ function handleDataSourceChanges() {
  *
  * @param current
  * @param max
- * @returns  {object}
+ * @return  {object}
  */
 function buildPagination(current, max) {
 	let prev = current === 1 ? null : current - 1;

package/source/components/datatable/save-button.mjs

@@ -61,7 +61,7 @@ const badgeElementSymbol = Symbol("badgeElement");
 class SaveButton extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

package/source/components/datatable/status.mjs

@@ -86,7 +86,7 @@ class DatasourceStatus extends CustomElement {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

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

@@ -88,7 +88,7 @@ const containerElementSymbol = Symbol("containerElement");
 class ActionButton extends PopperButton {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -130,7 +130,7 @@ class ActionButton extends PopperButton {
 	/**
 	 *
 	 * @return {Monster.Components.Form.Popper}
-	 * @event monster-action-button-show-dialog
+	 * @fires monster-action-button-show-dialog
 	 */
 	showDialog() {
 		if (this.getOption("buttons").length === 0) {

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

@@ -101,7 +101,7 @@ const containerElementSymbol = Symbol("containerElement");
 class ApiButton extends ActionButton {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/api-button@@instance");

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

@@ -155,7 +155,7 @@ const ATTRIBUTE_POPPER_POSITION = "data-monster-popper-position";
  * @copyright schukai GmbH
  * @memberOf Monster.Components.Form
  * @summary A configurable tab control
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
  */
 
 /**
@@ -173,7 +173,7 @@ const ATTRIBUTE_POPPER_POSITION = "data-monster-popper-position";
 class ButtonBar extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/button-bar@@instance");
@@ -324,7 +324,7 @@ class ButtonBar extends CustomElement {
 /**
  * @private
  * @param obj
- * @returns {*}
+ * @return {*}
  */
 function initDefaultsFromAttributes(obj) {
 	if (this.hasAttribute(ATTRIBUTE_POPPER_POSITION)) {

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

@@ -104,7 +104,7 @@ const cancelButtonElementSymbol = Symbol("cancelButtonElement");
 class ConfirmButton extends PopperButton {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -192,7 +192,7 @@ class ConfirmButton extends PopperButton {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Form.PopperButton}
+	 * @return {Monster.Components.Form.PopperButton}
 	 */
 	showDialog() {
 		const confirmButtonClass = this.getOption("classes.confirmButton");
@@ -219,7 +219,7 @@ class ConfirmButton extends PopperButton {
 	 *
 	 * @param {string} state
 	 * @param {number} timeout
-	 * @returns {Monster.Components.Form.ConfirmButton}
+	 * @return {Monster.Components.Form.ConfirmButton}
 	 */
 	setConfirmButtonState(state, timeout) {
 		this[confirmButtonElementSymbol].setState(state, timeout);
@@ -231,7 +231,7 @@ class ConfirmButton extends PopperButton {
 	 *
 	 * @param {string} message
 	 * @param {number} timeout
-	 * @returns {Monster.Components.Form.ConfirmButton}
+	 * @return {Monster.Components.Form.ConfirmButton}
 	 */
 	showConfirmButtonMessage(message, timeout) {
 		this[confirmButtonElementSymbol].setMessage(message);

package/source/components/form/context-error.mjs

@@ -80,7 +80,7 @@ class ContextError extends Popper {
 	/**
 	 * This method is called by the `instanceof` operator.
 	 *
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -157,7 +157,7 @@ class ContextError extends Popper {
 	 *
 	 * @param message
 	 * @param show {boolean|number|string} - If true the dialog is shown immediately. If false the dialog is hidden by default. If a number is specified the dialog is shown for the specified time in milliseconds.
-	 * @returns {ContextError}
+	 * @return {ContextError}
 	 */
 	setErrorMessage(message, show = false) {
 		message = message.trim();
@@ -191,7 +191,7 @@ class ContextError extends Popper {
 
 	/**
 	 * Reset the error message.
-	 * @returns {ContextError}
+	 * @return {ContextError}
 	 */
 	resetErrorMessage() {
 		this.hideDialog();
@@ -202,7 +202,7 @@ class ContextError extends Popper {
 
 	/**
 	 * Returns true if an error message is set.
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	hasErrorMessage() {
 		const c = this.getOption("content");

package/source/components/form/context-help.mjs

@@ -34,7 +34,7 @@ export { ContextHelp };
 class ContextHelp extends Popper {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

package/source/components/form/field-set.mjs

@@ -81,7 +81,7 @@ const extendedSwitchElementSymbol = Symbol("extendedSwitchElement");
 class FieldSet extends CustomControl {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/fieldset@@instance");
@@ -275,7 +275,7 @@ function updateColumns() {
 /**
  * @private
  * @return {initEventHandler}
- * @fires event:monster-field-set-clicked
+ * @fires monster-field-set-clicked
  */
 function initEventHandler() {
 	this[toggleSwitchElementSymbol].setOption(

package/source/components/form/form.mjs

@@ -130,7 +130,7 @@ class Form extends DataSet {
 	/**
 	 * This method is called when the component is created.
 	 * @since 3.70.0
-	 * @returns {DataSet}
+	 * @return {DataSet}
 	 */
 	refresh() {
 		this.write();
@@ -142,7 +142,7 @@ class Form extends DataSet {
 	 * Run reportValidation on all child html form controls.
 	 *
 	 * @since 2.10.0
-	 * @returns {boolean}
+	 * @return {boolean}
 	 */
 	reportValidity() {
 		let valid = true;
@@ -166,7 +166,7 @@ function initDataSourceHandler() {}
 
 /**
  * @private
- * @returns {initEventHandler}
+ * @return {initEventHandler}
  */
 function initEventHandler() {
 	this[debounceBindSymbol] = {};

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

@@ -87,7 +87,7 @@ const buttonElementSymbol = Symbol("buttonElement");
 class MessageStateButton extends Popper {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(
@@ -193,7 +193,7 @@ class MessageStateButton extends Popper {
 	 * @param {string|HTMLElement}message
 	 * @param {string} title
 	 * @param {string} icon
-	 * @returns {Monster.Components.Form.MessageStateButton}
+	 * @return {Monster.Components.Form.MessageStateButton}
 	 */
 	setMessage(message, title, icon) {
 		if (isString(message)) {
@@ -243,7 +243,7 @@ class MessageStateButton extends Popper {
 
 	/**
 	 * @param {number} timeout
-	 * @returns {Monster.Components.Form.MessageStateButton}
+	 * @return {Monster.Components.Form.MessageStateButton}
 	 */
 	showMessage(timeout) {
 		super.showDialog();
@@ -259,7 +259,7 @@ class MessageStateButton extends Popper {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Form.MessageStateButton}
+	 * @return {Monster.Components.Form.MessageStateButton}
 	 */
 	hideMessage() {
 		super.hideDialog();
@@ -268,7 +268,7 @@ class MessageStateButton extends Popper {
 
 	/**
 	 *
-	 * @returns {Monster.Components.Form.MessageStateButton}
+	 * @return {Monster.Components.Form.MessageStateButton}
 	 */
 	toggleMessage() {
 		super.toggleDialog();
@@ -277,7 +277,7 @@ class MessageStateButton extends Popper {
 
 	/**
 	 *
-	 * @returns {Object}
+	 * @return {Object}
 	 */
 	getMessage() {
 		return this.getOption("message");

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

@@ -144,7 +144,7 @@ const arrowElementSymbol = Symbol("arrowElement");
 class PopperButton extends Popper {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/components/form/reload.mjs

@@ -91,23 +91,6 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
  * </monster-reload>
  * ```
  *
- * @startuml reload.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- CustomControl
- * CustomControl <|-- Reload
- * @enduml
- *
- * @copyright schukai GmbH
- * @memberOf Monster.Components.Form
- * @summary A reload control
- * @fires Monster.Components.event:m
- */
-
-/**
- * A reload control.
- *
  * @fragments /fragments/components/form/reload/
  *
  * @example /examples/components/form/reload-simple
@@ -115,12 +98,12 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
  * @since 1.13.0
  * @copyright schukai GmbH
  * @summary A beautiful reload control
- * @fires onster-fetched
+ * @fires monster-fetched
  */
 class Reload extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -208,7 +191,7 @@ class Reload extends CustomElement {
 	 * @throws {Error} request failed
 	 * @throws {Error} not found
 	 * @throws {Error} undefined status or type
-	 * @fires Monster.Components.event:monster-fetched
+	 * @fires monster-fetched
 	 * @return {Monster.Components.Form.Form}
 	 */
 	[assembleMethodSymbol]() {
@@ -277,7 +260,7 @@ function initOptionsFromArguments() {
  * @throws {Error} request failed
  * @throws {Error} not found
  * @throws {Error} undefined status or type
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
  */
 function initIntersectionObserver() {
 	if (this[intersectionObserverWasInitialized] === true) {
@@ -326,7 +309,7 @@ function initIntersectionObserver() {
  * @throws {Error} undefined status or type
  * @throws {TypeError} value is not an instance of
  * @throws {TypeError} value is not a string
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
  * @return {Promise}
  */
 function loadContent() {

package/source/components/form/select.mjs

@@ -274,13 +274,12 @@ const FILTER_POSITION_INLINE = "inline";
  *
  * @fragments /fragments/components/form/select/
  *
- * @example /examples/components/form/select-simple
- * @example /examples/components/form/select-with-options
+ * @example /examples/components/form/select-with-options Select with options
+ * @example /examples/components/form/select-multiple Multiple selection
+ * @example /examples/components/form/select-lazy Lazy load
  *
  * @copyright schukai GmbH
  * @summary A beautiful select control that can make your life easier and also looks good.
- * @fires monster-options-set
- * @fires monster-selected
  * @fires monster-change
  * @fires monster-changed
  */
@@ -295,7 +294,7 @@ class Select extends CustomControl {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {Symbol}
+	 * @return {Symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/select@@instance");
@@ -311,7 +310,7 @@ class Select extends CustomControl {
 	 * // ↦ ['1','2']
 	 * ```
 	 *
-	 * @returns {string}
+	 * @return {string}
 	 */
 	get value() {
 		return convertSelectionToValue.call(this, this.getOption("selection"));
@@ -335,6 +334,7 @@ class Select extends CustomControl {
 	 *
 	 * @property {string|array} value
 	 * @throws {Error} unsupported type
+	 * @fires monster-selected this event is fired when the selection is set
 	 */
 	set value(value) {
 		const result = convertValueToSelection.call(this, value);
@@ -555,7 +555,7 @@ class Select extends CustomControl {
 
 	/**
 	 *
-	 * @returns {*}
+	 * @return {*}
 	 * @throws {Error} storeFetchedData is not enabled
 	 * @since 3.66.0
 	 */
@@ -745,6 +745,7 @@ class Select extends CustomControl {
 	 * @return {Select}
 	 * @throws {Error} map is not iterable
 	 * @throws {Error} missing label configuration
+	 * @fires monster-options-set this event is fired when the options are set
 	 */
 	importOptions(data) {
 		const mappingOptions = this.getOption("mapping", {});
@@ -1168,7 +1169,7 @@ function getDefaultTranslation() {
 
 /**
  * @private
- * @returns {string|*}
+ * @return {string|*}
  */
 function setSummaryAndControlText() {
 	const translations = getDefaultTranslation.call(this);
@@ -1493,7 +1494,7 @@ function handleFilterKeyboardEvents(event) {
  * @name handleFilterKeyEvents
  *
  * @private
- * @returns {void} This method does not return anything.
+ * @return {void} This method does not return anything.
  */
 function handleFilterKeyEvents() {
 	if (this[keyFilterEventSymbol] instanceof DeadMansSwitch) {
@@ -1629,7 +1630,7 @@ function handleOptionKeyboardEvents(event) {
 
 /**
  * @private
- * @returns {string}
+ * @return {string}
  */
 function getFilterMode() {
 	switch (this.getOption("filter.mode")) {

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

@@ -33,7 +33,7 @@ export { ShadowReload };
 class ShadowReload extends Reload {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/monster/components/form/shadow-reload");

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

@@ -36,7 +36,7 @@ export { StateButton };
 class StateButton extends Button {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/components/form/template.mjs

@@ -52,7 +52,7 @@ const intersectionObserverWasInitialized = Symbol("wasInitialized");
 class Template extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {
@@ -138,7 +138,7 @@ class Template extends CustomElement {
 	 * @throws {Error} request failed
 	 * @throws {Error} not found
 	 * @throws {Error} undefined status or type
-	 * @fires Monster.Components.event:monster-fetched
+	 * @fires monster-fetched
 	 * @return {Monster.Components.Form.Form}
 	 */
 	[assembleMethodSymbol]() {
@@ -224,7 +224,7 @@ function initOptionsFromArguments() {
  * @throws {Error} request failed
  * @throws {Error} not found
  * @throws {Error} undefined status or type
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
  */
 function initIntersectionObserver() {
 	if (this[intersectionObserverWasInitialized] === true) {
@@ -270,7 +270,7 @@ function initIntersectionObserver() {
  * @throws {Error} undefined status or type
  * @throws {TypeError} value is not an instance of
  * @throws {TypeError} value is not a string
- * @fires Monster.Components.event:monster-fetched
+ * @fires monster-fetched
  */
 function loadContent() {
 	if (!this.shadowRoot) {

package/source/components/form/toggle-switch.mjs

@@ -295,7 +295,7 @@ class ToggleSwitch extends CustomControl {
 
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for(

package/source/components/form/tree-select.mjs

@@ -70,7 +70,7 @@ const keyEventHandler = Symbol("keyEventHandler");
 class TreeSelect extends Select {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 * @since 2.1.0
 	 */
 	static get [instanceSymbol]() {

package/source/components/form/util/floating-ui.mjs

@@ -34,7 +34,7 @@ export { positionPopper };
  * @param controlElement
  * @param popperElement
  * @param options
- * @returns {Promise|*}
+ * @return {Promise|*}
  */
 function positionPopper(controlElement, popperElement, options) {
 	const body = getDocument().body;

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

@@ -88,7 +88,7 @@ const ATTRIBUTE_CALL = `${ATTRIBUTE_PREFIX}call`;
 class CallButton extends CustomElement {
 	/**
 	 * This method is called by the `instanceof` operator.
-	 * @returns {symbol}
+	 * @return {symbol}
 	 */
 	static get [instanceSymbol]() {
 		return Symbol.for("@schukai/component-host/call-button@@instance");