@six-group/ui-library 4.2.6 → 4.3.0

package/dist/components.json

@@ -1,9 +1,9 @@
 {
-  "timestamp": "2024-10-04T07:29:35",
+  "timestamp": "2024-12-11T15:32:26",
   "compiler": {
     "name": "@stencil/core",
-    "version": "4.12.6",
-    "typescriptVersion": "5.3.3"
+    "version": "4.21.0",
+    "typescriptVersion": "5.5.3"
   },
   "components": [
     {
@@ -1253,6 +1253,7 @@
         }
       ],
       "dependents": [
+        "six-header-menu-button",
         "six-select"
       ],
       "dependencies": [
@@ -1262,6 +1263,9 @@
         "six-button": [
           "six-spinner"
         ],
+        "six-header-menu-button": [
+          "six-button"
+        ],
         "six-select": [
           "six-button"
         ]
@@ -4667,6 +4671,7 @@
       ],
       "dependents": [
         "six-header",
+        "six-header-dropdown-item",
         "six-select"
       ],
       "dependencies": [
@@ -4699,6 +4704,9 @@
         "six-header": [
           "six-dropdown"
         ],
+        "six-header-dropdown-item": [
+          "six-dropdown"
+        ],
         "six-select": [
           "six-dropdown"
         ]
@@ -5782,19 +5790,19 @@
         },
         {
           "name": "slot",
-          "text": "notifications - Used to define the notification component in the header."
+          "text": "notifications - <span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the notification component in the header."
         },
         {
           "name": "slot",
-          "text": "app-switcher-menu - Used to define the application switcher menu in the header."
+          "text": "app-switcher-menu - <span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the application switcher menu in the header."
         },
         {
           "name": "slot",
-          "text": "profile-menu - Used to define the profile menu in the header."
+          "text": "profile-menu -  <span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the profile menu in the header."
         },
         {
           "name": "slot",
-          "text": "profile-avatar - Used to define the avator in the header."
+          "text": "profile-avatar - <span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the avator in the header."
         }
       ],
       "usage": {},
@@ -5811,7 +5819,44 @@
           "attr": "clickable-logo",
           "reflectToAttr": false,
           "docs": "Set whether the logo should be clickable",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property with `six-logo` instead"
