@genesislcap/foundation-header 14.131.0 → 14.133.0

package/dist/foundation-header.api.json

@@ -184,6 +184,77 @@
       "name": "",
       "preserveMemberOrder": false,
       "members": [
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-header!ElementTargetId:type",
+          "docComment": "/**\n * Package element integration targets.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ElementTargetId = "
+            },
+            {
+              "kind": "Reference",
+              "text": "HeaderTargetId",
+              "canonicalReference": "@genesislcap/foundation-header!HeaderTargetId:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "NavTargetId",
+              "canonicalReference": "@genesislcap/foundation-header!NavTargetId:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "SideNavTargetId",
+              "canonicalReference": "@genesislcap/foundation-header!SideNavTargetId:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/config/targetId.ts",
+          "releaseTag": "Public",
+          "name": "ElementTargetId",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-header!HeaderTargetId:type",
+          "docComment": "/**\n * Header integration targets.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type HeaderTargetId = "
+            },
+            {
+              "kind": "Content",
+              "text": "'header-start' | 'header' | 'header-end'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/config/targetId.ts",
+          "releaseTag": "Public",
+          "name": "HeaderTargetId",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-header!LanguageOptions:type",
@@ -267,7 +338,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 notification - icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @param show - connection-indicator - Boolean attribute which controls whether the navigation bar will display the connection indicator.\n *\n * @param show - language-selector - Boolean attribute which controls whether the navigation bar will display the language selector.\n *\n * @param hide - side-bar - Boolean attribute which controls whether the navigation bar will display the side bar.\n *\n * @param userName - String which defines the username to be displayed in the navigation bar.\n *\n * @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.\n *\n * @param languageOptions - Object which defines the language options to be displayed in the language selector.\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 * @fires\n *\n * language-changed - Dispatched when the user changes the language in the language selector.\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 notification - icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @param show - connection-indicator - Boolean attribute which controls whether the navigation bar will display the connection indicator.\n *\n * @param show - language-selector - Boolean attribute which controls whether the navigation bar will display the language selector.\n *\n * @param hide - side-bar - Boolean attribute which controls whether the navigation bar will display the side bar.\n *\n * @param userName - String which defines the username to be displayed in the navigation bar.\n *\n * @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.\n *\n * @param routeNavItems - Array of {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} which define the route buttons to be displayed in the navigation bar.\n *\n * @param languageOptions - Object which defines the language options to be displayed in the language selector.\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 * @fires\n *\n * language-changed - Dispatched when the user changes the language in the language selector.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -675,7 +746,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-header!Navigation#routeButtons:member",
-              "docComment": "/**\n * If present the defined route buttons will be rendered in the header 'routes' slot\n */\n",
+              "docComment": "/**\n * If present the defined route buttons will be rendered in the header 'routes' slot\n *\n * @deprecated\n *\n * - Use `routeNavItems` instead.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -707,6 +778,41 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-header!Navigation#routeNavItems:member",
+              "docComment": "/**\n * If present the defined {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} will be rendered in the header 'routes' slot\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "routeNavItems: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FoundationRouteNavItem",
+                  "canonicalReference": "@genesislcap/foundation-ui!FoundationRouteNavItem:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "routeNavItems",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-header!Navigation#selectTemplate:member(1)",
@@ -879,7 +985,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-header!Navigation#showNotificationsButton:member",
-              "docComment": "/**\n * Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar Control via `show-notification-button`\n *\n * @remarks\n *\n * If the user clicks the icon when shown then this class will emit the 'notification-icon-clicked' event\n */\n",
+              "docComment": "/**\n * Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar Control via `show-notification-button`\n *\n * @remarks\n *\n * If the user clicks the icon when shown then this class will emit the 'notification-icon-clicked' event\n *\n * @deprecated\n *\n * - Add/Remove PBC Notify via `genx` instead.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -936,6 +1042,54 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-header!Navigation#toLocalisedText:member(1)",
+              "docComment": "/**\n * To localised text\n *\n * @remarks\n *\n * Returns localised version of the text if available.\n *\n * @experimental\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "toLocalisedText(text: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "text",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "toLocalisedText"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-header!Navigation#userName:member",
@@ -973,6 +1127,32 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-header!NavTargetId:type",
+          "docComment": "/**\n * Nav integration targets.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type NavTargetId = "
+            },
+            {
+              "kind": "Content",
+              "text": "'nav-start' | 'nav' | 'nav-end'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/config/targetId.ts",
+          "releaseTag": "Public",
+          "name": "NavTargetId",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-header!NavTemplate:var",
@@ -1009,6 +1189,58 @@
             "startIndex": 1,
             "endIndex": 5
           }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-header!SideNavTargetId:type",
+          "docComment": "/**\n * Side nav integration targets.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type SideNavTargetId = "
+            },
+            {
+              "kind": "Content",
+              "text": "'side-nav-start' | 'side-nav' | 'side-nav-end'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/config/targetId.ts",
+          "releaseTag": "Public",
+          "name": "SideNavTargetId",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-header!StyleTargetId:type",
+          "docComment": "/**\n * Package style integration targets.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StyleTargetId = "
+            },
+            {
+              "kind": "Content",
+              "text": "'header'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/config/targetId.ts",
+          "releaseTag": "Public",
+          "name": "StyleTargetId",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
         }
       ]
     }

