@genesislcap/foundation-header 14.408.0 → 14.409.0-FUI-2495.2

package/docs/api/foundation-header.md

@@ -1,246 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md)
-
-## foundation-header package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[FoundationHeader](./foundation-header.foundationheader.md)
-
-
-</td><td>
-
-FoundationHeader.
-
-
-</td></tr>
-<tr><td>
-
-[Navigation](./foundation-header.navigation.md)
-
-
-</td><td>
-
-Navigation micro-frontend includes navigation bar and flyout menu
-
-
-</td></tr>
-<tr><td>
-
-[RapidHeader](./foundation-header.rapidheader.md)
-
-
-</td><td>
-
-RapidHeader is a rapid version of the header micro-frontend.
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[configure(config)](./foundation-header.configure.md)
-
-
-</td><td>
-
-A function that allows configuring the header micro-frontend with name and templateOptions.
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[HeaderConfig](./foundation-header.headerconfig.md)
-
-
-</td><td>
-
-HeaderConfig DI interface.
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[defaultHeaderConfig](./foundation-header.defaultheaderconfig.md)
-
-
-</td><td>
-
-Default HeaderConfig DI implementation.
-
-
-</td></tr>
-<tr><td>
-
-[MainStyles](./foundation-header.mainstyles.md)
-
-
-</td><td>
-
-Base styles for the foundation-header
-
-
-</td></tr>
-<tr><td>
-
-[navTemplate](./foundation-header.navtemplate.md)
-
-
-</td><td>
-
-Template for Navigation class
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ElementTargetId](./foundation-header.elementtargetid.md)
-
-
-</td><td>
-
-Package element integration targets.
-
-
-</td></tr>
-<tr><td>
-
-[HeaderTargetId](./foundation-header.headertargetid.md)
-
-
-</td><td>
-
-Header integration targets.
-
-
-</td></tr>
-<tr><td>
-
-[LanguageOptions](./foundation-header.languageoptions.md)
-
-
-</td><td>
-
-Options for the language selector
-
-
-</td></tr>
-<tr><td>
-
-[NavEventDetailMap](./foundation-header.naveventdetailmap.md)
-
-
-</td><td>
-
-Events dispatched by the navigation control buttons
-
-
-</td></tr>
-<tr><td>
-
-[NavTargetId](./foundation-header.navtargetid.md)
-
-
-</td><td>
-
-Nav integration targets.
-
-
-</td></tr>
-<tr><td>
-
-[SideNavTargetId](./foundation-header.sidenavtargetid.md)
-
-
-</td><td>
-
-Side nav integration targets.
-
-
-</td></tr>
-<tr><td>
-
-[StyleTargetId](./foundation-header.styletargetid.md)
-
-
-</td><td>
-
-Package style integration targets.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-header.naveventdetailmap.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; [NavEventDetailMap](./foundation-header.naveventdetailmap.md)
-
-## NavEventDetailMap type
-
-Events dispatched by the navigation control buttons
-
-**Signature:**
-
-```typescript
-export type NavEventDetailMap = {
-    'luminance-icon-clicked': void;
-    'logout-clicked': void;
-    'misc-icon-clicked': void;
-    'notification-icon-clicked': void;
-    'language-changed': void;
-    'nav-button-clicked': {
-        item: FoundationRouteNavItem;
-        context: any;
-    };
-};
-```

package/docs/api/foundation-header.navigation.authrouting.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; [authRouting](./foundation-header.navigation.authrouting.md)
-
-## Navigation.authRouting property
-
-**Signature:**
-
-```typescript
-authRouting: AuthRouting;
-```