+            }
+          ],
+          "default": "false",
+          "deprecation": "Use six-header `custom` property with `six-logo` instead",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "custom",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "custom",
+          "reflectToAttr": false,
+          "docs": "Set `custom` to `true` for complete control over the header content. When enabled, all other properties and slots\nare ignored.\n\nUse `six-header-item`, `six-header-dropdown-item` and `six-header-menu-button` to structure the content.",
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.2.7"
+            },
+            {
+              "name": "status",
+              "text": "beta"
+            }
+          ],
           "default": "false",
           "values": [
             {
@@ -5833,8 +5878,14 @@
           "attr": "hide-hamburger-menu",
           "reflectToAttr": false,
           "docs": "Set whether the hamburger menu should be visible or not",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
           "default": "false",
+          "deprecation": "Use six-header `custom` property instead",
           "values": [
             {
               "type": "boolean"
@@ -5855,8 +5906,14 @@
           "attr": "logo",
           "reflectToAttr": false,
           "docs": "The displayed logo. Either six or bme. Defaults to six.",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property with `six-logo` instead"
+            }
+          ],
           "default": "'six'",
+          "deprecation": "Use six-header `custom` property with `six-logo` instead",
           "values": [
             {
               "value": "bme",
@@ -5882,8 +5939,14 @@
           "attr": "open-hamburger-menu",
           "reflectToAttr": false,
           "docs": "Set the hamburger menu icon to open or closed state",
-          "docsTags": [],
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
           "default": "false",
+          "deprecation": "Use six-header `custom` property instead",
           "values": [
             {
               "type": "boolean"
@@ -5903,7 +5966,7 @@
           "mutable": false,
           "attr": "open-search",
           "reflectToAttr": false,
-          "docs": "Set the header search to be in an open or closed state",
+          "docs": "Set the header search to be in an open or closed state.\n\nIf `custom` is `true`, focuses the first `six-input` found in the search slot.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -5958,7 +6021,13 @@
           "signature": "getIsSearchOpen() => Promise<boolean>",
           "parameters": [],
           "docs": "Get open state for search",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property instead"
         },
         {
           "name": "setSearchOpenState",
@@ -5992,7 +6061,13 @@
             }
           ],
           "docs": "Sets open state for search",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property instead"
         }
       ],
       "events": [
@@ -6014,7 +6089,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when the name of the selected app is clicked.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property with `six-header-dropdown-item` and `six-header-menu-button` instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property with `six-header-dropdown-item` and `six-header-menu-button` instead"
         },
         {
           "event": "six-header-app-switcher-select",
@@ -6034,7 +6115,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when a menu item is in the app switcher menu is selected.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property with `six-header-dropdown-item` and `six-header-menu-button` instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property with `six-header-dropdown-item` and `six-header-menu-button` instead"
         },
         {
           "event": "six-header-hamburger-menu-clicked",
@@ -6054,7 +6141,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when the hamburger menu is clicked.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property instead"
         },
         {
           "event": "six-header-logo-clicked",
@@ -6074,7 +6167,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when the header logo is clicked.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property instead"
         },
         {
           "event": "six-header-profile-select",
@@ -6094,7 +6193,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when a menu item is in the profile menu is selected.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property with `six-header-dropdown-item` and `six-avatar` instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property with `six-header-dropdown-item` and `six-avatar` instead"
         },
         {
           "event": "six-header-search-field-toggle",
@@ -6114,7 +6219,13 @@
           "cancelable": true,
           "composed": true,
           "docs": "Emitted when search field is toggled.",
-          "docsTags": []
+          "docsTags": [
+            {
+              "name": "deprecated",
+              "text": "Use six-header `custom` property instead"
+            }
+          ],
+          "deprecation": "Use six-header `custom` property instead"
         }
       ],
       "listeners": [],
@@ -6126,19 +6237,19 @@
         },
         {
           "name": "app-switcher-menu",
-          "docs": "Used to define the application switcher menu in the header."
+          "docs": "<span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the application switcher menu in the header."
         },
         {
           "name": "notifications",
-          "docs": "Used to define the notification component in the header."
+          "docs": "<span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the notification component in the header."
         },
         {
           "name": "profile-avatar",
-          "docs": "Used to define the avator in the header."
+          "docs": "<span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the avator in the header."
         },
         {
           "name": "profile-menu",
-          "docs": "Used to define the profile menu in the header."
+          "docs": "<span style=\"color:red\">[Deprecated]</span>, use six-header `custom` property instead. Used to define the profile menu in the header."
         },
         {
           "name": "search-field",
@@ -6153,13 +6264,17 @@
       ],
       "dependents": [],
       "dependencies": [
+        "six-header-item",
         "six-icon-button",
-        "six-dropdown"
+        "six-dropdown",
+        "six-logo"
       ],
       "dependencyGraph": {
         "six-header": [
+          "six-header-item",
           "six-icon-button",
-          "six-dropdown"
+          "six-dropdown",
+          "six-logo"
         ],
         "six-icon-button": [
           "six-icon"
@@ -6186,6 +6301,179 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/six-header-dropdown-item/six-header-dropdown-item.tsx",
+      "encapsulation": "shadow",
+      "tag": "six-header-dropdown-item",
+      "readme": "# six-header\n\n<!-- EXAMPLES -->\n",
+      "docs": "<!-- EXAMPLES -->",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "4.2.7"
+        },
+        {
+          "name": "status",
+          "text": "beta"
+        }
+      ],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "six-dropdown"
+      ],
+      "dependencyGraph": {
+        "six-header-dropdown-item": [
+          "six-dropdown"
+        ],
+        "six-dropdown": [
+          "six-menu-item",
+          "six-input",
+          "six-icon",
+          "six-menu"
+        ],
+        "six-menu-item": [
+          "six-checkbox",
+          "six-icon"
+        ],
+        "six-checkbox": [
+          "six-error"
+        ],
+        "six-input": [
+          "six-icon",
+          "six-error"
+        ],
+        "six-menu": [
+          "six-menu-item"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/six-header-item/six-header-item.tsx",
+      "encapsulation": "shadow",
+      "tag": "six-header-item",
+      "readme": "# six-header\n\n<!-- EXAMPLES -->\n",
+      "docs": "<!-- EXAMPLES -->",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "4.2.7"
+        },
+        {
+          "name": "status",
+          "text": "beta"
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "active",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "active",
+          "reflectToAttr": true,
+          "docs": "Indicates whether the item is styled as active.\nWhen set to `true`, a border is displayed below the trigger element.\n\nUse <code>six-header-dropdown-item</code> to automatically set the active\nstate for dropdowns.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "six-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "six-header": [
+          "six-header-item"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/six-header-menu-button/six-header-menu-button.tsx",
+      "encapsulation": "shadow",
+      "tag": "six-header-menu-button",
+      "readme": "# six-header\n\n<!-- EXAMPLES -->\n",
+      "docs": "<!-- EXAMPLES -->",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "4.2.7"
+        },
+        {
+          "name": "status",
+          "text": "beta"
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "icon",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "icon",
+          "reflectToAttr": true,
+          "docs": "The icon of the menu button.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "six-button",
+        "six-icon"
+      ],
+      "dependencyGraph": {
+        "six-header-menu-button": [
+          "six-button",
+          "six-icon"
+        ],
+        "six-button": [
+          "six-spinner"
+        ]
+      }
+    },
     {
       "filePath": "src/components/six-icon/six-icon.tsx",
       "encapsulation": "shadow",
@@ -6300,6 +6588,7 @@
         "six-dropdown",
         "six-file-list-item",
         "six-file-upload",
+        "six-header-menu-button",
         "six-icon-button",
         "six-input",
         "six-item-picker",
@@ -6331,6 +6620,9 @@
         "six-file-upload": [
           "six-icon"
         ],
+        "six-header-menu-button": [
+          "six-icon"
+        ],
         "six-icon-button": [
           "six-icon"
         ],
@@ -6407,6 +6699,54 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "download",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "download",
+          "reflectToAttr": false,
+          "docs": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "href",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "href",
+          "reflectToAttr": false,
+          "docs": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "html",
           "type": "string | undefined",
@@ -6525,6 +6865,43 @@
           ],
           "optional": false,
           "required": false
+        },
+        {
+          "name": "target",
+          "type": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\" | undefined",
+          "complexType": {
+            "original": "'_blank' | '_parent' | '_self' | '_top'",
+            "resolved": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\" | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "target",
+          "reflectToAttr": false,
+          "docs": "Tells the browser where to open the link. Only used when `href` is set.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "_blank",
+              "type": "string"
+            },
+            {
+              "value": "_parent",
+              "type": "string"
+            },
+            {
+              "value": "_self",
+              "type": "string"
+            },
+            {
+              "value": "_top",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
         }
       ],
       "methods": [],
