@swisspost/design-system-components 9.0.0-next.3 → 9.0.0-next.5

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2024-10-28T16:52:45",
+  "timestamp": "2024-11-18T17:06:56",
   "compiler": {
     "name": "@stencil/core",
     "version": "4.19.2",
@@ -698,6 +698,71 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "src/components/post-breadcrumb-item/post-breadcrumb-item.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-breadcrumb-item",
+      "readme": "# post-breadcrumb-item\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "default - Slot for placing the text inside the breadcrumb item."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "url",
+          "type": "URL | string",
+          "complexType": {
+            "original": "string | URL",
+            "resolved": "URL | string",
+            "references": {
+              "URL": {
+                "location": "global",
+                "id": "global::URL"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "url",
+          "reflectToAttr": false,
+          "docs": "The optional URL to which the breadcrumb item will link.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "URL"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default",
+          "docs": "Slot for placing the text inside the breadcrumb item."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-icon"
+      ],
+      "dependencyGraph": {
+        "post-breadcrumb-item": [
+          "post-icon"
+        ]
+      }
+    },
     {
       "filePath": "src/components/post-card-control/post-card-control.tsx",
       "encapsulation": "shadow",
@@ -1026,6 +1091,41 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/post-closebutton/post-closebutton.tsx",
+      "encapsulation": "none",
+      "tag": "post-closebutton",
+      "readme": "# post-closebutton\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "default - Slot for placing visually hidden label in the close button."
+        }
+      ],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default",
+          "docs": "Slot for placing visually hidden label in the close button."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-icon"
+      ],
+      "dependencyGraph": {
+        "post-closebutton": [
+          "post-icon"
+        ]
+      }
+    },
     {
       "filePath": "src/components/post-collapsible/post-collapsible.tsx",
       "encapsulation": "shadow",
@@ -1204,6 +1304,31 @@
         ]
       }
     },
