@genesislcap/foundation-header 14.408.0 → 14.409.0

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

@@ -1,58 +0,0 @@
-<!-- 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; [navigateTo](./foundation-header.navigation.navigateto.md)
-
-## Navigation.navigateTo() method
-
-Changes the route of the current page
-
-**Signature:**
-
-```typescript
-navigateTo(path: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-path
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-string representing the new route to move to
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-Requires setup of the Router and usage of the Router
-

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

@@ -1,13 +0,0 @@
-<!-- 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; [pathName](./foundation-header.navigation.pathname.md)
-
-## Navigation.pathName property
-
-Current pathname for route highlighting
-
-**Signature:**
-
-```typescript
-get pathName(): string;
-```

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

@@ -1,24 +0,0 @@
-<!-- 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; [routeButtons](./foundation-header.navigation.routebuttons.md)
-
-## 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:**
-
-```typescript
-routeButtons: Array<{
-        index: number;
-        path: string;
-        title: string;
-        icon: string;
-        variant: string;
-    }>;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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.selecttemplate.md

@@ -1,19 +0,0 @@
-<!-- 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; [selectTemplate](./foundation-header.navigation.selecttemplate.md)
-
-## Navigation.selectTemplate() method
-
-Selects the appropriate template based on the component's state
-
-**Signature:**
-
-```typescript
-selectTemplate(): ViewTemplate<Navigation>;
-```
-**Returns:**
-
-ViewTemplate&lt;[Navigation](./foundation-header.navigation.md)<!-- -->&gt;
-
-{<!-- -->ViewTemplate<Navigation>}
-

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

