@swisspost/design-system-components 1.5.0 → 1.6.0

package/dist/docs.json

@@ -1,13 +1,133 @@
 {
-  "timestamp": "2023-10-04T09:51:38",
+  "timestamp": "2023-11-02T07:36:23",
   "compiler": {
     "name": "@stencil/core",
-    "version": "3.4.2",
-    "typescriptVersion": "5.0.4"
+    "version": "4.6.0",
+    "typescriptVersion": "5.2.2"
   },
   "components": [
     {
-      "filePath": "./src/components/post-alert/post-alert.tsx",
+      "filePath": "src/components/post-accordion/post-accordion.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-accordion",
+      "readme": "# post-accordion\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "multiple",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "multiple",
+          "reflectToAttr": false,
+          "docs": "If `true`, multiple `post-collapsible` can be open at the same time.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "collapseAll",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "collapseAll() => Promise<void>",
+          "parameters": [],
+          "docs": "Collapses all `post-collapsible` children.",
+          "docsTags": []
+        },
+        {
+          "name": "expandAll",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "expandAll() => Promise<void>",
+          "parameters": [],
+          "docs": "Expands all `post-collapsible` children.\n\nIf `close-others` is `true` and all items are closed, it will open the first one.\nOtherwise, it will keep the opened one.",
+          "docsTags": []
+        },
+        {
+          "name": "toggle",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(id: string) => Promise<void>",
+            "parameters": [
+              {
+                "tags": [],
+                "text": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
+          "signature": "toggle(id: string) => Promise<void>",
+          "parameters": [],
+          "docs": "Toggles the `post-collapsible` children with the given id.",
+          "docsTags": []
+        }
+      ],
+      "events": [],
+      "listeners": [
+        {
+          "event": "collapseChange",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "src/components/post-alert/post-alert.tsx",
       "encapsulation": "shadow",
       "tag": "post-alert",
       "readme": "# post-alert\n\n\n",
@@ -18,6 +138,11 @@
         {
           "name": "dismissLabel",
           "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "dismiss-label",
           "reflectToAttr": false,
@@ -34,6 +159,11 @@
         {
           "name": "dismissible",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "dismissible",
           "reflectToAttr": false,
@@ -51,6 +181,11 @@
         {
           "name": "fixed",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "fixed",
           "reflectToAttr": false,
@@ -68,6 +203,11 @@
         {
           "name": "icon",
           "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "icon",
           "reflectToAttr": false,
@@ -84,6 +224,17 @@
         {
           "name": "type",
           "type": "\"danger\" | \"gray\" | \"info\" | \"primary\" | \"success\" | \"warning\"",
+          "complexType": {
+            "original": "AlertType",
+            "resolved": "\"danger\" | \"gray\" | \"info\" | \"primary\" | \"success\" | \"warning\"",
+            "references": {
+              "AlertType": {
+                "location": "import",
+                "path": "./alert-types",
+                "id": "src/components/post-alert/alert-types.ts::AlertType"
+              }
+            }
+          },
           "mutable": false,
           "attr": "type",
           "reflectToAttr": false,
@@ -127,6 +278,17 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "dismiss() => Promise<void>",
           "parameters": [],
           "docs": "Triggers alert dismissal programmatically (same as clicking on the close button (×)).",
@@ -138,6 +300,11 @@
           "event": "dismissed",
           "detail": "void",
           "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
           "cancelable": true,
           "composed": true,
           "docs": "An event emitted when the alert element is dismissed, after the transition.\nIt has no payload and only relevant for dismissible alerts.",
@@ -159,7 +326,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-collapsible/post-collapsible.tsx",
+      "filePath": "src/components/post-collapsible/post-collapsible.tsx",
       "encapsulation": "shadow",
       "tag": "post-collapsible",
       "readme": "# post-collapsible\n\n\n",
@@ -170,6 +337,11 @@
         {
           "name": "collapsed",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "collapsed",
           "reflectToAttr": false,
@@ -186,7 +358,18 @@
         },
         {
           "name": "headingLevel",
-          "type": "number",
+          "type": "1 | 2 | 3 | 4 | 5 | 6",
+          "complexType": {
+            "original": "HeadingLevel",
+            "resolved": "1 | 2 | 3 | 4 | 5 | 6",
+            "references": {
+              "HeadingLevel": {
+                "location": "import",
+                "path": "./heading-levels",
+                "id": "src/components/post-collapsible/heading-levels.ts::HeadingLevel"
+              }
+            }
+          },
           "mutable": false,
           "attr": "heading-level",
           "reflectToAttr": false,
@@ -195,6 +378,27 @@
           "default": "2",
           "values": [
             {
+              "value": "1",
+              "type": "number"
+            },
+            {
+              "value": "2",
+              "type": "number"
+            },
+            {
+              "value": "3",
+              "type": "number"
+            },
+            {
+              "value": "4",
+              "type": "number"
+            },
+            {
+              "value": "5",
+              "type": "number"
+            },
+            {
+              "value": "6",
               "type": "number"
             }
           ],
@@ -209,13 +413,44 @@
             "type": "Promise<boolean>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(open?: boolean) => Promise<boolean>",
+            "parameters": [
+              {
+                "tags": [],
+                "text": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<boolean>"
+          },
           "signature": "toggle(open?: boolean) => Promise<boolean>",
           "parameters": [],
-          "docs": "Triggers the collapse programmatically.",
+          "docs": "Triggers the collapse programmatically.\n\nIf there is a collapsing transition running already, it will be reversed.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "collapseChange",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "An event emitted when the collapse element is shown or hidden, before the transition. It has no payload.",
           "docsTags": []
         }
       ],
-      "events": [],
       "listeners": [],
       "styles": [],
       "slots": [],
@@ -225,7 +460,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-icon/post-icon.tsx",
+      "filePath": "src/components/post-icon/post-icon.tsx",
       "encapsulation": "shadow",
       "tag": "post-icon",
       "readme": "# post-icon\n\nsome content\n",
@@ -241,6 +476,16 @@
         {
           "name": "animation",
           "type": "\"cylon\" | \"cylon-vertical\" | \"fade\" | \"spin\" | \"spin-reverse\" | \"throb\"",
+          "complexType": {
+            "original": "Animation | null",
+            "resolved": "\"cylon\" | \"cylon-vertical\" | \"fade\" | \"spin\" | \"spin-reverse\" | \"throb\"",
+            "references": {
+              "Animation": {
+                "location": "global",
+                "id": "global::Animation"
+              }
+            }
+          },
           "mutable": false,
           "attr": "animation",
           "reflectToAttr": false,
@@ -279,6 +524,11 @@
         {
           "name": "base",
           "type": "string",
+          "complexType": {
+            "original": "string | null",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "base",
           "reflectToAttr": false,
@@ -296,6 +546,11 @@
         {
           "name": "flipH",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "flip-h",
           "reflectToAttr": false,
@@ -313,6 +568,11 @@
         {
           "name": "flipV",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "flip-v",
           "reflectToAttr": false,
@@ -330,6 +590,11 @@
         {
           "name": "name",
           "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "name",
           "reflectToAttr": false,
@@ -346,6 +611,11 @@
         {
           "name": "rotate",
           "type": "number",
+          "complexType": {
+            "original": "number | null",
+            "resolved": "number",
+            "references": {}
+          },
           "mutable": false,
           "attr": "rotate",
           "reflectToAttr": false,
@@ -363,6 +633,11 @@
         {
           "name": "scale",
           "type": "number",
+          "complexType": {
+            "original": "number | null",
+            "resolved": "number",
+            "references": {}
+          },
           "mutable": false,
           "attr": "scale",
           "reflectToAttr": false,
@@ -395,7 +670,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-tab-header/post-tab-header.tsx",
+      "filePath": "src/components/post-tab-header/post-tab-header.tsx",
       "encapsulation": "shadow",
       "tag": "post-tab-header",
       "readme": "# post-tab-header\n\n\n",
@@ -406,6 +681,16 @@
         {
           "name": "panel",
           "type": "string",
+          "complexType": {
+            "original": "HTMLPostTabPanelElement['name']",
+            "resolved": "string",
+            "references": {
+              "HTMLPostTabPanelElement": {
+                "location": "global",
+                "id": "global::HTMLPostTabPanelElement"
+              }
+            }
+          },
           "mutable": false,
           "attr": "panel",
           "reflectToAttr": false,
@@ -431,7 +716,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-tab-panel/post-tab-panel.tsx",
+      "filePath": "src/components/post-tab-panel/post-tab-panel.tsx",
       "encapsulation": "shadow",
       "tag": "post-tab-panel",
       "readme": "# post-tab-panel\n\n\n",
@@ -442,6 +727,11 @@
         {
           "name": "name",
           "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "name",
           "reflectToAttr": false,
@@ -467,7 +757,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-tabs/post-tabs.tsx",
+      "filePath": "src/components/post-tabs/post-tabs.tsx",
       "encapsulation": "shadow",
       "tag": "post-tabs",
       "readme": "# post-tabs\n\n\n",
@@ -478,6 +768,16 @@
         {
           "name": "activePanel",
           "type": "string",
+          "complexType": {
+            "original": "HTMLPostTabPanelElement['name']",
+            "resolved": "string",
+            "references": {
+              "HTMLPostTabPanelElement": {
+                "location": "global",
+                "id": "global::HTMLPostTabPanelElement"
+              }
+            }
+          },
           "mutable": false,
           "attr": "active-panel",
           "reflectToAttr": false,
@@ -499,6 +799,26 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(panelName: string) => Promise<void>",
+            "parameters": [
+              {
+                "tags": [],
+                "text": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLPostTabHeaderElement": {
+                "location": "global",
+                "id": "global::HTMLPostTabHeaderElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "show(panelName: string) => Promise<void>",
           "parameters": [],
           "docs": "Shows the panel with the given name and selects its associated tab.\nAny other panel that was previously shown becomes hidden and its associated tab is unselected.",
@@ -510,6 +830,16 @@
           "event": "tabChange",
           "detail": "string",
           "bubbles": true,
+          "complexType": {
+            "original": "HTMLPostTabPanelElement['name']",
+            "resolved": "string",
+            "references": {
+              "HTMLPostTabPanelElement": {
+                "location": "global",
+                "id": "global::HTMLPostTabPanelElement"
+              }
+            }
+          },
           "cancelable": true,
           "composed": true,
           "docs": "An event emitted after the active tab changes, when the fade in transition of its associated panel is finished.\nThe payload is the name of the newly shown panel.",
@@ -525,7 +855,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-tooltip/post-tooltip.tsx",
+      "filePath": "src/components/post-tooltip/post-tooltip.tsx",
       "encapsulation": "shadow",
       "tag": "post-tooltip",
       "readme": "# post-tooltip\n\n\n",
@@ -536,6 +866,17 @@
         {
           "name": "backgroundColor",
           "type": "\"primary\" | \"yellow\"",
+          "complexType": {
+            "original": "BackgroundColor",
+            "resolved": "\"primary\" | \"yellow\"",
+            "references": {
+              "BackgroundColor": {
+                "location": "import",
+                "path": "./types",
+                "id": "src/components/post-tooltip/types.ts::BackgroundColor"
+              }
+            }
+          },
           "mutable": false,
           "attr": "background-color",
           "reflectToAttr": false,
@@ -558,6 +899,17 @@
         {
           "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.5.1/node_modules/@floating-ui/dom/src/types.d.ts::Placement"
+              }
+            }
+          },
           "mutable": false,
           "attr": "placement",
           "reflectToAttr": false,
@@ -625,6 +977,17 @@
             "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": "Programmatically hide this tooltip",
@@ -636,6 +999,31 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(target: HTMLElement) => Promise<void>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "target An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+                  }
+                ],
+                "text": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "show(target: HTMLElement) => Promise<void>",
           "parameters": [],
           "docs": "Programmatically display the tooltip",
@@ -652,6 +1040,40 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(target: HTMLElement, force?: boolean) => Promise<void>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "target An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+                  }
+                ],
+                "text": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+              },
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "force Pass true to always show or false to always hide"
+                  }
+                ],
+                "text": "Pass true to always show or false to always hide"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "toggle(target: HTMLElement, force?: boolean) => Promise<void>",
           "parameters": [],
           "docs": "Toggle tooltip display",
@@ -676,5 +1098,27 @@
       "dependencies": [],
       "dependencyGraph": {}
     }
-  ]
+  ],
+  "typeLibrary": {
+    "src/components/post-alert/alert-types.ts::AlertType": {
+      "declaration": "\"primary\" | \"success\" | \"danger\" | \"warning\" | \"info\" | \"gray\"",
+      "docstring": "",
+      "path": "src/components/post-alert/alert-types.ts"
+    },
+    "src/components/post-collapsible/heading-levels.ts::HeadingLevel": {
+      "declaration": "6 | 1 | 2 | 3 | 4 | 5",
+      "docstring": "",
+      "path": "src/components/post-collapsible/heading-levels.ts"
+    },
+    "src/components/post-tooltip/types.ts::BackgroundColor": {
+      "declaration": "\"primary\" | \"yellow\"",
+      "docstring": "",
+      "path": "src/components/post-tooltip/types.ts"
+    },
+    "../../node_modules/.pnpm/@floating-ui+dom@1.5.1/node_modules/@floating-ui/dom/src/types.d.ts::Placement": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "../../node_modules/.pnpm/@floating-ui+dom@1.5.1/node_modules/@floating-ui/dom/src/types.d.ts"
+    }
+  }
 }