@genesislcap/foundation-header 14.278.3 → 14.281.0

package/dist/custom-elements.json

@@ -25,6 +25,48 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/rapid-components.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "registerCommonRapidComponents",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "registerCommonRapidComponents",
+          "declaration": {
+            "name": "registerCommonRapidComponents",
+            "module": "src/components/rapid-components.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/zero-components.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "registerCommonZeroComponents",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "registerCommonZeroComponents",
+          "declaration": {
+            "name": "registerCommonZeroComponents",
+            "module": "src/components/zero-components.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/config/config.ts",
@@ -180,48 +222,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/rapid-components.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "registerCommonRapidComponents",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "registerCommonRapidComponents",
-          "declaration": {
-            "name": "registerCommonRapidComponents",
-            "module": "src/components/rapid-components.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/zero-components.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "registerCommonZeroComponents",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "registerCommonZeroComponents",
-          "declaration": {
-            "name": "registerCommonZeroComponents",
-            "module": "src/components/zero-components.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/main/index.ts",
@@ -287,7 +287,7 @@
         {
           "kind": "variable",
           "name": "navTemplate",
-          "default": "html<Navigation>`\n  ${when((x) => !x.hideSideBar, sideNavTemplate)}\n  <div class=\"nav-listbox\" data-test-id=\"nav-bar\" role=\"navigation\" aria-label=\"Main menu\">\n    ${app.registerElementsTarget<HeaderTargetId>('header-start')}\n    <div class=\"nav-leftside\">\n      ${app.registerElementsTarget<NavTargetId>('nav-start')}\n      ${when(\n        (x) => !x.hideSideBar,\n        html<Navigation>`\n          <${buttonTag}\n            class=\"bars-container\"\n            @click=${(x) => x.toggleNavVisibility()}\n            data-test-id=\"hamburger-menu\"\n            aria-label=\"Toggle side menu\"\n            aria-controls=\"side-nav\"\n            aria-expanded=${(x) => x.sideNavOpen}\n            appearance=\"stealth\"\n            @focusin=${(x) => x.closeNav()}\n          >\n            <${iconTag}\n              name=\"bars\"\n              part=\"nav-visibility-icon\"\n              class=\"nav-visibility-icon\"\n            >\n            </${iconTag}>\n          </${buttonTag}>\n        `,\n      )}\n      <div class=\"logo-container\" data-test-id=\"nav-bar-logo\">\n        <img\n          src=${(x) => x.logoSrc}\n          class=\"logo\"\n          part=\"logo\"\n          data-test-id=\"logo\"\n          alt=\"${(x) => x.logoAltText}\"\n        />\n      </div>\n      <slot name=\"routes\" data-test-id=\"route-buttons\">\n        ${(x) => (x.routeNavItems ? routeNavItemsTemplate('header') : defaultRouteNavItemsTemplate)}\n      </slot>\n      ${app.registerElementsTarget<NavTargetId>('nav')}\n    </div>\n    <div class=\"nav-rightside\">\n      ${app.registerElementsTarget<NavTargetId>('nav-end')}\n      <slot name=\"routes-end\" data-test-id=\"route-end-buttons\"></slot>\n      ${when(\n        (x) => x.showLuminanceToggleButton,\n        html<Navigation>`\n          <div\n            class=\"icon-container\"\n            data-test-id=\"luminance-toggle-button\"\n            part=\"luminance-button\"\n            aria-label=\"Luminance toggle\"\n          >\n            <${iconTag}\n              @click=${(x) => x.luminanceIconEvent()}\n              variant=\"regular\"\n              name=\"moon\"\n              part=\"luminance-icon\"\n            ></${iconTag}>\n          </div>\n        `,\n      )}\n      ${when(\n        (x) => x.showMiscToggleButton,\n        html<Navigation>`\n          <div class=\"icon-container\" data-test-id=\"misc-toggle-button\" part=\"misc-button\" aria-label=\"Misc icon\">\n            <${iconTag} @click=${(x) => x.miscIconEvent()} name=\"th\" part=\"misc-icon\">\n            </${iconTag}>\n          </div>\n        `,\n      )}\n      ${when(\n        (x) => x.showConnectionIndicator,\n        html<Navigation>`\n          <div class=\"connection-indicator-container\" data-test-id=\"connection-indicator\">\n            <${connectionIndicatorTag} show-label=\"false\">\n            </${connectionIndicatorTag}>\n          </div>\n        `,\n      )}\n      ${when(\n        (x) => x.showLanguageSelector && x.languageOptions,\n        html<Navigation>`\n          <${selectTag}\n            class=\"language-selector\"\n            position=\"below\"\n            data-test-id=\"language-selector\"\n            part=\"language-selector\"\n            @change=\"${(x, c) => x.changeLanguage(c.event as CustomEvent)}\"\n            aria-label=\"Language selector\"\n          >\n            ${repeat(\n              (x) => x.languageOptions.availableLanguages,\n              html`\n                <${optionTag}\n                  value=\"${(x) => x}\"\n                  ?selected=\"${(x, c) => x === c.parent.languageOptions.selectedLanguage}\"\n                >\n                  ${(x) => x.toUpperCase()}\n                </${optionTag}>\n              `,\n            )}\n          </${selectTag}>\n        `,\n      )}\n\n      <${buttonTag} appearance=\"neutral-grey\" data-test-id=\"user-button\" class=\"nav-button\" aria-label=\"User button\">\n        <${iconTag} name=\"user-circle\"></${iconTag}>\n        ${(x) => x.userName}\n      </${buttonTag}>\n    </div>\n    ${app.registerElementsTarget<HeaderTargetId>(['header', 'header-end'])}\n  </div>\n`",
+          "default": "html<Navigation>`\n  ${when((x) => !x.hideSideBar, sideNavTemplate)}\n  <div class=\"nav-listbox\" data-test-id=\"nav-bar\" role=\"navigation\" aria-label=\"Main menu\">\n    ${app.registerElementsTarget<HeaderTargetId>('header-start')}\n    <div class=\"nav-leftside\">\n      ${app.registerElementsTarget<NavTargetId>('nav-start')}\n      ${when(\n        (x) => !x.hideSideBar,\n        html<Navigation>`\n          <${buttonTag}\n            class=\"bars-container\"\n            @click=${(x) => x.toggleNavVisibility()}\n            data-test-id=\"hamburger-menu\"\n            aria-label=\"Toggle side menu\"\n            aria-controls=\"side-nav\"\n            aria-expanded=${(x) => x.sideNavOpen}\n            appearance=\"stealth\"\n            @focusin=${(x) => x.closeNav()}\n          >\n            <${iconTag}\n              name=\"bars\"\n              part=\"nav-visibility-icon\"\n              class=\"nav-visibility-icon\"\n            >\n            </${iconTag}>\n          </${buttonTag}>\n        `,\n      )}\n      <div class=\"logo-container\" data-test-id=\"nav-bar-logo\">\n        <img\n          src=${(x) => x.logoSrc}\n          class=\"logo\"\n          part=\"logo\"\n          data-test-id=\"logo\"\n          alt=\"${(x) => x.logoAltText}\"\n        />\n      </div>\n      <slot name=\"routes\" data-test-id=\"route-buttons\">\n        ${(x) => (x.routeNavItems ? routeNavItemsTemplate('header') : defaultRouteNavItemsTemplate)}\n      </slot>\n      ${app.registerElementsTarget<NavTargetId>('nav')}\n    </div>\n    <div class=\"nav-rightside\">\n      ${app.registerElementsTarget<NavTargetId>('nav-end')}\n      <slot name=\"routes-end\" data-test-id=\"route-end-buttons\"></slot>\n      ${when(\n        (x) => x.showLuminanceToggleButton,\n        html<Navigation>`\n          <div\n            class=\"icon-container\"\n            data-test-id=\"luminance-toggle-button\"\n            part=\"luminance-button\"\n            aria-label=\"Luminance toggle\"\n          >\n            <${iconTag}\n              @click=${(x) => x.luminanceIconEvent()}\n              variant=\"regular\"\n              name=\"moon\"\n              part=\"luminance-icon\"\n            ></${iconTag}>\n          </div>\n        `,\n      )}\n      ${when(\n        (x) => x.showMiscToggleButton,\n        html<Navigation>`\n          <div class=\"icon-container\" data-test-id=\"misc-toggle-button\" part=\"misc-button\" aria-label=\"Misc icon\">\n            <${iconTag} @click=${(x) => x.miscIconEvent()} name=\"th\" part=\"misc-icon\">\n            </${iconTag}>\n          </div>\n        `,\n      )}\n      ${when(\n        (x) => x.showConnectionIndicator,\n        html<Navigation>`\n          <div class=\"connection-indicator-container\" data-test-id=\"connection-indicator\">\n            <${connectionIndicatorTag} show-label=\"false\">\n            </${connectionIndicatorTag}>\n          </div>\n        `,\n      )}\n      ${when(\n        (x) => x.showLanguageSelector && x.languageOptions,\n        html<Navigation>`\n          <${selectTag}\n            class=\"language-selector\"\n            position=\"below\"\n            data-test-id=\"language-selector\"\n            part=\"language-selector\"\n            @change=\"${(x, c) => x.changeLanguage(c.event as CustomEvent)}\"\n            aria-label=\"Language selector\"\n          >\n            ${repeat(\n              (x) => x.languageOptions.availableLanguages,\n              html`\n                <${optionTag}\n                  value=\"${(x) => x}\"\n                  ?selected=\"${(x, c) => x === c.parent.languageOptions.selectedLanguage}\"\n                >\n                  ${(x) => x.toUpperCase()}\n                </${optionTag}>\n              `,\n            )}\n          </${selectTag}>\n        `,\n      )}\n      ${() => accountMenuTemplate}\n    </div>\n    ${app.registerElementsTarget<HeaderTargetId>(['header', 'header-end'])}\n  </div>\n`",
           "description": "Template for Navigation class",
           "return": {
             "type": {
@@ -446,6 +446,15 @@
               },
               "description": "Boolean attribute which controls whether to include the sideNav component\nControl via`hide-side-bar`"
             },
+            {
+              "kind": "field",
+              "name": "logoutButtonPosition",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`"
+            },
             {
               "kind": "field",
               "name": "routeButtons",
@@ -463,6 +472,24 @@
               },
               "description": "If present the defined @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems will be rendered in the header 'routes' slot"
             },
+            {
+              "kind": "field",
+              "name": "showAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`"
+            },
+            {
+              "kind": "field",
+              "name": "shouldShowAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Computed property that determines if the account menu should be shown",
+              "readonly": true
+            },
             {
               "kind": "method",
               "name": "selectTemplate",
@@ -539,6 +566,25 @@
                 }
               ],
               "description": "To localised text"
+            },
+            {
+              "kind": "method",
+              "name": "handleNavButtonClick",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "routeNavItem",
+                  "type": {
+                    "text": "FoundationRouteNavItem"
+                  },
+                  "description": "The navigation item that was clicked"
+                }
+              ],
+              "description": "Handles the click event for a navigation button"
             }
           ],
           "events": [
@@ -561,6 +607,10 @@
             {
               "description": "Dispatched when the user clicks logout button.",
               "name": "logout-clicked"
+            },
+            {
+              "description": "Dispatched when the user clicks a navigation button.",
+              "name": "nav-button-clicked"
             }
           ],
           "attributes": [
@@ -635,6 +685,24 @@
               },
               "description": "Boolean attribute which controls whether to include the sideNav component\nControl via`hide-side-bar`",
               "fieldName": "hideSideBar"