package/docs/api/foundation-header.navigation.changelanguage.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; [changeLanguage](./foundation-header.navigation.changelanguage.md)
-
-## Navigation.changeLanguage() method
-
-Changes the language of the application
-
-**Signature:**
-
-```typescript
-changeLanguage(e: CustomEvent): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-e
-
-
-</td><td>
-
-CustomEvent
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-Activated when the user selects a language from the language selector that uses the I18next service.
-

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

@@ -1,17 +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; [connectedCallback](./foundation-header.navigation.connectedcallback.md)
-
-## Navigation.connectedCallback() method
-
-Called when the component is connected to the DOM
-
-**Signature:**
-
-```typescript
-connectedCallback(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-header.navigation.container.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; [container](./foundation-header.navigation.container.md)
-
-## Navigation.container property
-
-**Signature:**
-
-```typescript
-container: Container;
-```

package/docs/api/foundation-header.navigation.controlpanel.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; [controlPanel](./foundation-header.navigation.controlpanel.md)
-
-## Navigation.controlPanel property
-
-**Signature:**
-
-```typescript
-controlPanel: ControlPanel;
-```

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

@@ -1,17 +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; [disconnectedCallback](./foundation-header.navigation.disconnectedcallback.md)
-
-## Navigation.disconnectedCallback() method
-
-Called when the component is disconnected from the DOM
-
-**Signature:**
-
-```typescript
-disconnectedCallback(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-header.navigation.enableinactivitymonitoring.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; [enableInactivityMonitoring](./foundation-header.navigation.enableinactivitymonitoring.md)
-
-## Navigation.enableInactivityMonitoring property
-
-Boolean attribute which controls whether to enable inactivity monitoring Control via `enable-inactivity-monitoring`
-
-**Signature:**
-
-```typescript
-enableInactivityMonitoring: boolean;
-```
-
-## Remarks
-
-Default is true
-

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

@@ -1,54 +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; [handleNavButtonClick](./foundation-header.navigation.handlenavbuttonclick.md)
-
-## Navigation.handleNavButtonClick() method
-
-Handles the click event for a navigation button
-
-**Signature:**
-
-```typescript
-handleNavButtonClick(routeNavItem: FoundationRouteNavItem): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-routeNavItem
-
-
-</td><td>
-
-FoundationRouteNavItem
-
-
-</td><td>
-
-The navigation item that was clicked
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-header.navigation.hasactivechild.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; [hasActiveChild](./foundation-header.navigation.hasactivechild.md)
-
-## Navigation.hasActiveChild() method
-
-Check if any child nav item matches the current route
-
-**Signature:**
-
-```typescript
-hasActiveChild(navItem: FoundationRouteNavItem): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-navItem
-
-
-</td><td>
-
-FoundationRouteNavItem
-
-
-</td><td>
-
-The navigation item to check
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-true if any child matches the current path
-

package/docs/api/foundation-header.navigation.headerconfig.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; [headerConfig](./foundation-header.navigation.headerconfig.md)
-
-## Navigation.headerConfig property
-
-**Signature:**
-
-```typescript
-headerConfig: HeaderConfig;
-```

package/docs/api/foundation-header.navigation.hidesidebar.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; [hideSideBar](./foundation-header.navigation.hidesidebar.md)
-
-## Navigation.hideSideBar property
-
-Boolean attribute which controls whether to include the sideNav component Control via`hide-side-bar`
-
-**Signature:**
-
-```typescript
-hideSideBar: boolean;
-```

package/docs/api/foundation-header.navigation.i18next.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; [i18next](./foundation-header.navigation.i18next.md)
-
-## Navigation.i18next property
-
-**Signature:**
-
-```typescript
-i18next: I18next;
-```

package/docs/api/foundation-header.navigation.inactivitytimeoutminutes.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; [inactivityTimeoutMinutes](./foundation-header.navigation.inactivitytimeoutminutes.md)
-
-## Navigation.inactivityTimeoutMinutes property
-
-Number attribute which sets the inactivity timeout in minutes Control via `inactivity-timeout-minutes`
-
-**Signature:**
-
-```typescript
-inactivityTimeoutMinutes: number;
-```
-
-## Remarks
-
-Default is 30 minutes
-

package/docs/api/foundation-header.navigation.inactivitywarningminutes.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; [inactivityWarningMinutes](./foundation-header.navigation.inactivitywarningminutes.md)
-
-## Navigation.inactivityWarningMinutes property
-
-Number attribute which sets the inactivity warning time in minutes before timeout Control via `inactivity-warning-minutes`
-
-**Signature:**
-
-```typescript
-inactivityWarningMinutes: number;
-```
-
-## Remarks
-
-Default is 5 minutes
-

package/docs/api/foundation-header.navigation.islayoutitemactive.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; [isLayoutItemActive](./foundation-header.navigation.islayoutitemactive.md)
-
-## Navigation.isLayoutItemActive() method
-
-Check if a layout item is currently active in the layout
-
-**Signature:**
-
-```typescript
-isLayoutItemActive(item: FoundationRouteNavItem): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-item
-
-
-</td><td>
-
-FoundationRouteNavItem
-
-
-</td><td>
-
-The navigation item to check
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-true if the item is active in the layout
-

package/docs/api/foundation-header.navigation.languageoptions.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; [languageOptions](./foundation-header.navigation.languageoptions.md)
-
-## Navigation.languageOptions property
-
-Object which defines the language options to be displayed in the language selector
-
-**Signature:**
-
-```typescript
-languageOptions: LanguageOptions;
-```