@@ -1,15 +0,0 @@
-<!-- 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; [setLuminance](./foundation-header.navigation.setluminance.md)
-
-## Navigation.setLuminance() method
-
-**Signature:**
-
-```typescript
-setLuminance(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [shouldShowAccountMenu](./foundation-header.navigation.shouldshowaccountmenu.md)
-
-## Navigation.shouldShowAccountMenu property
-
-Computed property that determines if the account menu should be shown
-
-**Signature:**
-
-```typescript
-get shouldShowAccountMenu(): boolean;
-```
-
-## Remarks
-
-It will be shown if the attribute is explicitly set to true or the logout button position is set to 'account-menu'
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [showAccountMenu](./foundation-header.navigation.showaccountmenu.md)
-
-## Navigation.showAccountMenu property
-
-Boolean attribute which controls whether to show the account menu on the navigation bar Control via `show-account-menu`
-
-**Signature:**
-
-```typescript
-showAccountMenu: boolean;
-```
-
-## Remarks
-
-If this attribute is not set then the account menu is not shown
-

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

@@ -1,13 +0,0 @@
-<!-- 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; [showAiIndicator](./foundation-header.navigation.showaiindicator.md)
-
-## Navigation.showAiIndicator property
-
-Boolean attribute which controls whether to show the AI indicator on the navigation bar Control via `show-ai-indicator`
-
-**Signature:**
-
-```typescript
-showAiIndicator: boolean;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [showConnectionIndicator](./foundation-header.navigation.showconnectionindicator.md)
-
-## Navigation.showConnectionIndicator property
-
-Boolean attribute which controls whether to show the connection indicator on the navigation bar Control via `show-connection-indicator`
-
-**Signature:**
-
-```typescript
-showConnectionIndicator: boolean;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [showControlPanel](./foundation-header.navigation.showcontrolpanel.md)
-
-## Navigation.showControlPanel property
-
-Boolean attribute which controls whether to show the control panel toggle on the navigation bar Control via `show-control-panel`
-
-**Signature:**
-
-```typescript
-showControlPanel: boolean;
-```

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

@@ -1,13 +0,0 @@
-<!-- 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; [showEnvironmentIndicator](./foundation-header.navigation.showenvironmentindicator.md)
-
-## Navigation.showEnvironmentIndicator property
-
-Boolean attribute which controls whether to show the environment indicator on the navigation bar Control via `show-environment-indicator`
-
-**Signature:**
-
-```typescript
-showEnvironmentIndicator: boolean;
-```

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

@@ -1,18 +0,0 @@
-<!-- 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; [showLanguageSelector](./foundation-header.navigation.showlanguageselector.md)
-
-## Navigation.showLanguageSelector property
-
-Boolean attribute which controls whether to show the language selector on the navigation bar Control via `show-language-selector`
-
-**Signature:**
-
-```typescript
-showLanguageSelector: boolean;
-```
-
-## Remarks
-
-Requires `i18nextOptions` to be set
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [showLuminanceToggleButton](./foundation-header.navigation.showluminancetogglebutton.md)
-
-## Navigation.showLuminanceToggleButton property
-
-Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar Control via`show-luminance-toggle-button`
-
-**Signature:**
-
-```typescript
-showLuminanceToggleButton: boolean;
-```
-
-## Remarks
-
-If the user clicks the icon when shown then this class will emit the 'luminance-icon-clicked' event
-

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

@@ -1,18 +0,0 @@
-<!-- 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; [showMiscToggleButton](./foundation-header.navigation.showmisctogglebutton.md)
-
-## Navigation.showMiscToggleButton property
-
-Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar Control via `show-luminance-toggle-button`
-
-**Signature:**
-
-```typescript
-showMiscToggleButton: boolean;
-```
-
-## Remarks
-
-If the user clicks the icon when shown then this class will emit the 'misc-icon-clicked' event
-

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

@@ -1,23 +0,0 @@
-<!-- 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; [showNotificationsButton](./foundation-header.navigation.shownotificationsbutton.md)
-
-## 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:**
-
-```typescript
-showNotificationsButton: boolean;
-```
-
-## Remarks
-
-If the user clicks the icon when shown then this class will emit the 'notification-icon-clicked' event
-

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

@@ -1,56 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-text
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-## Remarks
-
-Returns localised version of the text if available.
-

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

@@ -1,11 +0,0 @@
-<!-- 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; [user](./foundation-header.navigation.user.md)
-
-## Navigation.user property
-
-**Signature:**
-
-```typescript
-user: User;
-```

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

@@ -1,18 +0,0 @@
-<!-- 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; [userName](./foundation-header.navigation.username.md)
-
-## Navigation.userName property
-
-Username of the logged in user Control via `user-name` attribute
-
-**Signature:**
-
-```typescript
-userName: string;
-```
-
-## Remarks
-
-If not set via attribute, it will be initialized from the User service. Once set, the value will not be automatically updated by the User service.
-

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

@@ -1,13 +0,0 @@
-<!-- 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.navtemplate.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [navTemplate](./foundation-header.navtemplate.md)
-
-## navTemplate variable
-
-Template for Navigation class
-
-**Signature:**
-
-```typescript
-navTemplate: ViewTemplate<Navigation, any>
-```
-
-## Remarks
-
-Contains the template for both the sidenav and the navigation bar
-

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

@@ -1,69 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [RapidHeader](./foundation-header.rapidheader.md)
-
-## RapidHeader class
-
-RapidHeader is a rapid version of the header micro-frontend.
-
-**Signature:**
-
-```typescript
-export declare class RapidHeader extends Navigation 
-```
-**Extends:** [Navigation](./foundation-header.navigation.md)
-
-## Remarks
-
-A rapid version that pre-registers rapid components and uses the rapid design system so that it can run standalone. Generally this is used for development purposes, but can be deployed as a standalone application if required or be used by a host application that is already using rapid. RapidHeader and its components won't bloat the core bundle as these are only loaded on-demand when in use.
-
-## Example 1
-
-
-```ts
-import { RapidHeader } from '@genesislcap/foundation-header';
-...
-RapidHeader
-```
-
-## Example 2
-
-Load the micro frontend on-demand
-
-```ts
-  const { RapidHeader } = await import('@genesislcap/foundation-header');
-},
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[selectTemplate()](./foundation-header.rapidheader.selecttemplate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-header.rapidheader.selecttemplate.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [RapidHeader](./foundation-header.rapidheader.md) &gt; [selectTemplate](./foundation-header.rapidheader.selecttemplate.md)
-
-## RapidHeader.selectTemplate() method
-
-**Signature:**
-
-```typescript
-selectTemplate(): ViewTemplate<Navigation>;
-```
-**Returns:**
-
-ViewTemplate&lt;[Navigation](./foundation-header.navigation.md)<!-- -->&gt;
-

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

@@ -1,13 +0,0 @@
-<!-- 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

@@ -1,13 +0,0 @@
-<!-- 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';
-```

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/foundation-header](./foundation-header.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-