@genesislcap/foundation-header 14.408.0 → 14.409.0-FUI-2495.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -633
- package/dist/custom-elements.json +280 -232
- package/dist/dts/main/main.d.ts +38 -5
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/esm/main/main.js +20 -7
- package/dist/foundation-header.api.json +94 -6
- package/dist/foundation-header.d.ts +39 -5
- package/package.json +23 -23
- package/docs/api/foundation-header.configure.md +0 -75
- package/docs/api/foundation-header.defaultheaderconfig.md +0 -13
- package/docs/api/foundation-header.elementtargetid.md +0 -15
- package/docs/api/foundation-header.foundationheader.loadremotes.md +0 -15
- package/docs/api/foundation-header.foundationheader.md +0 -53
- package/docs/api/foundation-header.headerconfig.md +0 -59
- package/docs/api/foundation-header.headerconfig.templateoptions.md +0 -18
- package/docs/api/foundation-header.headertargetid.md +0 -13
- package/docs/api/foundation-header.languageoptions.md +0 -16
- package/docs/api/foundation-header.mainstyles.md +0 -13
- package/docs/api/foundation-header.md +0 -246
- package/docs/api/foundation-header.naveventdetailmap.md +0 -23
- package/docs/api/foundation-header.navigation.authrouting.md +0 -11
- package/docs/api/foundation-header.navigation.changelanguage.md +0 -56
- package/docs/api/foundation-header.navigation.connectedcallback.md +0 -17
- package/docs/api/foundation-header.navigation.container.md +0 -11
- package/docs/api/foundation-header.navigation.controlpanel.md +0 -11
- package/docs/api/foundation-header.navigation.disconnectedcallback.md +0 -17
- package/docs/api/foundation-header.navigation.enableinactivitymonitoring.md +0 -18
- package/docs/api/foundation-header.navigation.handlenavbuttonclick.md +0 -54
- package/docs/api/foundation-header.navigation.hasactivechild.md +0 -56
- package/docs/api/foundation-header.navigation.headerconfig.md +0 -11
- package/docs/api/foundation-header.navigation.hidesidebar.md +0 -13
- package/docs/api/foundation-header.navigation.i18next.md +0 -11
- package/docs/api/foundation-header.navigation.inactivitytimeoutminutes.md +0 -18
- package/docs/api/foundation-header.navigation.inactivitywarningminutes.md +0 -18
- package/docs/api/foundation-header.navigation.islayoutitemactive.md +0 -56
- package/docs/api/foundation-header.navigation.languageoptions.md +0 -13
- package/docs/api/foundation-header.navigation.layoutitemcheck.md +0 -30
- package/docs/api/foundation-header.navigation.loginrouting.md +0 -11
- package/docs/api/foundation-header.navigation.logoalttext.md +0 -18
- package/docs/api/foundation-header.navigation.logosrc.md +0 -18
- package/docs/api/foundation-header.navigation.logout.md +0 -17
- package/docs/api/foundation-header.navigation.logoutbuttonposition.md +0 -18
- package/docs/api/foundation-header.navigation.luminancetoggle.md +0 -11
- package/docs/api/foundation-header.navigation.md +0 -793
- package/docs/api/foundation-header.navigation.navigateto.md +0 -58
- package/docs/api/foundation-header.navigation.pathname.md +0 -13
- package/docs/api/foundation-header.navigation.routebuttons.md +0 -24
- package/docs/api/foundation-header.navigation.routenavitems.md +0 -13
- package/docs/api/foundation-header.navigation.selecttemplate.md +0 -19
- package/docs/api/foundation-header.navigation.setluminance.md +0 -15
- package/docs/api/foundation-header.navigation.shouldshowaccountmenu.md +0 -18
- package/docs/api/foundation-header.navigation.showaccountmenu.md +0 -18
- package/docs/api/foundation-header.navigation.showaiindicator.md +0 -13
- package/docs/api/foundation-header.navigation.showconnectionindicator.md +0 -13
- package/docs/api/foundation-header.navigation.showcontrolpanel.md +0 -13
- package/docs/api/foundation-header.navigation.showenvironmentindicator.md +0 -13
- package/docs/api/foundation-header.navigation.showlanguageselector.md +0 -18
- package/docs/api/foundation-header.navigation.showluminancetogglebutton.md +0 -18
- package/docs/api/foundation-header.navigation.showmisctogglebutton.md +0 -18
- package/docs/api/foundation-header.navigation.shownotificationsbutton.md +0 -23
- package/docs/api/foundation-header.navigation.tolocalisedtext.md +0 -56
- package/docs/api/foundation-header.navigation.user.md +0 -11
- package/docs/api/foundation-header.navigation.username.md +0 -18
- package/docs/api/foundation-header.navtargetid.md +0 -13
- package/docs/api/foundation-header.navtemplate.md +0 -18
- package/docs/api/foundation-header.rapidheader.md +0 -69
- package/docs/api/foundation-header.rapidheader.selecttemplate.md +0 -15
- package/docs/api/foundation-header.sidenavtargetid.md +0 -13
- package/docs/api/foundation-header.styletargetid.md +0 -13
- package/docs/api/index.md +0 -30
- package/docs/api-report.md.api.md +0 -260
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [layoutItemCheck](./foundation-header.navigation.layoutitemcheck.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.layoutItemCheck property
|
|
6
|
-
|
|
7
|
-
> 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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
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.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
layoutItemCheck?: (registration: string) => boolean;
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Remarks
|
|
19
|
-
|
|
20
|
-
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).
|
|
21
|
-
|
|
22
|
-
## Example
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
```ts
|
|
26
|
-
<foundation-header
|
|
27
|
-
:layoutItemCheck=${(registration) => currentLayoutItems.includes(registration)}
|
|
28
|
-
/>
|
|
29
|
-
```
|
|
30
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [loginRouting](./foundation-header.navigation.loginrouting.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.loginRouting property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
loginRouting: LoginRouting;
|
|
11
|
-
```
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [logoAltText](./foundation-header.navigation.logoalttext.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.logoAltText property
|
|
6
|
-
|
|
7
|
-
Optional attribute which controls the alt text of the logo Control via `logo-alt-text`
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
logoAltText: string;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Remarks
|
|
16
|
-
|
|
17
|
-
If this attribute is not set then the alt text is set to 'Corporate Logo'
|
|
18
|
-
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [logoSrc](./foundation-header.navigation.logosrc.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.logoSrc property
|
|
6
|
-
|
|
7
|
-
Optional attribute which controls the icon to show on the navigation bar and flyout Control via `logo-src`
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
logoSrc: any;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Remarks
|
|
16
|
-
|
|
17
|
-
If this attribute is not set then the Genesis logo is shown instead
|
|
18
|
-
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [logout](./foundation-header.navigation.logout.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.logout() method
|
|
6
|
-
|
|
7
|
-
Logs the user out of their session
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
logout(): Promise<void>;
|
|
13
|
-
```
|
|
14
|
-
**Returns:**
|
|
15
|
-
|
|
16
|
-
Promise<void>
|
|
17
|
-
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [logoutButtonPosition](./foundation-header.navigation.logoutbuttonposition.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.logoutButtonPosition property
|
|
6
|
-
|
|
7
|
-
String attribute which controls the position of the logout button in the header Control via `logout-button-position`
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
logoutButtonPosition: 'side-nav' | 'account-menu' | 'none';
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Remarks
|
|
16
|
-
|
|
17
|
-
If this attribute is not set then the logout button is shown in the side nav
|
|
18
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [luminanceToggle](./foundation-header.navigation.luminancetoggle.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.luminanceToggle property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
luminanceToggle: boolean;
|
|
11
|
-
```
|