package/dist/foundation-header.d.ts

@@ -4,9 +4,24 @@ import { CredentialManager } from '@genesislcap/foundation-comms';
 import { ElementStyles } from '@microsoft/fast-element';
 import { EmitOptions } from '@genesislcap/foundation-events';
 import { EmitReturn } from '@genesislcap/foundation-events';
+import type { FoundationRouteNavItem } from '@genesislcap/foundation-ui';
 import { I18next } from '@genesislcap/foundation-i18n';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+/**
+ * Package element integration targets.
+ *
+ * @public
+ */
+export declare type ElementTargetId = HeaderTargetId | NavTargetId | SideNavTargetId;
+
+/**
+ * Header integration targets.
+ *
+ * @public
+ */
+export declare type HeaderTargetId = 'header-start' | 'header' | 'header-end';
+
 /**
  * Options for the language selector
  * @public
@@ -58,6 +73,7 @@ export declare type NavEventDetailMap = {
  *
  * @param userName - String which defines the username to be displayed in the navigation bar.
  * @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.
+ * @param routeNavItems - Array of {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} which define the route buttons to be displayed in the navigation bar.
  * @param languageOptions - Object which defines the language options to be displayed in the language selector.
  *
  * @public
@@ -113,8 +129,14 @@ export declare class Navigation extends Navigation_base {
      * @remarks
      *
      * If the user clicks the icon when shown then this class will emit the 'notification-icon-clicked' event
+     *
+     * @deprecated - Add/Remove PBC Notify via `genx` instead.
      */
     showNotificationsButton: boolean;
