@schukai/monster 3.86.2 → 3.86.4

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 
 
+## [3.86.4] - 2024-11-16
+
+### Bug Fixes
+
+- update darkmode and small display issues
+
+
+
+## [3.86.3] - 2024-11-15
+
+### Bug Fixes
+
+- css svg issues with darkmode, pagestepper dom datasource issue
+
+
+
 ## [3.86.2] - 2024-11-14
 
 ### Bug Fixes

package/package.json

@@ -1 +1 @@
-{"author":"schukai GmbH","dependencies":{"@floating-ui/dom":"^1.6.12","@popperjs/core":"^2.11.8"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","homepage":"https://monsterjs.org/","keywords":["framework","web","dom","css","sass","mobile-first","app","front-end","templates","schukai","core","shopcloud","alvine","monster","buildmap","stack","observer","observable","uuid","node","nodelist","css-in-js","logger","log","theme"],"license":"AGPL 3.0","main":"source/monster.mjs","module":"source/monster.mjs","name":"@schukai/monster","repository":{"type":"git","url":"https://gitlab.schukai.com/oss/libraries/javascript/monster.git"},"type":"module","version":"3.86.2"}
+{"author":"schukai GmbH","dependencies":{"@floating-ui/dom":"^1.6.12","@popperjs/core":"^2.11.8"},"description":"Monster is a simple library for creating fast, robust and lightweight websites.","homepage":"https://monsterjs.org/","keywords":["framework","web","dom","css","sass","mobile-first","app","front-end","templates","schukai","core","shopcloud","alvine","monster","buildmap","stack","observer","observable","uuid","node","nodelist","css-in-js","logger","log","theme"],"license":"AGPL 3.0","main":"source/monster.mjs","module":"source/monster.mjs","name":"@schukai/monster","repository":{"type":"git","url":"https://gitlab.schukai.com/oss/libraries/javascript/monster.git"},"type":"module","version":"3.86.4"}

package/source/components/datatable/datasource/dom.mjs

@@ -33,18 +33,6 @@ const dataChangeEventHandlerSymbol = Symbol("dataChangeEventHandler");
 /**
  * The Datasource component is a basic class for the datatable component.
  *
- * <img src="./images/dom.png">
- *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- *
- * @startuml dom.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- Datasource
- * Datasource <|-- Dom
- * @enduml
- *
  * @copyright schukai GmbH
  * @summary A dom datasource
  */
@@ -110,6 +98,9 @@ class Dom extends Datasource {
 	 */
 	reload() {}
 
+	/**
+	 * @return {void}
+	 */
 	connectedCallback() {
 		super.connectedCallback();
 

package/source/components/datatable/datasource/rest.mjs

@@ -99,36 +99,35 @@ class Rest extends Datasource {
 	}
 
 	/**
-     * 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 Template definitions
-     * @property {string} templates.main Main template
-     * @property {Object} features Feature definitions
-     * @property {boolean} features.autoInit If true, the component is initialized automatically
-     * @property {boolean} features.filter If true, the component is initialized automatically
-     * @property {Object} autoInit Auto init definitions
-     * @property {boolean} autoInit.intersectionObserver If true, the intersection observer is initialized automatically
-     * @property {boolean} autoInit.oneTime If true, the intersection observer is initialized only once
-     * @property {Object} filter Filter definitions
-     * @property {string} filter.id The id of the filter control
-     * @property {Object} datatable Datatable definitions
-     * @property {string} datatable.id The id of the datatable control
-     * @property {Object} response Response definitions
-     * @property {Object} response.path Path definitions (changed in 3.56.0)
-     * @property {string} response.path.message Path to the message (changed in 3.56.0)
-     * @property {Object} read Read configuration
-     * @property {string} read.url The url of the rest api
-     * @property {string} read.method The method of the rest api
-     * @property {Object} read.parameters The parameters of the rest api
-     * @property {Object} read.parameters.filter The filter of the rest api
-     * @property {Object} read.parameters.orderBy The order by of the rest api
-     * @property {Object} read.parameters.page The page of the rest api
-     * @property {Object} write Write configuration
-
-     */
+	 * 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 Template definitions
+	 * @property {string} templates.main Main template
+	 * @property {Object} features Feature definitions
+	 * @property {boolean} features.autoInit If true, the component is initialized automatically
+	 * @property {boolean} features.filter If true, the component is initialized automatically
+	 * @property {Object} autoInit Auto init definitions
+	 * @property {boolean} autoInit.intersectionObserver If true, the intersection observer is initialized automatically
+	 * @property {boolean} autoInit.oneTime If true, the intersection observer is initialized only once
+	 * @property {Object} filter Filter definitions
+	 * @property {string} filter.id The id of the filter control
+	 * @property {Object} datatable Datatable definitions
+	 * @property {string} datatable.id The id of the datatable control
+	 * @property {Object} response Response definitions
+	 * @property {Object} response.path Path definitions (changed in 3.56.0)
+	 * @property {string} response.path.message Path to the message (changed in 3.56.0)
+	 * @property {Object} read Read configuration
+	 * @property {string} read.url The url of the rest api
+	 * @property {string} read.method The method of the rest api
+	 * @property {Object} read.parameters The parameters of the rest api
+	 * @property {Object} read.parameters.filter The filter of the rest api
+	 * @property {Object} read.parameters.orderBy The order by of the rest api
+	 * @property {Object} read.parameters.page The page of the rest api
+	 * @property {Object} write Write configuration
+	 */
 	get defaults() {
 		const restOptions = new RestAPI().defaults;
 
@@ -175,7 +174,7 @@ class Rest extends Datasource {
 	 * @param {string} page
 	 * @param {string} query
 	 * @param {string} orderBy
-	 * @return {Monster.Components.Datatable.Datasource.Rest}
+	 * @return {Rest}
 	 */
 	setParameters({ page, query, orderBy }) {
 		const parameters = this.getOption("read.parameters");

package/source/components/datatable/datatable.mjs

@@ -88,6 +88,12 @@ export { DataTable };
  */
 const gridElementSymbol = Symbol("gridElement");
 
+/**
+ * @private
+ * @type {symbol}
+ */
+const dataControlElementSymbol = Symbol("dataControlElement");
+
 /**
  * @private
  * @type {symbol}
@@ -100,6 +106,12 @@ const gridHeadersElementSymbol = Symbol("gridHeadersElement");
  */
 const columnBarElementSymbol = Symbol("columnBarElement");
 
+/**
+ * @private
+ * @type {symbol}
+ */
+const resizeObserverSymbol = Symbol("resizeObserver");
+
 /**
  * The DataTable component is used to show the data from a data source.
  *
@@ -119,6 +131,9 @@ const columnBarElementSymbol = Symbol("columnBarElement");
  * @example /examples/components/datatable/row-mode
  * @example /examples/components/datatable/grid-template
  * @example /examples/components/datatable/overview-class
+ * @example /examples/components/datatable/datasource
+ * @example /examples/components/datatable/pagination
+ * @example /examples/components/datatable/filter
  *
  * @copyright schukai GmbH
  * @summary A beautiful and highly customizable data table. It can be used to display data from a data source.
@@ -185,7 +200,7 @@ class DataTable extends CustomElement {
 				headers: [],
 
 				responsive: {
-					breakpoint: 800,
+					breakpoint: 900,
 				},
 
 				labels: {
@@ -230,6 +245,30 @@ class DataTable extends CustomElement {
 		return "monster-datatable";
 	}
 
+	/**
+	 * @return {void}
+	 */
+	disconnectedCallback() {
+		super.disconnectedCallback();
+		if (this?.[resizeObserverSymbol] instanceof ResizeObserver) {
+			this[resizeObserverSymbol].disconnect();
+		}
+	}
+
+	/**
+	 * @return {void}
+	 */
+	connectedCallback() {
+		const self = this;
+		super.connectedCallback();
+
+		this[resizeObserverSymbol] = new ResizeObserver((entries) => {
+			updateGrid.call(self);
+		});
+
+		this[resizeObserverSymbol].observe(this.parentNode);
+	}
+
 	/**
 	 * @return void
 	 */
@@ -622,10 +661,6 @@ function updateConfigColumnBar() {
 function initEventHandler() {
 	const self = this;
 
-	getWindow().addEventListener("resize", (event) => {
-		updateGrid.call(self);
-	});
-
 	self[columnBarElementSymbol].attachObserver(
 		new Observer((e) => {
 			updateHeaderFromColumnBar.call(self);
@@ -855,9 +890,13 @@ function updateGrid() {
 	if (styles !== "") sheet.replaceSync(styles);
 	this.shadowRoot.adoptedStyleSheets = [...DataTable.getCSSStyleSheet(), sheet];
 
-	const bodyWidth = getDocument().body.getBoundingClientRect().width;
+	const bodyWidth = this.parentNode.clientWidth;
 
 	const breakpoint = this.getOption("responsive.breakpoint");
+	this[dataControlElementSymbol].classList.toggle(
+		"small",
+		bodyWidth <= breakpoint,
+	);
 
 	if (bodyWidth > breakpoint) {
 		this[gridElementSymbol].style.gridTemplateColumns =
@@ -872,7 +911,7 @@ function updateGrid() {
 
 /**
  * @private
- * @param {Monster.Components.Datatable.Header[]} headers
+ * @param {Header[]} headers
  * @param {bool} doFetch
  */
 function setDataSource({ orderBy }, doFetch) {
@@ -893,13 +932,17 @@ function setDataSource({ orderBy }, doFetch) {
 
 /**
  * @private
- * @return {Monster.Components.Datatable.Form}
+ * @return {DataTable}
  */
 function initControlReferences() {
 	if (!this.shadowRoot) {
 		throw new Error("no shadow-root is defined");
 	}
 
+	this[dataControlElementSymbol] = this.shadowRoot.querySelector(
+		"[data-monster-role=control]",
+	);
+
 	this[gridElementSymbol] = this.shadowRoot.querySelector(
 		"[data-monster-role=datatable]",
 	);

package/source/components/datatable/embedded-pagination.mjs

@@ -30,33 +30,8 @@ export { EmbeddedPagination };
 /**
  * The EmbeddedPagination component is used to show the current page and the total number of pages.
  *
- * <img src="./images/embedded-pagination.png">
- *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- *
- * You can create this control either by specifying the HTML tag <monster-datatable />` directly in the HTML or using
- * Javascript via the `document.createElement('monster-datatable');` method.
- *
- * ```html
- * <monster-pagination></monster-pagination>
- * ```
- *
- * Or you can create this CustomControl directly in Javascript:
- *
- * ```js
- * import '@schukai/component-datatable/source/pagination.mjs';
- * document.createElement('monster-pagination');
- * ```
- *
- * @startuml embedded-pagination.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- Pagination
- * @enduml
- *
  * @copyright schukai GmbH
- * @summary A datatable
+ * @summary The EmbeddedPagination extends the Pagination component and adopts the styles of the DataTable component.
  */
 class EmbeddedPagination extends Pagination {
 	/**

package/source/components/datatable/filter/input.mjs

@@ -34,42 +34,8 @@ const inputElementSymbol = Symbol("inputElement");
 /**
  * The Filter component is used to show and handle the filter values.
  *
- * <img src="./images/filter-inpu-input.png">
- *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- *
- * You can create this control either by specifying the HTML tag <monster-filter />` directly in the HTML or using
- * Javascript via the `document.createElement('monster-filter');` method.
- *
- * ```html
- * <monster-datatable-filter></monster-datatable-filter>
- * ```
- *
- * Or you can create this CustomControl directly in Javascript:
- *
- * ```js
- * import '@schukai/component-datatable/source/filter.mjs';
- * document.createElement('monster-datatable-filter');
- * ```
- *
- * The Body should have a class "hidden" to ensure that the styles are applied correctly.
- *
- * ```css
- * body.hidden {
- *    visibility: hidden;
- * }
- * ```
- *
- * @startuml filter-input.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- AbstractBase
- * AbstractBase <|-- Input
- * @enduml
- *
  * @copyright schukai GmbH
- * @summary A data set
+ * @summary The FilterInput component is used to show and handle the filter values.
  */
 class Input extends AbstractBase {
 	/**

package/source/components/datatable/filter/range.mjs

@@ -240,7 +240,7 @@ class Range extends AbstractBase {
 
 	/**
 	 *
-	 * @return {Monster.Datatable.Filter.Range}
+	 * @return {Range}
 	 */
 	showDialog() {
 		show.call(this);
@@ -249,7 +249,7 @@ class Range extends AbstractBase {
 
 	/**
 	 *
-	 * @return {Monster.Datatable.Filter.Range}
+	 * @return {Range}
 	 */
 	hideDialog() {
 		hide.call(this);
@@ -258,7 +258,7 @@ class Range extends AbstractBase {
 
 	/**
 	 *
-	 * @return {Monster.Datatable.Filter.Range}
+	 * @return {Range}
 	 */
 	toggleDialog() {
 		if (this[popperElementSymbol].style.display === STYLE_DISPLAY_MODE_BLOCK) {

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

@@ -20,44 +20,10 @@ import { ToggleButton } from "../host/toggle-button.mjs";
 export { FilterButton };
 
 /**
- * The Filter Button component is used to show and handle the filter values.
- *
- * <img src="./images/filter-button.png">
- *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- *
- * You can create this control either by specifying the HTML tag <monster-filter-button />` directly in the HTML or using
- * Javascript via the `document.createElement('monster-filter-button');` method.
- *
- * ```html
- * <monster-datatable-filter-button></monster-datatable-filter-button>
- * ```
- *
- * Or you can create this CustomControl directly in Javascript:
- *
- * ```js
- * import '@schukai/component-datatable/source/filter.mjs';
- * document.createElement('monster-datatable-filter-button');
- * ```
- *
- * The Body should have a class "hidden" to ensure that the styles are applied correctly.
- *
- * ```css
- * body.hidden {
- *    visibility: hidden;
- * }
- * ```
- *
- * @startuml filter-button.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- ToggleButton
- * ToggleButton <|-- FilterButton
- * @enduml
+ * A FilterButton is a button that can be used to show the filter.
  *
  * @copyright schukai GmbH
- * @summary A data set
+ * @summary A Button that can be used to show the filter.
  */
 class FilterButton extends ToggleButton {
 	/**
@@ -86,7 +52,6 @@ class FilterButton extends ToggleButton {
 	}
 
 	/**
-	 *
 	 * @return {string}
 	 */
 	static getTag() {
@@ -94,7 +59,7 @@ class FilterButton extends ToggleButton {
 	}
 
 	/**
-	 * @return {Array}
+	 * @return {CSSStyleSheet[]}
 	 */
 	static getCSSStyleSheet() {
 		const styles = super.getCSSStyleSheet();

package/source/components/datatable/filter.mjs

@@ -114,41 +114,8 @@ const settingsSymbol = Symbol("settings");
 /**
  * The Filter component is used to show and handle the filter values.
  *
- * <img src="./images/filter.png">
- *
- * Dependencies: the system uses functions of the [monsterjs](https://monsterjs.org/) library
- *
- * You can create this control either by specifying the HTML tag <monster-filter />` directly in the HTML or using
- * Javascript via the `document.createElement('monster-filter');` method.
- *
- * ```html
- * <monster-datatable-filter></monster-datatable-filter>
- * ```
- *
- * Or you can create this CustomControl directly in Javascript:
- *
- * ```js
- * import '@schukai/component-datatable/source/filter.mjs';
- * document.createElement('monster-datatable-filter');
- * ```
- *
- * The Body should have a class "hidden" to ensure that the styles are applied correctly.
- *
- * ```css
- * body.hidden {
- *    visibility: hidden;
- * }
- * ```
- *
- * @startuml filter.png
- * skinparam monochrome true
- * skinparam shadowing false
- * HTMLElement <|-- CustomElement
- * CustomElement <|-- Filter
- * @enduml
- *
  * @copyright schukai GmbH
- * @summary A data set
+ * @summary The Filter component is used to show and handle the filter values.
  */
 class Filter extends CustomElement {
 	/**
@@ -170,7 +137,7 @@ class Filter extends CustomElement {
 	/**
 	 *
 	 * @param {string} message
-	 * @return {Monster.Components.Datatable.Filter}
+	 * @return {Filter}
 	 */
 	showFailureMessage(message) {
 		this[searchButtonElementSymbol].setState(
@@ -185,7 +152,7 @@ class Filter extends CustomElement {
 
 	/**
 	 *
-	 * @return {Monster.Components.Datatable.Filter}
+	 * @return {{Filter}}
 	 */
 	resetFailureMessage() {
 		this[searchButtonElementSymbol].hideMessage();
@@ -195,7 +162,7 @@ class Filter extends CustomElement {
 
 	/**
 	 *
-	 * @return {Monster.Components.Datatable.Filter}
+	 * @return {{Filter}}
 	 */
 	showSuccess() {
 		this[searchButtonElementSymbol].setState(