@swisspost/design-system-components 1.6.3 → 1.7.0

package/dist/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2023-12-06T14:47:34",
+  "timestamp": "2024-01-08T11:30:48",
   "compiler": {
     "name": "@stencil/core",
-    "version": "4.6.0",
+    "version": "4.9.0",
     "typescriptVersion": "5.2.2"
   },
   "components": [
@@ -93,8 +93,9 @@
             "signature": "(id: string) => Promise<void>",
             "parameters": [
               {
-                "tags": [],
-                "text": ""
+                "name": "id",
+                "type": "string",
+                "docs": ""
               }
             ],
             "references": {
@@ -106,7 +107,13 @@
             "return": "Promise<void>"
           },
           "signature": "toggle(id: string) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "id",
+              "type": "string",
+              "docs": ""
+            }
+          ],
           "docs": "Toggles the `post-collapsible` children with the given id.",
           "docsTags": []
         }
@@ -417,8 +424,9 @@
             "signature": "(open?: boolean) => Promise<boolean>",
             "parameters": [
               {
-                "tags": [],
-                "text": ""
+                "name": "open",
+                "type": "boolean",
+                "docs": ""
               }
             ],
             "references": {
@@ -430,7 +438,13 @@
             "return": "Promise<boolean>"
           },
           "signature": "toggle(open?: boolean) => Promise<boolean>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "open",
+              "type": "boolean",
+              "docs": ""
+            }
+          ],
           "docs": "Triggers the collapse programmatically.\n\nIf there is a collapsing transition running already, it will be reversed.",
           "docsTags": []
         }
@@ -674,6 +688,539 @@
         ]
       }
     },
+    {
+      "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\"",
+          "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.4/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
+              }
+            }
+          },
+          "mutable": false,
+          "attr": "placement",
+          "reflectToAttr": false,
+          "docs": "Defines the placement of the popover according to the floating-ui options available at https://floating-ui.com/docs/computePosition#placement.\nPopoverss 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": "'top'",
+          "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": "Programmatically hide this popover",
+          "docsTags": []
+        },
+        {
+          "name": "show",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(target: HTMLElement) => Promise<void>",
+            "parameters": [
+              {
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "An element with [data-popover-target=\"id\"] where the popover 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": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "An element with [data-popover-target=\"id\"] where the popover should be shown"
+            }
+          ],
+          "docs": "Programmatically display the popover",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target An element with [data-popover-target=\"id\"] where the popover should be shown"
+            }
+          ]
+        },
+        {
+          "name": "toggle",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(target: HTMLElement, force?: boolean) => Promise<void>",
+            "parameters": [
+              {
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "An element with [data-popover-target=\"id\"] where the popover should be anchored to"
+              },
+              {
+                "name": "force",
+                "type": "boolean",
+                "docs": "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": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "An element with [data-popover-target=\"id\"] where the popover should be anchored to"
+            },
+            {
+              "name": "force",
+              "type": "boolean",
+              "docs": "Pass true to always show or false to always hide"
+            }
+          ],
+          "docs": "Toggle popover display",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target An element with [data-popover-target=\"id\"] where the popover should be anchored to"
+            },
+            {
+              "name": "param",
+              "text": "force Pass true to always show or false to always hide"
+            }
+          ]
+        }
+      ],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-popovercontainer"
+      ],
+      "dependencyGraph": {
+        "post-popover": [
+          "post-popovercontainer"
+        ]
+      }
+    },
+    {
+      "filePath": "src/components/post-popovercontainer/post-popovercontainer.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-popovercontainer",
+      "readme": "# post-popover\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "arrow",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "arrow",
+          "reflectToAttr": false,
+          "docs": "Wheter or not to display a little pointer arrow",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "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\"",
+          "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.4/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": "'top'",
+          "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": "Programmatically hide this tooltip",
+          "docsTags": []
+        },
+        {
+          "name": "show",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(target: HTMLElement) => Promise<void>",
+            "parameters": [
+              {
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "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": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+            }
+          ],
+          "docs": "Programmatically display the tooltip",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+            }
+          ]
+        },
+        {
+          "name": "toggle",
+          "returns": {
+            "type": "Promise<boolean>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(target: HTMLElement, force?: boolean) => Promise<boolean>",
+            "parameters": [
+              {
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+              },
+              {
+                "name": "force",
+                "type": "boolean",
+                "docs": "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<boolean>"
+          },
+          "signature": "toggle(target: HTMLElement, force?: boolean) => Promise<boolean>",
+          "parameters": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+            },
+            {
+              "name": "force",
+              "type": "boolean",
+              "docs": "Pass true to always show or false to always hide"
+            }
+          ],
+          "docs": "Toggle tooltip display",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "target An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+            },
+            {
+              "name": "param",
+              "text": "force Pass true to always show or false to always hide"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "postPopoverToggled",
+          "detail": "boolean",
+          "bubbles": true,
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fires whenever the popover gets shown or hidden, passing the new state in event.details as a boolean",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [
+        {
+          "name": "popover",
+          "docs": ""
+        }
+      ],
+      "dependents": [
+        "post-popover",
+        "post-tooltip"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "post-popover": [
+          "post-popovercontainer"
+        ],
+        "post-tooltip": [
+          "post-popovercontainer"
+        ]
+      }
+    },
     {
       "filePath": "src/components/post-tab-header/post-tab-header.tsx",
       "encapsulation": "shadow",
@@ -808,8 +1355,9 @@
             "signature": "(panelName: string) => Promise<void>",
             "parameters": [
               {
-                "tags": [],
-                "text": ""
+                "name": "panelName",
+                "type": "string",
+                "docs": ""
               }
             ],
             "references": {
@@ -825,7 +1373,13 @@
             "return": "Promise<void>"
           },
           "signature": "show(panelName: string) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "panelName",
+              "type": "string",
+              "docs": ""
+            }
+          ],
           "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.",
           "docsTags": []
         }