+    /**
+     * @internal
+     */
+    showNotificationsButtonChanged(): void;
     /**
      * Boolean attribute which controls whether to show the connection indicator on the navigation bar
      * Control via `show-connection-indicator`
@@ -140,6 +162,8 @@ export declare class Navigation extends Navigation_base {
     hideSideBar: boolean;
     /**
      * If present the defined route buttons will be rendered in the header 'routes' slot
+     *
+     * @deprecated - Use `routeNavItems` instead.
      */
     routeButtons: Array<{
         index: number;
@@ -148,6 +172,14 @@ export declare class Navigation extends Navigation_base {
         icon: string;
         variant: string;
     }>;
+    /**
+     * @internal
+     */
+    routeButtonsChanged(): void;
+    /**
+     * If present the defined {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} will be rendered in the header 'routes' slot
+     */
+    routeNavItems: FoundationRouteNavItem[];
     /**
      * Load remote components
      *
@@ -236,6 +268,16 @@ export declare class Navigation extends Navigation_base {
      * @experimental
      */
     changeLanguage(e: CustomEvent): void;
+    /**
+     * To localised text
+     * @remarks
+     * Returns localised version of the text if available.
+     * @experimental
+     * @privateRemarks
+     * Perhaps move things like showLanguageSelector into the config and just call i18next directly for translations.
+     * Is languageOptions needed.
+     */
+    toLocalisedText(text: string): string;
 }
 
 declare const Navigation_base: abstract new (...args: any[]) => {
@@ -268,7 +310,9 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     readonly classList: DOMTokenList;
     className: string;
     readonly clientHeight: number;
-    readonly clientLeft: number;
+    readonly clientLeft: number; /**
+    * Username of the logged in user
+    */
     readonly clientTop: number;
     readonly clientWidth: number;
     id: string;
@@ -340,17 +384,7 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     readonly lastChild: ChildNode;
     readonly nextSibling: ChildNode;
     readonly nodeName: string;
-    readonly nodeType: number; /**
-    * Changes the route of the current page
-    *
-    * @remarks
-    *
-    * Requires setup of the Router and usage of the FAST Router
-    *
-    * @param path - string represeting the new route to move to
-    *
-    * @public
-    */
+    readonly nodeType: number;
     nodeValue: string;
     readonly parentElement: HTMLElement;
     readonly parentNode: ParentNode;
@@ -362,16 +396,6 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     contains(other: Node): boolean;
     getRootNode(options?: GetRootNodeOptions): Node;
     hasChildNodes(): boolean;
-    /**
-     * Opens the flyout menu on the left hand side
-     *
-     * @remarks
-     *
-     * Activated when the user clicks on the menu button on the navigation
-     * bar left hand side
-     *
-     * @internal
-     */
     insertBefore<T_1 extends Node>(node: T_1, child: Node): T_1;
     isDefaultNamespace(namespace: string): boolean;
     isEqualNode(otherNode: Node): boolean;
@@ -439,7 +463,16 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     ariaValueMin: string;
     ariaValueNow: string;
     ariaValueText: string;
-    role: string;
+    role: string; /**
+    * Emits the event corresponding to the notification icon being clicked
+    *
+    * @remarks
+    *
+    * Activated when the user clicks on the bell icon on the navigation
+    * bar right hand side
+    *
+    * @internal
+    */
     animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
     getAnimations(options?: GetAnimationsOptions): Animation[];
     after(...nodes: (string | Node)[]): void;
@@ -574,6 +607,13 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
 };
 
+/**
+ * Nav integration targets.
+ *
+ * @public
+ */
+export declare type NavTargetId = 'nav-start' | 'nav' | 'nav-end';
+
 /**
  * Template for Navigation class
  *
@@ -589,4 +629,18 @@ declare const Navigation_base: abstract new (...args: any[]) => {
  */
 export declare const NavTemplate: ViewTemplate<Navigation, any>;
 
+/**
+ * Side nav integration targets.
+ *
+ * @public
+ */
+export declare type SideNavTargetId = 'side-nav-start' | 'side-nav' | 'side-nav-end';
+
+/**
+ * Package style integration targets.
+ *
+ * @public
+ */
+export declare type StyleTargetId = 'header';
+
 export { }

package/docs/api/foundation-header.elementtargetid.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [ElementTargetId](./foundation-header.elementtargetid.md)
+
+## ElementTargetId type
+
+Package element integration targets.
+
+**Signature:**
+
+```typescript
+export type ElementTargetId = HeaderTargetId | NavTargetId | SideNavTargetId;
+```
+**References:** [HeaderTargetId](./foundation-header.headertargetid.md)<!-- -->, [NavTargetId](./foundation-header.navtargetid.md)<!-- -->, [SideNavTargetId](./foundation-header.sidenavtargetid.md)
+

package/docs/api/foundation-header.headertargetid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [HeaderTargetId](./foundation-header.headertargetid.md)
+
+## HeaderTargetId type
+
+Header integration targets.
+
+**Signature:**
+
+```typescript
+export type HeaderTargetId = 'header-start' | 'header' | 'header-end';
+```

package/docs/api/foundation-header.md

@@ -21,6 +21,11 @@
 
 |  Type Alias | Description |
 |  --- | --- |
+|  [ElementTargetId](./foundation-header.elementtargetid.md) | Package element integration targets. |
+|  [HeaderTargetId](./foundation-header.headertargetid.md) | Header integration targets. |
 |  [LanguageOptions](./foundation-header.languageoptions.md) | Options for the language selector |
 |  [NavEventDetailMap](./foundation-header.naveventdetailmap.md) | Events dispatched by the navigation control buttons |
+|  [NavTargetId](./foundation-header.navtargetid.md) | Nav integration targets. |
+|  [SideNavTargetId](./foundation-header.sidenavtargetid.md) | Side nav integration targets. |
+|  [StyleTargetId](./foundation-header.styletargetid.md) | Package style integration targets. |
 

package/docs/api/foundation-header.navigation.md