@@ -7542,7 +7919,7 @@
             "docs": ""
           },
           "complexType": {
-            "signature": "(replacement: string, start: number, end: number, selectMode?: 'select' | 'start' | 'end' | 'preserve') => Promise<void>",
+            "signature": "(replacement: string, start: number, end: number, selectMode?: \"select\" | \"start\" | \"end\" | \"preserve\") => Promise<void>",
             "parameters": [
               {
                 "name": "replacement",
@@ -7573,7 +7950,7 @@
             },
             "return": "Promise<void>"
           },
-          "signature": "setRangeText(replacement: string, start: number, end: number, selectMode?: 'select' | 'start' | 'end' | 'preserve') => Promise<void>",
+          "signature": "setRangeText(replacement: string, start: number, end: number, selectMode?: \"select\" | \"start\" | \"end\" | \"preserve\") => Promise<void>",
           "parameters": [
             {
               "name": "replacement",
@@ -8505,6 +8882,74 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "src/components/six-logo/six-logo.tsx",
+      "encapsulation": "shadow",
+      "tag": "six-logo",
+      "readme": "# six-header\n\n<!-- EXAMPLES -->\n",
+      "docs": "<!-- EXAMPLES -->",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "4.2.7"
+        },
+        {
+          "name": "status",
+          "text": "beta"
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "brand",
+          "type": "\"bme\" | \"six\"",
+          "complexType": {
+            "original": "'six' | 'bme'",
+            "resolved": "\"bme\" | \"six\"",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "brand",
+          "reflectToAttr": true,
+          "docs": "The brand of the logo. Either six or bme. Defaults to six.",
+          "docsTags": [],
+          "default": "'six'",
+          "values": [
+            {
+              "value": "bme",
+              "type": "string"
+            },
+            {
+              "value": "six",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [
+        {
+          "name": "--height",
+          "annotation": "prop",
+          "docs": "The height of the logo."
+        }
+      ],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "six-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "six-header": [
+          "six-logo"
+        ]
+      }
+    },
     {
       "filePath": "src/components/six-main-container/six-main-container.tsx",
       "encapsulation": "shadow",
@@ -14482,7 +14927,7 @@
             "docs": ""
           },
           "complexType": {
-            "signature": "(replacement: string, start: number, end: number, selectMode?: 'select' | 'start' | 'end' | 'preserve') => Promise<void>",
+            "signature": "(replacement: string, start: number, end: number, selectMode?: \"select\" | \"start\" | \"end\" | \"preserve\") => Promise<void>",
             "parameters": [
               {
                 "name": "replacement",
@@ -14513,7 +14958,7 @@
             },
             "return": "Promise<void>"
           },
-          "signature": "setRangeText(replacement: string, start: number, end: number, selectMode?: 'select' | 'start' | 'end' | 'preserve') => Promise<void>",
+          "signature": "setRangeText(replacement: string, start: number, end: number, selectMode?: \"select\" | \"start\" | \"end\" | \"preserve\") => Promise<void>",
           "parameters": [
             {
               "name": "replacement",
@@ -14546,7 +14991,7 @@
             "docs": ""
           },
           "complexType": {
-            "signature": "(selectionStart: number, selectionEnd: number, selectionDirection?: 'forward' | 'backward' | 'none') => Promise<void | undefined>",
+            "signature": "(selectionStart: number, selectionEnd: number, selectionDirection?: \"forward\" | \"backward\" | \"none\") => Promise<void | undefined>",
             "parameters": [
               {
                 "name": "selectionStart",
@@ -14572,7 +15017,7 @@
             },
             "return": "Promise<void | undefined>"
           },
-          "signature": "setSelectionRange(selectionStart: number, selectionEnd: number, selectionDirection?: 'forward' | 'backward' | 'none') => Promise<void | undefined>",
+          "signature": "setSelectionRange(selectionStart: number, selectionEnd: number, selectionDirection?: \"forward\" | \"backward\" | \"none\") => Promise<void | undefined>",
           "parameters": [
             {
               "name": "selectionStart",