@genesislcap/foundation-header 14.70.6 → 14.70.8

package/dist/custom-elements.json

@@ -71,6 +71,167 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/styles/colors.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "getWebRGBA",
+          "parameters": [
+            {
+              "name": "rgb",
+              "type": {
+                "text": "ColorRGBA64"
+              }
+            },
+            {
+              "name": "alpha",
+              "default": "1.0",
+              "type": {
+                "text": "number"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "variable",
+          "name": "defaultBackgroundHover"
+        },
+        {
+          "kind": "variable",
+          "name": "defaultBackgroundItem"
+        },
+        {
+          "kind": "variable",
+          "name": "backgroundNavOption"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "getWebRGBA",
+          "declaration": {
+            "name": "getWebRGBA",
+            "module": "src/styles/colors.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "defaultBackgroundHover",
+          "declaration": {
+            "name": "defaultBackgroundHover",
+            "module": "src/styles/colors.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "defaultBackgroundItem",
+          "declaration": {
+            "name": "defaultBackgroundItem",
+            "module": "src/styles/colors.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "backgroundNavOption",
+          "declaration": {
+            "name": "backgroundNavOption",
+            "module": "src/styles/colors.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/styles/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./colors"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./styles"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/styles/styles.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "mixinScreen",
+          "parameters": [
+            {
+              "name": "display",
+              "default": "'block'",
+              "type": {
+                "text": "string"
+              }
+            }
+          ],
+          "description": "TODO: Bring all the style and typography mixins into the design system package"
+        },
+        {
+          "kind": "function",
+          "name": "genesisLogo",
+          "parameters": [
+            {
+              "name": "slot",
+              "default": "'start'"
+            }
+          ],
+          "description": "TODO"
+        },
+        {
+          "kind": "function",
+          "name": "settingsIcon",
+          "parameters": [
+            {
+              "name": "slot",
+              "default": "'start'"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "mixinScreen",
+          "declaration": {
+            "name": "mixinScreen",
+            "module": "src/styles/styles.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "genesisLogo",
+          "declaration": {
+            "name": "genesisLogo",
+            "module": "src/styles/styles.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "settingsIcon",
+          "declaration": {
+            "name": "settingsIcon",
+            "module": "src/styles/styles.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/main/index.ts",
@@ -290,6 +451,20 @@
               "description": "Changes the route of the current page"
             }
           ],
+          "events": [
+            {
+              "description": "Dispatched when the user clicks on the luminance toggle icon in the navigation bar.",
+              "name": "luminance-icon-clicked"
+            },
+            {
+              "description": "Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.",
+              "name": "misc-icon-clicked"
+            },
+            {
+              "description": "Dispatched when the user clicks on the notification icon in the navigation bar.",
+              "name": "notification-icon-clicked"
+            }
+          ],
           "attributes": [
             {
               "name": "logo-src",
@@ -378,167 +553,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/styles/colors.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "getWebRGBA",
-          "parameters": [
-            {
-              "name": "rgb",
-              "type": {
-                "text": "ColorRGBA64"
-              }
-            },
-            {
-              "name": "alpha",
-              "default": "1.0",
-              "type": {
-                "text": "number"
-              }
-            }
-          ]
-        },
-        {
-          "kind": "variable",
-          "name": "defaultBackgroundHover"
-        },
-        {
-          "kind": "variable",
-          "name": "defaultBackgroundItem"
-        },
-        {
-          "kind": "variable",
-          "name": "backgroundNavOption"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "getWebRGBA",
-          "declaration": {
-            "name": "getWebRGBA",
-            "module": "src/styles/colors.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "defaultBackgroundHover",
-          "declaration": {
-            "name": "defaultBackgroundHover",
-            "module": "src/styles/colors.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "defaultBackgroundItem",
-          "declaration": {
-            "name": "defaultBackgroundItem",
-            "module": "src/styles/colors.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "backgroundNavOption",
-          "declaration": {
-            "name": "backgroundNavOption",
-            "module": "src/styles/colors.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/styles/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./colors"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./styles"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/styles/styles.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "mixinScreen",
-          "parameters": [
-            {
-              "name": "display",
-              "default": "'block'",
-              "type": {
-                "text": "string"
-              }
-            }
-          ],
-          "description": "TODO: Bring all the style and typography mixins into the design system package"
-        },
-        {
-          "kind": "function",
-          "name": "genesisLogo",
-          "parameters": [
-            {
-              "name": "slot",
-              "default": "'start'"
-            }
-          ],
-          "description": "TODO"
-        },
-        {
-          "kind": "function",
-          "name": "settingsIcon",
-          "parameters": [
-            {
-              "name": "slot",
-              "default": "'start'"
-            }
-          ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "mixinScreen",
-          "declaration": {
-            "name": "mixinScreen",
-            "module": "src/styles/styles.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "genesisLogo",
-          "declaration": {
-            "name": "genesisLogo",
-            "module": "src/styles/styles.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "settingsIcon",
-          "declaration": {
-            "name": "settingsIcon",
-            "module": "src/styles/styles.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/utils/index.ts",

package/dist/dts/main/main.d.ts

@@ -33,6 +33,11 @@ declare const Navigation_base: abstract new (...args: any[]) => {
  * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
  *
  * @public
+ *
+ * @fires luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.
+ * @fires misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.
+ * @fires notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.
+ *
  */
 export declare class Navigation extends Navigation_base {
     auth: Auth;

package/dist/dts/main/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAUtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;AAKF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAUtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;AAKF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}

package/dist/esm/main/main.js

@@ -26,6 +26,11 @@ import { DynamicTemplate as template, LoadingTemplate, MainTemplate } from './ma
  * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
  *
  * @public
+ *
+ * @fires luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.
+ * @fires misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.
+ * @fires notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.
+ *
  */
 let Navigation = class Navigation extends EventEmitter(FASTElement) {
     constructor() {

package/dist/foundation-header.api.json

@@ -125,6 +125,16 @@
         {
           "tagName": "@preapproved",
           "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@tagname",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@fires",
+          "syntaxKind": "block",
+          "allowMultiple": true
         }
       ],
       "supportForTags": {
@@ -155,7 +165,9 @@
         "@virtual": true,
         "@betaDocumentation": true,
         "@internalRemarks": true,
-        "@preapproved": true
+        "@preapproved": true,
+        "@tagname": true,
+        "@fires": true
       },
       "reportUnsupportedHtmlElements": false
     }
@@ -229,7 +241,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-header!Navigation:class",
-          "docComment": "/**\n * Navigation micro-frontend includes navigation bar and flyout menu\n *\n * @remarks\n *\n * `foundation-header` micro-frontend can be added to the project to include a navigation bar and flyout menu. There are multiple ways that the behaviour of the component can be configured - the icon shown on the navigation bar and flyout menu (this shows the Genesis logo by default). - navigation links at the left-hand side of the navigation bar. - the control buttons on the right-hand side of the navigation bar can be shown or hidden, and their behaviour controlled via event listeners - The contents of the flyout menu.\n *\n * @param logo - src - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.\n *\n * @param show - luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.\n *\n * @param show - misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.\n *\n * @param show - misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Navigation micro-frontend includes navigation bar and flyout menu\n *\n * @remarks\n *\n * `foundation-header` micro-frontend can be added to the project to include a navigation bar and flyout menu. There are multiple ways that the behaviour of the component can be configured - the icon shown on the navigation bar and flyout menu (this shows the Genesis logo by default). - navigation links at the left-hand side of the navigation bar. - the control buttons on the right-hand side of the navigation bar can be shown or hidden, and their behaviour controlled via event listeners - The contents of the flyout menu.\n *\n * @param logo - src - Option attribute which sets the source of the image in the navigation bar and flyout menu. The Genesis logo will be shown if this attribute is not provided.\n *\n * @param show - luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.\n *\n * @param show - misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.\n *\n * @param show - misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @fires\n *\n * luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.\n *\n * @fires\n *\n * misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.\n *\n * @fires\n *\n * notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-header.d.ts

@@ -43,6 +43,11 @@ export declare type NavEventDetailMap = {
  * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
  *
  * @public
+ *
+ * @fires luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.
+ * @fires misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.
+ * @fires notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.
+ *
  */
 export declare class Navigation extends Navigation_base {
     auth: Auth;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-header",
   "description": "Genesis Foundation Header",
-  "version": "14.70.6",
+  "version": "14.70.8",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/foundation-header.d.ts",
@@ -50,15 +50,15 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.70.6",
-    "@genesislcap/genx": "14.70.6",
+    "@genesislcap/foundation-testing": "14.70.8",
+    "@genesislcap/genx": "14.70.8",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.70.6",
-    "@genesislcap/foundation-events": "14.70.6",
-    "@genesislcap/foundation-utils": "14.70.6",
-    "@genesislcap/foundation-zero": "14.70.6",
+    "@genesislcap/foundation-comms": "14.70.8",
+    "@genesislcap/foundation-events": "14.70.8",
+    "@genesislcap/foundation-utils": "14.70.8",
+    "@genesislcap/foundation-zero": "14.70.8",
     "@microsoft/fast-colors": "^5.1.4",
     "@microsoft/fast-components": "^2.21.3",
     "@microsoft/fast-element": "^1.7.0",
@@ -74,5 +74,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "c67f1046260013b98c62da1abf3e9450cd85d265"
+  "gitHead": "c040315dbacd807322ec80da100e541e05234b19"
 }

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": [ "../../../../tsdoc.json" ]
+}