@synergy-design-system/components 2.14.3 → 2.15.0

package/dist/custom-elements.json

@@ -144,6 +144,82 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "components/badge/badge.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "SynBadge",
+          "cssParts": [
+            {
+              "description": "The component's base wrapper.",
+              "name": "base"
+            }
+          ],
+          "slots": [
+            {
+              "description": "The badge's content.",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "localize",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new LocalizeController(this)"
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'"
+              },
+              "default": "'primary'",
+              "description": "The badge's theme variant.",
+              "attribute": "variant",
+              "reflects": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "variant",
+              "type": {
+                "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'"
+              },
+              "default": "'primary'",
+              "description": "The badge's theme variant.",
+              "fieldName": "variant"
+            }
+          ],
+          "superclass": {
+            "name": "SynergyElement",
+            "module": "/src/internal/synergy-element.js"
+          },
+          "summary": "Badges are used to draw attention and display statuses or counts.",
+          "tagNameWithoutPrefix": "badge",
+          "tagName": "syn-badge",
+          "customElement": true,
+          "jsDoc": "/**\n * @summary Badges are used to draw attention and display statuses or counts.\n * @documentation https://synergy.style/components/badge\n * @status stable\n * @since 2.0\n *\n * @slot - The badge's content.\n *\n * @csspart base - The component's base wrapper.\n */",
+          "documentation": "https://synergy.style/components/badge",
+          "status": "stable",
+          "since": "2.0"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "SynBadge",
+            "module": "components/badge/badge.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "components/alert/alert.js",
@@ -448,82 +524,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "components/badge/badge.js",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "",
-          "name": "SynBadge",
-          "cssParts": [
-            {
-              "description": "The component's base wrapper.",
-              "name": "base"
-            }
-          ],
-          "slots": [
-            {
-              "description": "The badge's content.",
-              "name": ""
-            }
-          ],
-          "members": [
-            {
-              "kind": "field",
-              "name": "localize",
-              "privacy": "private",
-              "readonly": true,
-              "default": "new LocalizeController(this)"
-            },
-            {
-              "kind": "field",
-              "name": "variant",
-              "type": {
-                "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'"
-              },
-              "default": "'primary'",
-              "description": "The badge's theme variant.",
-              "attribute": "variant",
-              "reflects": true
-            }
-          ],
-          "attributes": [
-            {
-              "name": "variant",
-              "type": {
-                "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'"
-              },
-              "default": "'primary'",
-              "description": "The badge's theme variant.",
-              "fieldName": "variant"
-            }
-          ],
-          "superclass": {
-            "name": "SynergyElement",
-            "module": "/src/internal/synergy-element.js"
-          },
-          "summary": "Badges are used to draw attention and display statuses or counts.",
-          "tagNameWithoutPrefix": "badge",
-          "tagName": "syn-badge",
-          "customElement": true,
-          "jsDoc": "/**\n * @summary Badges are used to draw attention and display statuses or counts.\n * @documentation https://synergy.style/components/badge\n * @status stable\n * @since 2.0\n *\n * @slot - The badge's content.\n *\n * @csspart base - The component's base wrapper.\n */",
-          "documentation": "https://synergy.style/components/badge",
-          "status": "stable",
-          "since": "2.0"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "default",
-          "declaration": {
-            "name": "SynBadge",
-            "module": "components/badge/badge.js"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "components/breadcrumb/breadcrumb.js",
@@ -7213,6 +7213,32 @@
                 "text": "HTMLSlotElement"
               }
             },