+    {
+      "filePath": "src/components/post-header/post-header.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-header",
+      "readme": "# post-header\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [
+        {
+          "event": "postMainNavigationClosed",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "src/components/post-icon/post-icon.tsx",
       "encapsulation": "shadow",
@@ -1406,7 +1531,9 @@
       "parts": [],
       "dependents": [
         "post-alert",
+        "post-breadcrumb-item",
         "post-card-control",
+        "post-closebutton",
         "post-rating",
         "post-tag"
       ],
@@ -1415,9 +1542,15 @@
         "post-alert": [
           "post-icon"
         ],
+        "post-breadcrumb-item": [
+          "post-icon"
+        ],
         "post-card-control": [
           "post-icon"
         ],
+        "post-closebutton": [
+          "post-icon"
+        ],
         "post-rating": [
           "post-icon"
         ],
@@ -1578,6 +1711,117 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "src/components/post-list/post-list.tsx",
+      "encapsulation": "none",
+      "tag": "post-list",
+      "readme": "# post-list\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "default - Slot for placing the list title."
+        },
+        {
+          "name": "slot",
+          "text": "post-list-item - Slot for placing post-list-item components."
+        }
+      ],
+      "usage": {},
+      "props": [
+        {
+          "name": "horizontal",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "horizontal",
+          "reflectToAttr": false,
+          "docs": "The list can become horizontal by setting `horizontal=\"true\"` or just `horizontal`",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "titleHidden",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "title-hidden",
+          "reflectToAttr": false,
+          "docs": "If `true`, the list title will be hidden. Otherwise, it will be displayed.`",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default",
+          "docs": "Slot for placing the list title."
+        },
+        {
+          "name": "post-list-item",
+          "docs": "Slot for placing post-list-item components."
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/post-list-item/post-list-item.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-list-item",
+      "readme": "# post-list-item\n\n\n",
+      "docs": "",
+      "docsTags": [
+        {
+          "name": "slot",
+          "text": "default- Slot for placing the content of the list item."
+        }
+      ],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [
+        {
+          "name": "default- Slot for placing the content of the list item.",
+          "docs": ""
+        }
+      ],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "src/components/post-logo/post-logo.tsx",
       "encapsulation": "shadow",
@@ -1638,57 +1882,570 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "src/components/post-popover/post-popover.tsx",
-      "encapsulation": "shadow",
-      "tag": "post-popover",
-      "readme": "# post-popup\n\n\n",
+      "filePath": "src/components/post-mainnavigation/post-mainnavigation.tsx",
+      "encapsulation": "none",
+      "tag": "post-mainnavigation",
+      "readme": "# post-mainnavigation\n\n\n",
       "docs": "",
       "docsTags": [],
       "usage": {},
-      "props": [
-        {
-          "name": "arrow",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": false,
-          "attr": "arrow",
-          "reflectToAttr": false,
-          "docs": "Show a little indicator arrow",
-          "docsTags": [],
-          "default": "true",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
+      "props": [],
+      "methods": [],
+      "events": [
         {
-          "name": "closeButtonCaption",
-          "type": "string",
+          "event": "postToggle",
+          "detail": "any",
+          "bubbles": true,
           "complexType": {
-            "original": "string",
-            "resolved": "string",
+            "original": "any",
+            "resolved": "any",
             "references": {}
           },
-          "mutable": false,
-          "attr": "close-button-caption",
-          "reflectToAttr": false,
-          "docs": "Define the caption of the close button for assistive technology",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": true
-        },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Gets emitted when a user closes the main navigation on mobile",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "postToggle",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/post-megadropdown/post-megadropdown.tsx",
+      "encapsulation": "none",
+      "tag": "post-megadropdown",
+      "readme": "# post-megadropdown\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [
+        {
+          "name": "hide",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": "boolean"
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "hide() => Promise<void>",
+          "parameters": [],
+          "docs": "Hide megadropdown",
+          "docsTags": [
+            {
+              "name": "returns",
+              "text": "boolean"
+            }
+          ]
+        },
+        {
+          "name": "show",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": "boolean"
+          },
+          "complexType": {
+            "signature": "(element: HTMLElement) => Promise<void>",
+            "parameters": [
+              {
+                "name": "element",
+                "type": "HTMLElement",
+                "docs": "HTMLElement"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "show(element: HTMLElement) => Promise<void>",
+          "parameters": [
+            {
+              "name": "element",
+              "type": "HTMLElement",
+              "docs": "HTMLElement"
+            }
+          ],
+          "docs": "Show megadropdown",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "element HTMLElement"
+            },
+            {
+              "name": "returns",
+              "text": "boolean"
+            }
+          ]
+        },
+        {
+          "name": "toggle",
+          "returns": {
+            "type": "Promise<boolean>",
+            "docs": "boolean"
+          },
+          "complexType": {
+            "signature": "(element: HTMLElement, force?: boolean) => Promise<boolean>",
+            "parameters": [
+              {
+                "name": "element",
+                "type": "HTMLElement",
+                "docs": "HTMLElement"
+              },
+              {
+                "name": "force",
+                "type": "boolean",
+                "docs": "boolean"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<boolean>"
+          },
+          "signature": "toggle(element: HTMLElement, force?: boolean) => Promise<boolean>",
+          "parameters": [
+            {
+              "name": "element",
+              "type": "HTMLElement",
+              "docs": "HTMLElement"
+            },
+            {
+              "name": "force",
+              "type": "boolean",
+              "docs": "boolean"
+            }
+          ],
+          "docs": "Toggle megadropdown",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "element HTMLElement"
+            },
+            {
+              "name": "param",
+              "text": "force boolean"
+            },
+            {
+              "name": "returns",
+              "text": "boolean"
+            }
+          ]
+        }
+      ],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-popovercontainer"
+      ],
+      "dependencyGraph": {
+        "post-megadropdown": [
+          "post-popovercontainer"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/post-megadropdown-trigger/post-megadropdown-trigger.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-megadropdown-trigger",
+      "readme": "# post-megadropdown-toggle\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [
+        {
+          "event": "postToggle",
+          "detail": "any",
+          "bubbles": true,
+          "complexType": {
+            "original": "any",
+            "resolved": "any",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emits after each toggle",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/post-menu/post-menu.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-menu",
+      "readme": "# post-menu\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "placement",
+          "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"",
+          "complexType": {
+            "original": "Placement",
+            "resolved": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"",
+            "references": {
+              "Placement": {
+                "location": "import",
+                "path": "@floating-ui/dom",
+                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.6.8/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "placement",
+          "reflectToAttr": false,
+          "docs": "Defines the placement of the tooltip according to the floating-ui options available at https://floating-ui.com/docs/computePosition#placement.\nTooltips are automatically flipped to the opposite side if there is not enough available space and are shifted\ntowards the viewport if they would overlap edge boundaries.",
+          "docsTags": [],
+          "default": "'bottom'",
+          "values": [
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "bottom-start",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "left-end",
+              "type": "string"
+            },
+            {
+              "value": "left-start",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "right-end",
+              "type": "string"
+            },
+            {
+              "value": "right-start",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
+            },
+            {
+              "value": "top-start",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "hide",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "hide() => Promise<void>",
+          "parameters": [],
+          "docs": "Hides the popover menu and restores focus to the previously focused element.",
+          "docsTags": []
+        },
+        {
+          "name": "show",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(target: HTMLElement) => Promise<void>",
+            "parameters": [
+              {
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "- The HTML element relative to which the popover menu should be displayed."
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "show(target: HTMLElement) => Promise<void>",
+          "parameters": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "- The HTML element relative to which the popover menu should be displayed."
+            }
+          ],
+          "docs": "Displays the popover menu, focusing the first menu item.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target - The HTML element relative to which the popover menu should be displayed."
+            }
+          ]
+        },
+        {
+          "name": "toggle",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(target: HTMLElement) => Promise<void>",
+            "parameters": [
+              {
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "toggle(target: HTMLElement) => Promise<void>",
+          "parameters": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": ""
+            }
+          ],
+          "docs": "Toggles the menu visibility based on its current state.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "toggleMenu",
+          "detail": "boolean",
+          "bubbles": true,
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emits when the menu is shown or hidden.\nThe event payload is a boolean: `true` when the menu was opened, `false` when it was closed.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-popovercontainer"
+      ],
+      "dependencyGraph": {
+        "post-menu": [
+          "post-popovercontainer"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/post-menu-item/post-menu-item.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-menu-item",
+      "readme": "# post-menu-item\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/post-menu-trigger/post-menu-trigger.tsx",
+      "encapsulation": "none",
+      "tag": "post-menu-trigger",
+      "readme": "# post-menu-trigger\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "for",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "for",
+          "reflectToAttr": false,
+          "docs": "ID of the menu element that this trigger is linked to. Used to open and close the specified menu.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/post-popover/post-popover.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-popover",
+      "readme": "# post-popup\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "arrow",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "arrow",
+          "reflectToAttr": false,
+          "docs": "Show a little indicator arrow",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "closeButtonCaption",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "close-button-caption",
+          "reflectToAttr": false,
+          "docs": "Define the caption of the close button for assistive technology",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": true
+        },
         {
           "name": "placement",
           "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"",
@@ -1938,6 +2695,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "edgeGap",
+          "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "edge-gap",
+          "reflectToAttr": false,
+          "docs": "Gap between the edge of the page and the popover",
+          "docsTags": [],
+          "default": "8",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "placement",
           "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"",
@@ -2162,11 +2941,19 @@
       ],
       "parts": [],
       "dependents": [
+        "post-megadropdown",
+        "post-menu",
         "post-popover",
         "post-tooltip"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "post-megadropdown": [
+          "post-popovercontainer"
+        ],
+        "post-menu": [
+          "post-popovercontainer"
+        ],
         "post-popover": [
           "post-popovercontainer"
         ],