@swisspost/internet-header 1.9.0 → 1.10.0

package/dist/docs.json

@@ -0,0 +1,914 @@
+{
+  "timestamp": "2023-10-04T09:52:07",
+  "compiler": {
+    "name": "@stencil/core",
+    "version": "3.4.2",
+    "typescriptVersion": "5.0.4"
+  },
+  "components": [
+    {
+      "filePath": "./src/components/post-klp-login-widget/post-klp-login-widget.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-klp-login-widget",
+      "readme": "# post-klp-login-widget\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets the focus on the login button",
+          "docsTags": []
+        }
+      ],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-klp-login-widget"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-language-switch/post-language-switch.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-language-switch",
+      "readme": "# post-language-switch\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "mode",
+          "type": "\"dropdown\" | \"list\"",
+          "mutable": false,
+          "attr": "mode",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "dropdown",
+              "type": "string"
+            },
+            {
+              "value": "list",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "toggleDropdown",
+          "returns": {
+            "type": "Promise<boolean>",
+            "docs": "Boolean indicating new state"
+          },
+          "signature": "toggleDropdown(force?: boolean) => Promise<boolean>",
+          "parameters": [],
+          "docs": "Open or close the language switch programatically",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "force Boolean to force a state"
+            },
+            {
+              "name": "returns",
+              "text": "Boolean indicating new state"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "dropdownToggled",
+          "detail": "{ open: boolean; element: DropdownElement; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        },
+        {
+          "event": "languageChanged",
+          "detail": "string",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-language-switch"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-logo/post-logo.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-logo",
+      "readme": "# post-logo\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-logo"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-main-navigation/post-main-navigation.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-main-navigation",
+      "readme": "# post-main-navigation\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [
+        {
+          "name": "setActiveFlyout",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setActiveFlyout(id: string | null) => Promise<void>",
+          "parameters": [],
+          "docs": "Open a specific flyout",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "id Flyout ID"
+            }
+          ]
+        },
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Focus the main navigation toggle button",
+          "docsTags": []
+        },
+        {
+          "name": "toggleDropdown",
+          "returns": {
+            "type": "Promise<boolean>",
+            "docs": "Boolean indicating new state"
+          },
+          "signature": "toggleDropdown(force?: boolean) => Promise<boolean>",
+          "parameters": [],
+          "docs": "Toggle the main navigation (only visible on mobile)",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "force Force a state"
+            },
+            {
+              "name": "returns",
+              "text": "Boolean indicating new state"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "dropdownToggled",
+          "detail": "{ open: boolean; element: DropdownElement; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        },
+        {
+          "event": "flyoutToggled",
+          "detail": "null | string",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-main-navigation"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-meta-navigation/post-meta-navigation.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-meta-navigation",
+      "readme": "# post-meta-navigation\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "fullWidth",
+          "type": "boolean | undefined",
+          "mutable": false,
+          "attr": "full-width",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "orientation",
+          "type": "\"horizontal\" | \"vertical\"",
+          "mutable": false,
+          "attr": "orientation",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "horizontal",
+              "type": "string"
+            },
+            {
+              "value": "vertical",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-meta-navigation"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-search/post-search.tsx",
+      "encapsulation": "shadow",
+      "tag": "post-search",
+      "readme": "# post-search\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [
+        {
+          "name": "setFocus",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "setFocus() => Promise<void>",
+          "parameters": [],
+          "docs": "Sets the focus on the search button",
+          "docsTags": []
+        },
+        {
+          "name": "toggleDropdown",
+          "returns": {
+            "type": "Promise<boolean>",
+            "docs": "Boolean indicating open state of the component"
+          },
+          "signature": "toggleDropdown(force?: unknown) => Promise<boolean>",
+          "parameters": [],
+          "docs": "Toggle the dropdown and optionally force an open/closed state",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "force Boolean to force open/closed state"
+            },
+            {
+              "name": "returns",
+              "text": "Boolean indicating open state of the component"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "dropdownToggled",
+          "detail": "{ open: boolean; element: DropdownElement; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-search"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-skiplinks/post-skiplinks.tsx",
+      "encapsulation": "none",
+      "tag": "post-skiplinks",
+      "readme": "# post-skiplinks\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "swisspost-internet-header"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-skiplinks"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.tsx",
+      "encapsulation": "shadow",
+      "tag": "swisspost-internet-breadcrumbs",
+      "readme": "# post-internet-breadcrumbs\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "customItems",
+          "type": "IBreadcrumbItem[] | string | undefined",
+          "mutable": false,
+          "attr": "custom-items",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "IBreadcrumbItem[]"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "toggleOverlayById",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "signature": "toggleOverlayById(overlayId: IBreadcrumbOverlay['id']) => Promise<void>",
+          "parameters": [],
+          "docs": "Toggle an overlay associated with a button.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "overlayId"
+            }
+          ]
+        }
+      ],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "./src/components/post-internet-footer/post-internet-footer.tsx",
+      "encapsulation": "shadow",
+      "tag": "swisspost-internet-footer",
+      "readme": "# post-internet-footer\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
+    {
+      "filePath": "./src/components/post-internet-header/post-internet-header.tsx",
+      "encapsulation": "shadow",
+      "tag": "swisspost-internet-header",
+      "readme": "# post-internet-header\n\n\n",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "activeRoute",
+          "type": "boolean | string | undefined",
+          "mutable": false,
+          "attr": "active-route",
+          "reflectToAttr": false,
+          "docs": "Set the currently activated route. If there is a link matching this URL in the header, it will be highlighted.\nWill also highlight partly matching URLs. When set to auto, will use current location.href for comparison.",
+          "docsTags": [],
+          "default": "'auto'",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "configProxy",
+          "type": "string | undefined",
+          "mutable": false,
+          "attr": "config-proxy",
+          "reflectToAttr": false,
+          "docs": "DEPRECATED!: Define a proxy URL for the config fetch request. Will be removed in the next major version",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "customConfig",
+          "type": "ICustomConfig | string | undefined",
+          "mutable": false,
+          "attr": "custom-config",
+          "reflectToAttr": false,
+          "docs": "Customize the header config loaded from the post portal.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "ICustomConfig"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "environment",
+          "type": "\"dev01\" | \"dev02\" | \"devs1\" | \"int01\" | \"int02\" | \"prod\" | \"test\"",
+          "mutable": false,
+          "attr": "environment",
+          "reflectToAttr": false,
+          "docs": "Target environment. Choose 'int01' for local testing.",
+          "docsTags": [],
+          "default": "'prod'",
+          "values": [
+            {
+              "value": "dev01",
+              "type": "string"
+            },
+            {
+              "value": "dev02",
+              "type": "string"
+            },
+            {
+              "value": "devs1",
+              "type": "string"
+            },
+            {
+              "value": "int01",
+              "type": "string"
+            },
+            {
+              "value": "int02",
+              "type": "string"
+            },
+            {
+              "value": "prod",
+              "type": "string"
+            },
+            {
+              "value": "test",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "fullWidth",
+          "type": "boolean | undefined",
+          "mutable": false,
+          "attr": "full-width",
+          "reflectToAttr": false,
+          "docs": "Displays the header at full width for full-screen applications",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "language",
+          "type": "\"de\" | \"en\" | \"fr\" | \"it\" | undefined",
+          "mutable": false,
+          "attr": "language",
+          "reflectToAttr": false,
+          "docs": "Initial language to be used. Overrides automatic language detection.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "de",
+              "type": "string"
+            },
+            {
+              "value": "en",
+              "type": "string"
+            },
+            {
+              "value": "fr",
+              "type": "string"
+            },
+            {
+              "value": "it",
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "languageCookieKey",
+          "type": "string | undefined",
+          "mutable": false,
+          "attr": "language-cookie-key",
+          "reflectToAttr": false,
+          "docs": "The header uses this cookie to set the language. Disables automatic language detection.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "languageLocalStorageKey",
+          "type": "string | undefined",
+          "mutable": false,
+          "attr": "language-local-storage-key",
+          "reflectToAttr": false,
+          "docs": "The header uses this local storage key to set the language. Disables automatic language selection.",
+          "docsTags": [],
+          "default": "'swisspost-internet-header-language'",
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "languageSwitchOverrides",
+          "type": "IAvailableLanguage[] | string | undefined",
+          "mutable": false,
+          "attr": "language-switch-overrides",
+          "reflectToAttr": false,
+          "docs": "Override the language switch links with custom URLs. Helpful when your application contains sub-pages, and you\nwould like to stay on subpages when the user changes language.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "IAvailableLanguage[]"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "login",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "login",
+          "reflectToAttr": false,
+          "docs": "Toggle the login link (when logged out) or the user widget (when logged in).",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "meta",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "meta",
+          "reflectToAttr": false,
+          "docs": "Toggle the meta navigation.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "osFlyoutOverrides",
+          "type": "NavMainEntity | string | undefined",
+          "mutable": false,
+          "attr": "os-flyout-overrides",
+          "reflectToAttr": false,
+          "docs": "Online Services only: Add custom links to the special online service navigation entry",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "NavMainEntity"
+            },
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "project",
+          "type": "string",
+          "mutable": false,
+          "attr": "project",
+          "reflectToAttr": false,
+          "docs": "Your project id, previously passed as query string parameter serviceId.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "search",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "search",
+          "reflectToAttr": false,
+          "docs": "Toggle the search button.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "skiplinks",
+          "type": "boolean",
+          "mutable": false,
+          "attr": "skiplinks",
+          "reflectToAttr": false,
+          "docs": "Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page.",
+          "docsTags": [],
+          "default": "true",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "stickyness",
+          "type": "\"full\" | \"main\" | \"minimal\" | \"none\"",
+          "mutable": false,
+          "attr": "stickyness",
+          "reflectToAttr": false,
+          "docs": "Sticky behaviour of the header.",
+          "docsTags": [],
+          "default": "'minimal'",
+          "values": [
+            {
+              "value": "full",
+              "type": "string"
+            },
+            {
+              "value": "main",
+              "type": "string"
+            },
+            {
+              "value": "minimal",
+              "type": "string"
+            },
+            {
+              "value": "none",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [
+        {
+          "name": "getCurrentLanguage",
+          "returns": {
+            "type": "Promise<string>",
+            "docs": "string"
+          },
+          "signature": "getCurrentLanguage() => Promise<'de' | 'fr' | 'it' | 'en' | string>",
+          "parameters": [],
+          "docs": "Get the currently set language as a two letter string (\"de\", \"fr\" \"it\" or \"en\")",
+          "docsTags": [
+            {
+              "name": "returns",
+              "text": "string"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "headerLoaded",
+          "detail": "void",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fires when the header has been rendered to the page.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [
+        {
+          "event": "languageChanged",
+          "capture": false,
+          "passive": false
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "post-skiplinks",
+        "post-meta-navigation",
+        "post-language-switch",
+        "post-logo",
+        "post-main-navigation",
+        "post-search",
+        "post-klp-login-widget"
+      ],
+      "dependencyGraph": {
+        "swisspost-internet-header": [
+          "post-skiplinks",
+          "post-meta-navigation",
+          "post-language-switch",
+          "post-logo",
+          "post-main-navigation",
+          "post-search",
+          "post-klp-login-widget"
+        ]
+      }
+    }
+  ]
+}