From c107f9fa09aafee0cb4513fd8e61699b1eb87e90 Mon Sep 17 00:00:00 2001
From: Volker Schukai <volker.schukai@schukai.com>
Date: Wed, 2 Oct 2024 14:48:36 +0200
Subject: [PATCH] chore: update documentaion
---
source/components/datatable/change-button.mjs | 2 +-
source/components/datatable/columnbar.mjs | 2 +-
source/components/datatable/dataset.mjs | 2 +-
source/components/datatable/datasource.mjs | 2 +-
.../components/datatable/datasource/dom.mjs | 2 +-
.../components/datatable/datasource/rest.mjs | 2 +-
source/components/datatable/datatable.mjs | 2 +-
source/components/datatable/filter-button.mjs | 2 +-
source/components/datatable/filter.mjs | 2 +-
.../datatable/filter/date-range.mjs | 2 +-
source/components/datatable/filter/input.mjs | 2 +-
source/components/datatable/filter/range.mjs | 2 +-
source/components/datatable/filter/select.mjs | 2 +-
source/components/datatable/pagination.mjs | 2 +-
source/components/datatable/save-button.mjs | 2 +-
source/components/datatable/status.mjs | 2 +-
source/components/form/action-button.mjs | 2 +-
source/components/form/api-button.mjs | 2 +-
source/components/form/button-bar.mjs | 2 +-
source/components/form/button.mjs | 2 +-
source/components/form/confirm-button.mjs | 2 +-
source/components/form/context-error.mjs | 2 +-
source/components/form/context-help.mjs | 2 +-
source/components/form/field-set.mjs | 2 +-
.../components/form/message-state-button.mjs | 2 +-
source/components/form/popper-button.mjs | 2 +-
source/components/form/reload.mjs | 2 +-
source/components/form/select.mjs | 2 +-
source/components/form/shadow-reload.mjs | 2 +-
source/components/form/state-button.mjs | 2 +-
source/components/form/template.mjs | 2 +-
source/components/form/toggle-switch.mjs | 2 +-
source/components/form/tree-select.mjs | 2 +-
source/components/host/call-button.mjs | 2 +-
source/components/host/config-manager.mjs | 2 +-
source/components/host/host.mjs | 2 +-
source/components/host/overlay.mjs | 2 +-
source/components/host/toggle-button.mjs | 2 +-
source/components/host/viewer.mjs | 2 +-
source/components/layout/collapse.mjs | 42 +++++++++----------
source/components/layout/details.mjs | 22 +++++-----
source/components/layout/iframe.mjs | 2 +-
source/components/layout/panel.mjs | 2 +-
source/components/layout/popper.mjs | 2 +-
source/components/layout/slider.mjs | 2 +-
source/components/layout/split-panel.mjs | 2 +-
source/components/layout/tabs.mjs | 2 +-
source/components/layout/width-toggle.mjs | 26 ++++++++----
.../navigation/table-of-content.mjs | 2 +-
source/components/state/log.mjs | 2 +-
source/components/state/state.mjs | 2 +-
51 files changed, 97 insertions(+), 89 deletions(-)
diff --git a/source/components/datatable/change-button.mjs b/source/components/datatable/change-button.mjs
index 55c1db40a..6a6b1ec6c 100644
--- a/source/components/datatable/change-button.mjs
+++ b/source/components/datatable/change-button.mjs
@@ -97,7 +97,7 @@ class ChangeButton extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/columnbar.mjs b/source/components/datatable/columnbar.mjs
index 58955897d..b2d76e467 100644
--- a/source/components/datatable/columnbar.mjs
+++ b/source/components/datatable/columnbar.mjs
@@ -103,7 +103,7 @@ class ColumnBar extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/dataset.mjs b/source/components/datatable/dataset.mjs
index b391f3220..24e920e71 100644
--- a/source/components/datatable/dataset.mjs
+++ b/source/components/datatable/dataset.mjs
@@ -100,7 +100,7 @@ class DataSet extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/datasource.mjs b/source/components/datatable/datasource.mjs
index ee12b2b7a..fa5caf146 100644
--- a/source/components/datatable/datasource.mjs
+++ b/source/components/datatable/datasource.mjs
@@ -65,7 +65,7 @@ class Datasource extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/datasource/dom.mjs b/source/components/datatable/datasource/dom.mjs
index ed6e00890..415ea9738 100644
--- a/source/components/datatable/datasource/dom.mjs
+++ b/source/components/datatable/datasource/dom.mjs
@@ -59,7 +59,7 @@ class Dom extends Datasource {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/datasource/rest.mjs b/source/components/datatable/datasource/rest.mjs
index 344e7d363..0fd509a90 100644
--- a/source/components/datatable/datasource/rest.mjs
+++ b/source/components/datatable/datasource/rest.mjs
@@ -100,7 +100,7 @@ class Rest extends Datasource {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/datatable.mjs b/source/components/datatable/datatable.mjs
index df867dbe1..ad165fae3 100644
--- a/source/components/datatable/datatable.mjs
+++ b/source/components/datatable/datatable.mjs
@@ -153,7 +153,7 @@ class DataTable extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/filter-button.mjs b/source/components/datatable/filter-button.mjs
index 42c64bab6..b11111276 100644
--- a/source/components/datatable/filter-button.mjs
+++ b/source/components/datatable/filter-button.mjs
@@ -70,7 +70,7 @@ class FilterButton extends ToggleButton {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/filter.mjs b/source/components/datatable/filter.mjs
index 3b8932274..737035d0f 100644
--- a/source/components/datatable/filter.mjs
+++ b/source/components/datatable/filter.mjs
@@ -207,7 +207,7 @@ class Filter extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/filter/date-range.mjs b/source/components/datatable/filter/date-range.mjs
index 3c224924d..f142c44ad 100644
--- a/source/components/datatable/filter/date-range.mjs
+++ b/source/components/datatable/filter/date-range.mjs
@@ -185,7 +185,7 @@ class DateRange extends AbstractBase {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/filter/input.mjs b/source/components/datatable/filter/input.mjs
index 5cfad8828..32aaaf6dc 100644
--- a/source/components/datatable/filter/input.mjs
+++ b/source/components/datatable/filter/input.mjs
@@ -82,7 +82,7 @@ class Input extends AbstractBase {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/filter/range.mjs b/source/components/datatable/filter/range.mjs
index 3c41a11e0..c08daa92a 100644
--- a/source/components/datatable/filter/range.mjs
+++ b/source/components/datatable/filter/range.mjs
@@ -155,7 +155,7 @@ class Range extends AbstractBase {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/filter/select.mjs b/source/components/datatable/filter/select.mjs
index af9773b54..9ad8182ca 100644
--- a/source/components/datatable/filter/select.mjs
+++ b/source/components/datatable/filter/select.mjs
@@ -38,7 +38,7 @@ import { FilterSelectStyleSheet } from "../stylesheet/filter-select.mjs";
*/
class FilterSelect extends Select {
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/pagination.mjs b/source/components/datatable/pagination.mjs
index 39eb4a6da..93e5ec67c 100644
--- a/source/components/datatable/pagination.mjs
+++ b/source/components/datatable/pagination.mjs
@@ -100,7 +100,7 @@ class Pagination extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/save-button.mjs b/source/components/datatable/save-button.mjs
index c061c7c39..d8ea18701 100644
--- a/source/components/datatable/save-button.mjs
+++ b/source/components/datatable/save-button.mjs
@@ -70,7 +70,7 @@ class SaveButton extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/datatable/status.mjs b/source/components/datatable/status.mjs
index bb85dc60c..8fe2b4e4e 100644
--- a/source/components/datatable/status.mjs
+++ b/source/components/datatable/status.mjs
@@ -95,7 +95,7 @@ class DatasourceStatus extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/action-button.mjs b/source/components/form/action-button.mjs
index 4222159ce..f312d5621 100644
--- a/source/components/form/action-button.mjs
+++ b/source/components/form/action-button.mjs
@@ -97,7 +97,7 @@ class ActionButton extends PopperButton {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/api-button.mjs b/source/components/form/api-button.mjs
index 94f8f6bc3..47b25c7bd 100644
--- a/source/components/form/api-button.mjs
+++ b/source/components/form/api-button.mjs
@@ -108,7 +108,7 @@ class ApiButton extends ActionButton {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/button-bar.mjs b/source/components/form/button-bar.mjs
index dc6e1493a..d8e3b5d74 100644
--- a/source/components/form/button-bar.mjs
+++ b/source/components/form/button-bar.mjs
@@ -180,7 +180,7 @@ class ButtonBar extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/button.mjs b/source/components/form/button.mjs
index c7626242b..14f520a28 100644
--- a/source/components/form/button.mjs
+++ b/source/components/form/button.mjs
@@ -179,7 +179,7 @@ class Button extends CustomControl {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/confirm-button.mjs b/source/components/form/confirm-button.mjs
index ae30312c7..6d78c8275 100644
--- a/source/components/form/confirm-button.mjs
+++ b/source/components/form/confirm-button.mjs
@@ -114,7 +114,7 @@ class ConfirmButton extends PopperButton {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/context-error.mjs b/source/components/form/context-error.mjs
index adbb5a90a..7e5d4d5ce 100644
--- a/source/components/form/context-error.mjs
+++ b/source/components/form/context-error.mjs
@@ -104,7 +104,7 @@ class ContextError extends Popper {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/context-help.mjs b/source/components/form/context-help.mjs
index f8411cae8..ad6c244c3 100644
--- a/source/components/form/context-help.mjs
+++ b/source/components/form/context-help.mjs
@@ -79,7 +79,7 @@ class ContextHelp extends Popper {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/field-set.mjs b/source/components/form/field-set.mjs
index 9bd8bd143..498b070bd 100644
--- a/source/components/form/field-set.mjs
+++ b/source/components/form/field-set.mjs
@@ -132,7 +132,7 @@ class FieldSet extends CustomControl {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/message-state-button.mjs b/source/components/form/message-state-button.mjs
index b349a569b..4e7dc0903 100644
--- a/source/components/form/message-state-button.mjs
+++ b/source/components/form/message-state-button.mjs
@@ -123,7 +123,7 @@ class MessageStateButton extends Popper {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/popper-button.mjs b/source/components/form/popper-button.mjs
index 952a64e08..a9295cc2e 100644
--- a/source/components/form/popper-button.mjs
+++ b/source/components/form/popper-button.mjs
@@ -154,7 +154,7 @@ class PopperButton extends Popper {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/reload.mjs b/source/components/form/reload.mjs
index f135d0b6c..c41b999f6 100644
--- a/source/components/form/reload.mjs
+++ b/source/components/form/reload.mjs
@@ -128,7 +128,7 @@ class Reload extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/select.mjs b/source/components/form/select.mjs
index 6f890bd92..e9708ee62 100644
--- a/source/components/form/select.mjs
+++ b/source/components/form/select.mjs
@@ -347,7 +347,7 @@ class Select extends CustomControl {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/shadow-reload.mjs b/source/components/form/shadow-reload.mjs
index 8ff3553db..ea105cd17 100644
--- a/source/components/form/shadow-reload.mjs
+++ b/source/components/form/shadow-reload.mjs
@@ -40,7 +40,7 @@ class ShadowReload extends Reload {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/state-button.mjs b/source/components/form/state-button.mjs
index 8dc1e0503..60d42f74f 100644
--- a/source/components/form/state-button.mjs
+++ b/source/components/form/state-button.mjs
@@ -46,7 +46,7 @@ class StateButton extends Button {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/template.mjs b/source/components/form/template.mjs
index 3623c49bc..74e81fea7 100644
--- a/source/components/form/template.mjs
+++ b/source/components/form/template.mjs
@@ -60,7 +60,7 @@ class Template extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/toggle-switch.mjs b/source/components/form/toggle-switch.mjs
index ad33780d5..c8bae6150 100644
--- a/source/components/form/toggle-switch.mjs
+++ b/source/components/form/toggle-switch.mjs
@@ -85,7 +85,7 @@ export const STATE_OFF = "off";
*/
class ToggleSwitch extends CustomControl {
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/form/tree-select.mjs b/source/components/form/tree-select.mjs
index d3df828cd..7cfe3dfb2 100644
--- a/source/components/form/tree-select.mjs
+++ b/source/components/form/tree-select.mjs
@@ -78,7 +78,7 @@ class TreeSelect extends Select {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/host/call-button.mjs b/source/components/host/call-button.mjs
index 00f7b6294..746ee0fda 100644
--- a/source/components/host/call-button.mjs
+++ b/source/components/host/call-button.mjs
@@ -95,7 +95,7 @@ class CallButton extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/host/config-manager.mjs b/source/components/host/config-manager.mjs
index 20bae3a68..cdc6aa44d 100644
--- a/source/components/host/config-manager.mjs
+++ b/source/components/host/config-manager.mjs
@@ -116,7 +116,7 @@ class ConfigManager extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/host/host.mjs b/source/components/host/host.mjs
index cd9a72d48..59b953709 100644
--- a/source/components/host/host.mjs
+++ b/source/components/host/host.mjs
@@ -120,7 +120,7 @@ class Host extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/host/overlay.mjs b/source/components/host/overlay.mjs
index 5f9df9b43..a1859191a 100644
--- a/source/components/host/overlay.mjs
+++ b/source/components/host/overlay.mjs
@@ -119,7 +119,7 @@ class Overlay extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/host/toggle-button.mjs b/source/components/host/toggle-button.mjs
index 92e5fd380..b370e0f4c 100644
--- a/source/components/host/toggle-button.mjs
+++ b/source/components/host/toggle-button.mjs
@@ -69,7 +69,7 @@ class ToggleButton extends CallButton {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/host/viewer.mjs b/source/components/host/viewer.mjs
index 0dd3ee14c..0b6724dba 100644
--- a/source/components/host/viewer.mjs
+++ b/source/components/host/viewer.mjs
@@ -74,7 +74,7 @@ class Viewer extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/collapse.mjs b/source/components/layout/collapse.mjs
index b5f0effc1..8ea0fd61f 100644
--- a/source/components/layout/collapse.mjs
+++ b/source/components/layout/collapse.mjs
@@ -109,7 +109,7 @@ class Collapse extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
@@ -143,7 +143,7 @@ class Collapse extends CustomElement {
/**
*
- * @returns {Monster.Components.Host.Collapse}
+ * @returns {void}
*/
[assembleMethodSymbol]() {
super[assembleMethodSymbol]();
@@ -158,25 +158,22 @@ class Collapse extends CustomElement {
}
/**
- *
+ * @returns {void}
*/
connectedCallback() {
super.connectedCallback();
updateResizeObserverObservation.call(this);
- // this[resizeObserverSymbol].observe(getDocument().body);
}
/**
- *
+ * @returns {void}
*/
disconnectedCallback() {
super.disconnectedCallback();
- //this[resizeObserverSymbol].disconnect();
}
/**
- *
- * @returns {Monster.Components.Host.Collapse}
+ * @returns {Collapse}
*/
toggle() {
if (this[detailsElementSymbol].classList.contains("active")) {
@@ -188,7 +185,6 @@ class Collapse extends CustomElement {
}
/**
- *
* @returns {boolean}
*/
isClosed() {
@@ -196,7 +192,6 @@ class Collapse extends CustomElement {
}
/**
- *
* @returns {boolean}
*/
isOpen() {
@@ -204,10 +199,10 @@ class Collapse extends CustomElement {
}
/**
- *
- * @returns {Monster.Components.Host.Collapse}
- * @fires Monster.Components.Host.Collapse.event:monster-collapse-before-open
- * @fires Monster.Components.Host.Collapse.event:monster-collapse-open
+ * Open the collapse
+ * @returns {Collapse}
+ * @fires event:monster-collapse-before-open
+ * @fires event:monster-collapse-open
*/
open() {
let node;
@@ -248,10 +243,10 @@ class Collapse extends CustomElement {
}
/**
- *
- * @returns {Monster.Components.Host.Collapse}
- * @fires Monster.Components.Host.Collapse.event:monster-collapse-before-close
- * @fires Monster.Components.Host.Collapse.event:monster-collapse-closed
+ * Close the collapse
+ * @returns {Collapse}
+ * @fires event:monster-collapse-before-close
+ * @fires event:monster-collapse-closed
*/
close() {
if (!this[detailsElementSymbol].classList.contains("active")) {
@@ -273,7 +268,6 @@ class Collapse extends CustomElement {
}
/**
- *
* @return {string}
*/
static getTag() {
@@ -289,8 +283,8 @@ class Collapse extends CustomElement {
/**
* This method is called when the element is inserted into a document, including into a shadow tree.
- * @return {Monster.Components.Host.Collapse}
- * @fires Monster.Components.Host.Collapse.event:monster-collapse-adjust-height
+ * @return {Collapse}
+ * @fires event:monster-collapse-adjust-height
*/
adjustHeight() {
adjustHeight.call(this);
@@ -298,6 +292,11 @@ class Collapse extends CustomElement {
}
}
+/**
+ * @private
+ * @returns {void}
+ * @fires event:monster-collapse-adjust-height
+ */
function adjustHeight() {
let height = 0;
@@ -336,6 +335,7 @@ function adjustHeight() {
height,
"important",
);
+
fireCustomEvent(this, "monster-" + this[nameSymbol] + "-adjust-height", {});
}
diff --git a/source/components/layout/details.mjs b/source/components/layout/details.mjs
index 40e843146..8ea5a43d1 100644
--- a/source/components/layout/details.mjs
+++ b/source/components/layout/details.mjs
@@ -43,10 +43,14 @@ const buttonEventHandlerSymbol = Symbol("buttonEventHandler");
* @fragments /fragments/components/layout/details/
*
* @example /examples/components/layout/details-simple
+ * @example /examples/components/layout/details-with-label
+ * @example /examples/components/layout/details-as-accordion
+ * @example /examples/components/layout/details-with-your-own-design
*
* @since 3.74.0
* @copyright schukai GmbH
- * @summary A simple but cool Details component
+ * @summary A simple but cool detail component. This is based on the collapse component and extends it with a button.
+ * @summary You can also easily build an accordion from the component.
*/
class Details extends Collapse {
/**
@@ -67,20 +71,15 @@ class Details extends Collapse {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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} classes CSS classes
- * @property {string} classes.button CSS class for the button
* @property {Object} button Button configuration
* @property {string} button.label Button label
- * @property {Object} features Feature configuration
- * @property {boolean} features.accordion Enable accordion mode
- * @property {boolean} features.persistState Persist the state in the host configuration
*/
get defaults() {
return Object.assign({}, super.defaults, {
@@ -94,8 +93,7 @@ class Details extends Collapse {
}
/**
- *
- * @returns {Monster.Components.Layout.Details}
+ * @returns {void}
*/
[assembleMethodSymbol]() {
super[assembleMethodSymbol]();
@@ -105,6 +103,9 @@ class Details extends Collapse {
initEventHandler.call(this);
}
+ /**
+ * @returns {void}
+ */
connectedCallback() {
super.connectedCallback();
@@ -119,7 +120,6 @@ class Details extends Collapse {
}
/**
- *
* @return {string}
*/
static getTag() {
@@ -127,7 +127,7 @@ class Details extends Collapse {
}
/**
- * @return {Array<CSSStyleSheet>}
+ * @returns {Array<CSSStyleSheet>}
*/
static getCSSStyleSheet() {
const css = super.getCSSStyleSheet();
diff --git a/source/components/layout/iframe.mjs b/source/components/layout/iframe.mjs
index 52797d7a6..fc8a02fcc 100644
--- a/source/components/layout/iframe.mjs
+++ b/source/components/layout/iframe.mjs
@@ -113,7 +113,7 @@ class Iframe extends CustomElement {
}
/**
- * To set the options via the HTML Tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/panel.mjs b/source/components/layout/panel.mjs
index 07fca2b20..bb460eb95 100644
--- a/source/components/layout/panel.mjs
+++ b/source/components/layout/panel.mjs
@@ -64,7 +64,7 @@ class Panel extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/popper.mjs b/source/components/layout/popper.mjs
index 94394fe5c..cc3ba14f2 100644
--- a/source/components/layout/popper.mjs
+++ b/source/components/layout/popper.mjs
@@ -105,7 +105,7 @@ class Popper extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/slider.mjs b/source/components/layout/slider.mjs
index b33554c00..941de3326 100644
--- a/source/components/layout/slider.mjs
+++ b/source/components/layout/slider.mjs
@@ -104,7 +104,7 @@ class Slider extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/split-panel.mjs b/source/components/layout/split-panel.mjs
index 77b050a2f..8c8be8c48 100644
--- a/source/components/layout/split-panel.mjs
+++ b/source/components/layout/split-panel.mjs
@@ -87,7 +87,7 @@ class SplitPanel extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/tabs.mjs b/source/components/layout/tabs.mjs
index bbb17e905..f63ff8cf3 100644
--- a/source/components/layout/tabs.mjs
+++ b/source/components/layout/tabs.mjs
@@ -162,7 +162,7 @@ class Tabs extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/layout/width-toggle.mjs b/source/components/layout/width-toggle.mjs
index 13715f9e9..e4ca81fe9 100644
--- a/source/components/layout/width-toggle.mjs
+++ b/source/components/layout/width-toggle.mjs
@@ -45,12 +45,11 @@ const toggleElementSymbol = Symbol("toggleElement");
const insideElementSymbol = Symbol("insideElement");
/**
- *
* @type {string}
*/
const MODE_SMALL = "small";
+
/**
- *
* @type {string}
*/
const MODE_WIDE = "wide";
@@ -64,7 +63,9 @@ const MODE_WIDE = "wide";
*
* @since 3.57.0
* @copyright schukai GmbH
- * @summary The WidthToggle component is used to change the width of a panel by clicking on a button.
+ * @summary The WidthToggle component allows users to dynamically change the width of a panel by clicking a button.
+ * @summary This feature improves readability and space utilization by allowing the panel width to be adjusted
+ * @summary according to user preferences.
*/
class WidthToggle extends CustomElement {
/**
@@ -78,7 +79,7 @@ class WidthToggle extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
@@ -105,8 +106,7 @@ class WidthToggle extends CustomElement {
}
/**
- *
- * @returns {Monster.Components.Host.Viewer}
+ * @returns {void}
*/
[assembleMethodSymbol]() {
super[assembleMethodSymbol]();
@@ -123,6 +123,13 @@ class WidthToggle extends CustomElement {
* @return {Object} - Returns the current object instance for chaining.
* @throws {Error} - If the mode is not supported.
*/
+
+
+ /**
+ * @param {string} mode
+ * @returns {WidthToggle}
+ * @throws {Error} no shadow-root is defined
+ */
setWidth(mode) {
applyContainerWidth.call(this, mode);
return this;
@@ -137,7 +144,7 @@ class WidthToggle extends CustomElement {
}
/**
- * @return {CSSStyleSheet[]}
+ * @returns {CSSStyleSheet[]}
*/
static getCSSStyleSheet() {
return [WidthToggleStyleSheet];
@@ -146,8 +153,9 @@ class WidthToggle extends CustomElement {
/**
* Set the dimensions of the panel based on the split type.
- * @param {string} mode - The mode of the panel. Possible values are "wide" or "small".
- * @fires Monster.Components.Layout.event:monster-dimension-changed
+ * @param {string} mode
+ * @throws {Error} no shadow-root is defined
+ * @private
*/
function applyContainerWidth(mode) {
const width = this.getOption("width." + mode);
diff --git a/source/components/navigation/table-of-content.mjs b/source/components/navigation/table-of-content.mjs
index 6a28301a3..39d6dc961 100644
--- a/source/components/navigation/table-of-content.mjs
+++ b/source/components/navigation/table-of-content.mjs
@@ -103,7 +103,7 @@ class TableOfContent extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/state/log.mjs b/source/components/state/log.mjs
index 6911b3354..c98cae511 100644
--- a/source/components/state/log.mjs
+++ b/source/components/state/log.mjs
@@ -92,7 +92,7 @@ class Log extends CustomElement {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
diff --git a/source/components/state/state.mjs b/source/components/state/state.mjs
index b511fc541..02b8dc573 100644
--- a/source/components/state/state.mjs
+++ b/source/components/state/state.mjs
@@ -81,7 +81,7 @@ class State extends CustomControl {
}
/**
- * To set the options via the html tag the attribute `data-monster-options` must be used.
+ * 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.
--
GitLab