+            },
+            {
+              "name": "logout-button-position",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "fieldName": "logoutButtonPosition"
+            },
+            {
+              "name": "show-account-menu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "fieldName": "showAccountMenu"
             }
           ],
           "mixins": [
@@ -857,6 +925,19 @@
                 "module": "src/main/main.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "logoutButtonPosition",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "routeButtons",
@@ -882,6 +963,32 @@
                 "module": "src/main/main.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "showAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "shouldShowAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Computed property that determines if the account menu should be shown",
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "selectTemplate",
@@ -978,6 +1085,29 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "kind": "method",
+              "name": "handleNavButtonClick",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "routeNavItem",
+                  "type": {
+                    "text": "FoundationRouteNavItem"
+                  },
+                  "description": "The navigation item that was clicked"
+                }
+              ],
+              "description": "Handles the click event for a navigation button",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ],
           "superclass": {
@@ -1088,6 +1218,32 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "name": "logout-button-position",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "fieldName": "logoutButtonPosition",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
+            {
+              "name": "show-account-menu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "fieldName": "showAccountMenu",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ],
           "events": [
@@ -1130,6 +1286,14 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "description": "Dispatched when the user clicks a navigation button.",
+              "name": "nav-button-clicked",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ]
         },
@@ -1248,6 +1412,32 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "name": "logout-button-position",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "fieldName": "logoutButtonPosition",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
+            {
+              "name": "show-account-menu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "fieldName": "showAccountMenu",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ],
           "members": [
@@ -1444,6 +1634,19 @@
                 "module": "src/main/main.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "logoutButtonPosition",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "routeButtons",
@@ -1469,6 +1672,32 @@
                 "module": "src/main/main.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "showAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "shouldShowAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Computed property that determines if the account menu should be shown",
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "selectTemplate",
@@ -1565,6 +1794,29 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "kind": "method",
+              "name": "handleNavButtonClick",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "routeNavItem",
+                  "type": {
+                    "text": "FoundationRouteNavItem"
+                  },
+                  "description": "The navigation item that was clicked"
+                }
+              ],
+              "description": "Handles the click event for a navigation button",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ],
           "events": [
@@ -1607,6 +1859,14 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "description": "Dispatched when the user clicks a navigation button.",
+              "name": "nav-button-clicked",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ]
         },
