@genesislcap/foundation-header 14.408.0 → 14.409.0

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;
-```

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

@@ -1,30 +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; [layoutItemCheck](./foundation-header.navigation.layoutitemcheck.md)
-
-## Navigation.layoutItemCheck property
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Callback function to check if a layout item is currently active in the layout. Used with nav items that have `isLayoutItem: true` and `layoutRegistration` set.
-
-**Signature:**
-
-```typescript
-layoutItemCheck?: (registration: string) => boolean;
-```
-
-## Remarks
-
-When provided, this callback is called for each layout nav item to determine if it should be styled as "active" (added to layout) or "inactive" (not in layout).
-
-## Example
-
-
-```ts
-<foundation-header
-  :layoutItemCheck=${(registration) => currentLayoutItems.includes(registration)}
-/>
-```
-

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

package/docs/api/foundation-header.navigation.logoalttext.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; [logoAltText](./foundation-header.navigation.logoalttext.md)
-
-## Navigation.logoAltText property
-
-Optional attribute which controls the alt text of the logo Control via `logo-alt-text`
-
-**Signature:**
-
-```typescript
-logoAltText: string;
-```
-
-## Remarks
-
-If this attribute is not set then the alt text is set to 'Corporate Logo'
-

package/docs/api/foundation-header.navigation.logosrc.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; [logoSrc](./foundation-header.navigation.logosrc.md)
-
-## Navigation.logoSrc property
-
-Optional attribute which controls the icon to show on the navigation bar and flyout Control via `logo-src`
-
-**Signature:**
-
-```typescript
-logoSrc: any;
-```
-
-## Remarks
-
-If this attribute is not set then the Genesis logo is shown instead
-

package/docs/api/foundation-header.navigation.logout.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; [logout](./foundation-header.navigation.logout.md)
-
-## Navigation.logout() method
-
-Logs the user out of their session
-
-**Signature:**
-
-```typescript
-logout(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-header.navigation.logoutbuttonposition.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; [logoutButtonPosition](./foundation-header.navigation.logoutbuttonposition.md)
-
-## Navigation.logoutButtonPosition property
-
-String attribute which controls the position of the logout button in the header Control via `logout-button-position`
-
-**Signature:**
-
-```typescript
-logoutButtonPosition: 'side-nav' | 'account-menu' | 'none';
-```
-
-## Remarks
-
-If this attribute is not set then the logout button is shown in the side nav
-

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