@@ -29,6 +29,7 @@ export declare class Navigation extends Navigation_base
 |  [logoSrc](./foundation-header.navigation.logosrc.md) |  | any | Optional attribute which controls the icon to show on the navigation bar and flyout Control via <code>logo-src</code> |
 |  [ready](./foundation-header.navigation.ready.md) |  | boolean |  |
 |  [routeButtons](./foundation-header.navigation.routebuttons.md) |  | Array&lt;{ index: number; path: string; title: string; icon: string; variant: string; }&gt; | If present the defined route buttons will be rendered in the header 'routes' slot |
+|  [routeNavItems](./foundation-header.navigation.routenavitems.md) |  | FoundationRouteNavItem\[\] | If present the defined  will be rendered in the header 'routes' slot |
 |  [showConnectionIndicator](./foundation-header.navigation.showconnectionindicator.md) |  | boolean | Boolean attribute which controls whether to show the connection indicator on the navigation bar Control via <code>show-connection-indicator</code> |
 |  [showLanguageSelector](./foundation-header.navigation.showlanguageselector.md) |  | boolean | Boolean attribute which controls whether to show the language selector on the navigation bar Control via <code>show-language-selector</code> |
 |  [showLuminanceToggleButton](./foundation-header.navigation.showluminancetogglebutton.md) |  | boolean | Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar Control via<code>show-luminance-toggle-button</code> |
@@ -46,4 +47,5 @@ export declare class Navigation extends Navigation_base
 |  [logout()](./foundation-header.navigation.logout.md) |  | Logs the user out of their session |
 |  [navigateTo(path)](./foundation-header.navigation.navigateto.md) |  | Changes the route of the current page |
 |  [selectTemplate()](./foundation-header.navigation.selecttemplate.md) |  |  |
+|  [toLocalisedText(text)](./foundation-header.navigation.tolocalisedtext.md) |  | To localised text |
 

package/docs/api/foundation-header.navigation.routebuttons.md

@@ -4,6 +4,11 @@
 
 ## Navigation.routeButtons property
 
+> Warning: This API is now obsolete.
+> 
+> - Use `routeNavItems` instead.
+> 
+
 If present the defined route buttons will be rendered in the header 'routes' slot
 
 **Signature:**

package/docs/api/foundation-header.navigation.routenavitems.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md) &gt; [routeNavItems](./foundation-header.navigation.routenavitems.md)
+
+## Navigation.routeNavItems property
+
+If present the defined  will be rendered in the header 'routes' slot
+
+**Signature:**
+
+```typescript
+routeNavItems: FoundationRouteNavItem[];
+```

package/docs/api/foundation-header.navigation.shownotificationsbutton.md

@@ -4,6 +4,11 @@
 
 ## Navigation.showNotificationsButton property
 
+> Warning: This API is now obsolete.
+> 
+> - Add/Remove PBC Notify via `genx` instead.
+> 
+
 Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar Control via `show-notification-button`
 
 **Signature:**

package/docs/api/foundation-header.navigation.tolocalisedtext.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md) &gt; [toLocalisedText](./foundation-header.navigation.tolocalisedtext.md)
+
+## Navigation.toLocalisedText() method
+
+To localised text
+
+**Signature:**
+
+```typescript
+toLocalisedText(text: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  text | string |  |
+
+**Returns:**
+
+string
+
+## Remarks
+
+Returns localised version of the text if available.
+

package/docs/api/foundation-header.navtargetid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [NavTargetId](./foundation-header.navtargetid.md)
+
+## NavTargetId type
+
+Nav integration targets.
+
+**Signature:**
+
+```typescript
+export type NavTargetId = 'nav-start' | 'nav' | 'nav-end';
+```

package/docs/api/foundation-header.sidenavtargetid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [SideNavTargetId](./foundation-header.sidenavtargetid.md)
+
+## SideNavTargetId type
+
+Side nav integration targets.
+
+**Signature:**
+
+```typescript
+export type SideNavTargetId = 'side-nav-start' | 'side-nav' | 'side-nav-end';
+```

package/docs/api/foundation-header.styletargetid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [StyleTargetId](./foundation-header.styletargetid.md)
+
+## StyleTargetId type
+
+Package style integration targets.
+
+**Signature:**
+
+```typescript
+export type StyleTargetId = 'header';
+```