+            {
+              "kind": "field",
+              "name": "hasMenuItemsWithCheckmarks",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false"
+            },
+            {
+              "kind": "method",
+              "name": "handleUpdateCheckmarks",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "items",
+                  "type": {
+                    "text": "SynMenuItem[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "updateCheckMarksByChildPropChange",
+              "privacy": "private"
+            },
             {
               "kind": "method",
               "name": "handleClick",
@@ -15710,7 +15736,7 @@
   "package": {
     "name": "@synergy-design-system/components",
     "description": "",
-    "version": "2.14.3",
+    "version": "2.15.0",
     "author": {
       "name": "SICK Global UX Foundation",
       "url": "https://www.sick.com"

package/dist/events/events.d.ts

@@ -1,5 +1,6 @@
 export type * from './syn-after-hide.ts';
 export type * from './syn-after-show.ts';
+export type * from './syn-attributes-changed.ts';
 export type * from './syn-blur.ts';
 export type * from './syn-burger-menu-closed.ts';
 export type * from './syn-burger-menu-hidden.ts';

package/dist/events/syn-attributes-changed.d.ts

@@ -0,0 +1,16 @@
+export type SynAttributeChange = {
+    attribute: string;
+    oldValue: unknown;
+    newValue: unknown;
+};
+/**
+ * An attribute changed event that is emitted when an attribute of a child element changes.
+ * Used together with the `emitEventForPropertyUpdates` decorator.
+ * @see src/internal/watchEvent.ts
+ */
+export type SynAttributesChangedEvent = CustomEvent<SynAttributeChange[]>;
+declare global {
+    interface GlobalEventHandlersEventMap {
+        'syn-attributes-changed': SynAttributesChangedEvent;
+    }
+}

package/dist/internal/watchEvent.d.ts

@@ -0,0 +1,59 @@
+import type SynergyElement from './synergy-element.js';
+type Constructor<T = object> = new (...args: any[]) => T;
+interface DecoratorOptions {
+    /**
+     * If true, will only start watching after the initial updated call
+     */
+    waitUntilFirstUpdated?: boolean;
+}
+/**
+ * Class decorator that automatically emits a `syn-attributes-changed` event
+ * when at least one of the provided attributes have changed.
+ * The event will contain an array of all changed properties, including their
+ * - attribute name
+ * - old value and
+ * - new value.
+ *
+ * @example
+ * ```ts
+ * class OriginalClass extends SynergyElement {}
+ * export const MyComponent = emitEventForPropertyUpdates(['attribute1', 'attribute2'])(BaseClass);
+ *
+ * // Create the component, providing initial values for the changed attribute list
+ * const myComponent = document.createElement('my-component');
+ * myComponent.attribute1 = 'initial value for attribute 1';
+ * myComponent.attribute2 = 'initial value for attribute 2';
+ *
+ * // Create a container and listen for the event
+ * const container = document.createElement('div');
+ * container.addEventListener('syn-attributes-changed', (event: SynAttributesChangedEvent) => {
+ *   // We do not want to propagate the event further
+ *   event.stopImmidiatePropagation();
+ *
+ *   console.log(event.detail);
+ * });
+ *
+ * // Add the component to the container
+ * container.appendChild(myComponent);
+ *
+ * // Change the attributes
+ * myComponent.attribute1 = 'value for attribute 1';
+ * myComponent.attribute2 = 'value for attribute 2';
+ *
+ * // Output:
+ * // [
+ * //   {
+ * //     attribute: 'attribute1',
+ * //     oldValue: 'initial value for attribute 1',
+ * //     newValue: 'value for attribute 1'
+ * //   },
+ * //   {
+ * //     attribute: 'attribute2',
+ * //     oldValue: 'initial value for attribute 2',
+ * //     newValue: 'value for attribute 2'
+ * //   }
+ * // ]
+ * ```
+ */
+export declare function emitEventForPropertyUpdates(watchedProperties: string[], options?: DecoratorOptions): <T extends Constructor<SynergyElement>>(Proto: T) => T;
+export {};

package/dist/styles/index.css

@@ -1,5 +1,5 @@
 /**
- * @synergy-design-system/components version 2.14.3
+ * @synergy-design-system/components version 2.15.0
  * SICK Global UX Foundation
  * 
  * This file is created automatically in the build process!