@@ -868,39 +1422,6 @@
       "docsTags": [],
       "usage": {},
       "props": [
-        {
-          "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,
-          "docs": "Defines the background color of the tooltip.\nChoose the one that provides the best contrast in your scenario.",
-          "docsTags": [],
-          "default": "'primary'",
-          "values": [
-            {
-              "value": "primary",
-              "type": "string"
-            },
-            {
-              "value": "yellow",
-              "type": "string"
-            }
-          ],
-          "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\"",
@@ -911,7 +1432,7 @@
               "Placement": {
                 "location": "import",
                 "path": "@floating-ui/dom",
-                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.5.3/node_modules/@floating-ui/dom/src/types.d.ts::Placement"
+                "id": "../../node_modules/.pnpm/@floating-ui+dom@1.5.4/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement"
               }
             }
           },
@@ -1008,13 +1529,9 @@
             "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"
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
               }
             ],
             "references": {
@@ -1030,7 +1547,13 @@
             "return": "Promise<void>"
           },
           "signature": "show(target: HTMLElement) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+            }
+          ],
           "docs": "Programmatically display the tooltip",
           "docsTags": [
             {
@@ -1049,22 +1572,14 @@
             "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"
+                "name": "target",
+                "type": "HTMLElement",
+                "docs": "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"
+                "name": "force",
+                "type": "boolean",
+                "docs": "Pass true to always show or false to always hide"
               }
             ],
             "references": {
@@ -1080,7 +1595,18 @@
             "return": "Promise<void>"
           },
           "signature": "toggle(target: HTMLElement, force?: boolean) => Promise<void>",
-          "parameters": [],
+          "parameters": [
+            {
+              "name": "target",
+              "type": "HTMLElement",
+              "docs": "An element with [data-tooltip-target=\"id\"] where the tooltip should be shown"
+            },
+            {
+              "name": "force",
+              "type": "boolean",
+              "docs": "Pass true to always show or false to always hide"
+            }
+          ],
           "docs": "Toggle tooltip display",
           "docsTags": [
             {
@@ -1100,8 +1626,14 @@
       "slots": [],
       "parts": [],
       "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {}
+      "dependencies": [
+        "post-popovercontainer"
+      ],
+      "dependencyGraph": {
+        "post-tooltip": [
+          "post-popovercontainer"
+        ]
+      }
     }
   ],
   "typeLibrary": {
@@ -1115,15 +1647,10 @@
       "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.3/node_modules/@floating-ui/dom/src/types.d.ts::Placement": {
+    "../../node_modules/.pnpm/@floating-ui+dom@1.5.4/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement": {
       "declaration": "any",
       "docstring": "",
-      "path": "../../node_modules/.pnpm/@floating-ui+dom@1.5.3/node_modules/@floating-ui/dom/src/types.d.ts"
+      "path": "../../node_modules/.pnpm/@floating-ui+dom@1.5.4/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts"
     }
   }
 }