@@ -1822,6 +2082,19 @@
                 "module": "src/main/main.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "logoutButtonPosition",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "routeButtons",
@@ -1847,6 +2120,32 @@
                 "module": "src/main/main.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "showAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "shouldShowAccountMenu",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Computed property that determines if the account menu should be shown",
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "logout",
@@ -1929,6 +2228,29 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "kind": "method",
+              "name": "handleNavButtonClick",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "routeNavItem",
+                  "type": {
+                    "text": "FoundationRouteNavItem"
+                  },
+                  "description": "The navigation item that was clicked"
+                }
+              ],
+              "description": "Handles the click event for a navigation button",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ],
           "superclass": {
@@ -2041,6 +2363,32 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "name": "logout-button-position",
+              "type": {
+                "text": "'side-nav' | 'account-menu' | 'none'"
+              },
+              "default": "'side-nav'",
+              "description": "String attribute which controls the position of the logout button in the header\nControl via `logout-button-position`",
+              "fieldName": "logoutButtonPosition",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
+            },
+            {
+              "name": "show-account-menu",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Boolean attribute which controls whether to show the account menu on the navigation bar\nControl via `show-account-menu`",
+              "fieldName": "showAccountMenu",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ],
           "events": [
@@ -2083,6 +2431,14 @@
                 "name": "Navigation",
                 "module": "src/main/main.ts"
               }
+            },
+            {
+              "description": "Dispatched when the user clicks a navigation button.",
+              "name": "nav-button-clicked",
+              "inheritedFrom": {
+                "name": "Navigation",
+                "module": "src/main/main.ts"
+              }
             }
           ]
         }