@genesislcap/foundation-header 14.193.1 → 14.193.3
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/dist/custom-elements.json +86 -22
- package/dist/dts/main/main.d.ts +57 -12
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/dts/main/main.template.d.ts.map +1 -1
- package/dist/esm/main/main.js +17 -0
- package/dist/esm/main/main.template.js +36 -11
- package/dist/foundation-header.api.json +31 -1
- package/dist/foundation-header.d.ts +60 -15
- package/docs/api/foundation-header.navigation.logoalttext.md +11 -0
- package/docs/api/foundation-header.navigation.md +1 -0
- package/docs/api-report.md +4 -0
- package/package.json +17 -17
|
@@ -31,6 +31,27 @@
|
|
|
31
31
|
}
|
|
32
32
|
]
|
|
33
33
|
},
|
|
34
|
+
{
|
|
35
|
+
"kind": "javascript-module",
|
|
36
|
+
"path": "src/components/zero-components.ts",
|
|
37
|
+
"declarations": [
|
|
38
|
+
{
|
|
39
|
+
"kind": "function",
|
|
40
|
+
"name": "registerCommonZeroComponents",
|
|
41
|
+
"privacy": "public"
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"exports": [
|
|
45
|
+
{
|
|
46
|
+
"kind": "js",
|
|
47
|
+
"name": "registerCommonZeroComponents",
|
|
48
|
+
"declaration": {
|
|
49
|
+
"name": "registerCommonZeroComponents",
|
|
50
|
+
"module": "src/components/zero-components.ts"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
]
|
|
54
|
+
},
|
|
34
55
|
{
|
|
35
56
|
"kind": "javascript-module",
|
|
36
57
|
"path": "src/config/config.ts",
|
|
@@ -151,27 +172,6 @@
|
|
|
151
172
|
}
|
|
152
173
|
]
|
|
153
174
|
},
|
|
154
|
-
{
|
|
155
|
-
"kind": "javascript-module",
|
|
156
|
-
"path": "src/components/zero-components.ts",
|
|
157
|
-
"declarations": [
|
|
158
|
-
{
|
|
159
|
-
"kind": "function",
|
|
160
|
-
"name": "registerCommonZeroComponents",
|
|
161
|
-
"privacy": "public"
|
|
162
|
-
}
|
|
163
|
-
],
|
|
164
|
-
"exports": [
|
|
165
|
-
{
|
|
166
|
-
"kind": "js",
|
|
167
|
-
"name": "registerCommonZeroComponents",
|
|
168
|
-
"declaration": {
|
|
169
|
-
"name": "registerCommonZeroComponents",
|
|
170
|
-
"module": "src/components/zero-components.ts"
|
|
171
|
-
}
|
|
172
|
-
}
|
|
173
|
-
]
|
|
174
|
-
},
|
|
175
175
|
{
|
|
176
176
|
"kind": "javascript-module",
|
|
177
177
|
"path": "src/main/index.ts",
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
{
|
|
238
238
|
"kind": "variable",
|
|
239
239
|
"name": "NavTemplate",
|
|
240
|
-
"default": "html<Navigation>`\n ${when((x) => !x.hideSideBar, sideNavTemplate)}\n <div class=\"nav-listbox\" data-test-id=\"nav-bar\">\n ${app.registerElementsTarget<HeaderTargetId>('header-start')}\n <div class=\"nav-leftside\">\n ${app.registerElementsTarget<NavTargetId>('nav-start')}\n ${when(\n (x) => !x.hideSideBar,\n html<Navigation>`\n
|
|
240
|
+
"default": "html<Navigation>`\n ${when((x) => !x.hideSideBar, sideNavTemplate)}\n <div class=\"nav-listbox\" data-test-id=\"nav-bar\" role=\"navigation\" aria-label=\"Main menu\">\n ${app.registerElementsTarget<HeaderTargetId>('header-start')}\n <div class=\"nav-leftside\">\n ${app.registerElementsTarget<NavTargetId>('nav-start')}\n ${when(\n (x) => !x.hideSideBar,\n html<Navigation>`\n <${buttonTag}\n class=\"bars-container\"\n @click=${(x) => x.toggleNavVisibility()}\n data-test-id=\"hamburger-menu\"\n aria-label=\"Toggle side menu\"\n aria-controls=\"side-nav\"\n aria-expanded=${(x) => x.sideNavOpen}\n appearance=\"stealth\"\n @focusin=${(x) => x.closeNav()}\n >\n <${iconTag} name=\"bars\" part=\"nav-visibility-icon\" class=\"nav-visibility-icon\"></${iconTag}>\n </${buttonTag}>\n `,\n )}\n <div class=\"logo-container\" data-test-id=\"nav-bar-logo\">\n <img\n src=${(x) => x.logoSrc}\n class=\"logo\"\n part=\"logo\"\n data-test-id=\"logo\"\n alt=\"${(x) => x.logoAltText}\"\n />\n </div>\n <slot name=\"routes\" data-test-id=\"route-buttons\">\n ${(x) => (x.routeNavItems ? routeNavItemsTemplate : defaultRouteNavItemsTemplate)}\n </slot>\n ${app.registerElementsTarget<NavTargetId>('nav')}\n </div>\n <div class=\"nav-rightside\">\n ${app.registerElementsTarget<NavTargetId>('nav-end')}\n ${when(\n (x) => x.showLuminanceToggleButton,\n html<Navigation>`\n <div\n class=\"icon-container\"\n data-test-id=\"luminance-toggle-button\"\n part=\"luminance-button\"\n aria-label=\"Luminance toggle\"\n >\n <${iconTag}\n @click=${(x) => x.luminanceIconEvent()}\n variant=\"regular\"\n name=\"moon\"\n part=\"luminance-icon\"\n ></${iconTag}>\n </div>\n `,\n )}\n ${when(\n (x) => x.showMiscToggleButton,\n html<Navigation>`\n <div class=\"icon-container\" data-test-id=\"misc-toggle-button\" part=\"misc-button\" aria-label=\"Misc icon\">\n <${iconTag} @click=${(x) => x.miscIconEvent()} name=\"th\" part=\"misc-icon\"></${iconTag}>\n </div>\n `,\n )}\n ${when(\n (x) => x.showConnectionIndicator,\n html<Navigation>`\n <div class=\"connection-indicator-container\" data-test-id=\"connection-indicator\">\n <${connectionIndicatorTag} show-label=\"false\"></${connectionIndicatorTag}>\n </div>\n `,\n )}\n ${when(\n (x) => x.showLanguageSelector && x.languageOptions,\n html<Navigation>`\n <${selectTag}\n class=\"language-selector\"\n position=\"below\"\n data-test-id=\"language-selector\"\n part=\"language-selector\"\n @change=\"${(x, c) => x.changeLanguage(c.event as CustomEvent)}\"\n aria-label=\"Language selector\"\n >\n ${repeat(\n (x) => x.languageOptions.availableLanguages,\n html`\n <${optionTag}\n value=\"${(x) => x}\"\n ?selected=\"${(x, c) => x === c.parent.languageOptions.selectedLanguage}\"\n >\n ${(x) => x.toUpperCase()}\n </${optionTag}>\n `,\n )}\n </${selectTag}>\n `,\n )}\n\n <${buttonTag} appearance=\"neutral-grey\" data-test-id=\"user-button\" class=\"nav-button\" aria-label=\"User button\">\n <${iconTag} name=\"user-circle\"></${iconTag}>\n ${(x) => x.userName}\n </${buttonTag}>\n </div>\n ${app.registerElementsTarget<HeaderTargetId>(['header', 'header-end'])}\n </div>\n`",
|
|
241
241
|
"description": "Template for Navigation class",
|
|
242
242
|
"return": {
|
|
243
243
|
"type": {
|
|
@@ -329,6 +329,14 @@
|
|
|
329
329
|
"default": "logo",
|
|
330
330
|
"description": "Optional attribute which controls the icon to show on the navigation bar and flyout\nControl via `logo-src`"
|
|
331
331
|
},
|
|
332
|
+
{
|
|
333
|
+
"kind": "field",
|
|
334
|
+
"name": "logoAltText",
|
|
335
|
+
"type": {
|
|
336
|
+
"text": "string"
|
|
337
|
+
},
|
|
338
|
+
"default": "'Corporate Logo'"
|
|
339
|
+
},
|
|
332
340
|
{
|
|
333
341
|
"kind": "field",
|
|
334
342
|
"name": "showLuminanceToggleButton",
|
|
@@ -493,6 +501,14 @@
|
|
|
493
501
|
},
|
|
494
502
|
"fieldName": "logoSrc"
|
|
495
503
|
},
|
|
504
|
+
{
|
|
505
|
+
"name": "logo-alt-text",
|
|
506
|
+
"type": {
|
|
507
|
+
"text": "string"
|
|
508
|
+
},
|
|
509
|
+
"default": "'Corporate Logo'",
|
|
510
|
+
"fieldName": "logoAltText"
|
|
511
|
+
},
|
|
496
512
|
{
|
|
497
513
|
"name": "show-luminance-toggle-button",
|
|
498
514
|
"type": {
|
|
@@ -661,6 +677,18 @@
|
|
|
661
677
|
"module": "src/main/main.ts"
|
|
662
678
|
}
|
|
663
679
|
},
|
|
680
|
+
{
|
|
681
|
+
"kind": "field",
|
|
682
|
+
"name": "logoAltText",
|
|
683
|
+
"type": {
|
|
684
|
+
"text": "string"
|
|
685
|
+
},
|
|
686
|
+
"default": "'Corporate Logo'",
|
|
687
|
+
"inheritedFrom": {
|
|
688
|
+
"name": "Navigation",
|
|
689
|
+
"module": "src/main/main.ts"
|
|
690
|
+
}
|
|
691
|
+
},
|
|
664
692
|
{
|
|
665
693
|
"kind": "field",
|
|
666
694
|
"name": "showLuminanceToggleButton",
|
|
@@ -871,6 +899,18 @@
|
|
|
871
899
|
"module": "src/main/main.ts"
|
|
872
900
|
}
|
|
873
901
|
},
|
|
902
|
+
{
|
|
903
|
+
"name": "logo-alt-text",
|
|
904
|
+
"type": {
|
|
905
|
+
"text": "string"
|
|
906
|
+
},
|
|
907
|
+
"default": "'Corporate Logo'",
|
|
908
|
+
"fieldName": "logoAltText",
|
|
909
|
+
"inheritedFrom": {
|
|
910
|
+
"name": "Navigation",
|
|
911
|
+
"module": "src/main/main.ts"
|
|
912
|
+
}
|
|
913
|
+
},
|
|
874
914
|
{
|
|
875
915
|
"name": "show-luminance-toggle-button",
|
|
876
916
|
"type": {
|
|
@@ -1009,6 +1049,18 @@
|
|
|
1009
1049
|
"module": "src/main/main.ts"
|
|
1010
1050
|
}
|
|
1011
1051
|
},
|
|
1052
|
+
{
|
|
1053
|
+
"name": "logo-alt-text",
|
|
1054
|
+
"type": {
|
|
1055
|
+
"text": "string"
|
|
1056
|
+
},
|
|
1057
|
+
"default": "'Corporate Logo'",
|
|
1058
|
+
"fieldName": "logoAltText",
|
|
1059
|
+
"inheritedFrom": {
|
|
1060
|
+
"name": "Navigation",
|
|
1061
|
+
"module": "src/main/main.ts"
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1012
1064
|
{
|
|
1013
1065
|
"name": "show-luminance-toggle-button",
|
|
1014
1066
|
"type": {
|
|
@@ -1180,6 +1232,18 @@
|
|
|
1180
1232
|
"module": "src/main/main.ts"
|
|
1181
1233
|
}
|
|
1182
1234
|
},
|
|
1235
|
+
{
|
|
1236
|
+
"kind": "field",
|
|
1237
|
+
"name": "logoAltText",
|
|
1238
|
+
"type": {
|
|
1239
|
+
"text": "string"
|
|
1240
|
+
},
|
|
1241
|
+
"default": "'Corporate Logo'",
|
|
1242
|
+
"inheritedFrom": {
|
|
1243
|
+
"name": "Navigation",
|
|
1244
|
+
"module": "src/main/main.ts"
|
|
1245
|
+
}
|
|
1246
|
+
},
|
|
1183
1247
|
{
|
|
1184
1248
|
"kind": "field",
|
|
1185
1249
|
"name": "showLuminanceToggleButton",
|
package/dist/dts/main/main.d.ts
CHANGED
|
@@ -65,7 +65,14 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
65
65
|
readonly scrollHeight: number;
|
|
66
66
|
scrollLeft: number;
|
|
67
67
|
scrollTop: number;
|
|
68
|
-
readonly scrollWidth: number;
|
|
68
|
+
readonly scrollWidth: number; /**
|
|
69
|
+
* Optional attribute which controls the icon to show on the navigation bar and flyout
|
|
70
|
+
* Control via `logo-src`
|
|
71
|
+
*
|
|
72
|
+
* @remarks
|
|
73
|
+
*
|
|
74
|
+
* If this attribute is not set then the Genesis logo is shown instead
|
|
75
|
+
*/
|
|
69
76
|
readonly shadowRoot: ShadowRoot;
|
|
70
77
|
slot: string;
|
|
71
78
|
readonly tagName: string;
|
|
@@ -87,9 +94,6 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
87
94
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
88
95
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
89
96
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
90
|
-
/**
|
|
91
|
-
* @internal
|
|
92
|
-
*/
|
|
93
97
|
hasAttribute(qualifiedName: string): boolean;
|
|
94
98
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
95
99
|
hasAttributes(): boolean;
|
|
@@ -134,7 +138,9 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
134
138
|
appendChild<T extends Node>(node: T): T;
|
|
135
139
|
cloneNode(deep?: boolean): Node;
|
|
136
140
|
compareDocumentPosition(other: Node): number;
|
|
137
|
-
contains(other: Node): boolean;
|
|
141
|
+
contains(other: Node): boolean; /**
|
|
142
|
+
* If present the defined {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} will be rendered in the header 'routes' slot
|
|
143
|
+
*/
|
|
138
144
|
getRootNode(options?: GetRootNodeOptions): Node;
|
|
139
145
|
hasChildNodes(): boolean;
|
|
140
146
|
insertBefore<T_1 extends Node>(node: T_1, child: Node): T_1;
|
|
@@ -191,6 +197,16 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
191
197
|
ariaPosInSet: string;
|
|
192
198
|
ariaPressed: string;
|
|
193
199
|
ariaReadOnly: string;
|
|
200
|
+
/**
|
|
201
|
+
* Opens the flyout menu on the left hand side
|
|
202
|
+
*
|
|
203
|
+
* @remarks
|
|
204
|
+
*
|
|
205
|
+
* Activated when the user clicks on the menu button on the navigation
|
|
206
|
+
* bar left hand side
|
|
207
|
+
*
|
|
208
|
+
* @internal
|
|
209
|
+
*/
|
|
194
210
|
ariaRequired: string;
|
|
195
211
|
ariaRoleDescription: string;
|
|
196
212
|
ariaRowCount: string;
|
|
@@ -211,20 +227,21 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
211
227
|
before(...nodes: (string | Node)[]): void;
|
|
212
228
|
remove(): void;
|
|
213
229
|
replaceWith(...nodes: (string | Node)[]): void;
|
|
214
|
-
innerHTML: string;
|
|
215
|
-
|
|
230
|
+
innerHTML: string;
|
|
231
|
+
readonly nextElementSibling: Element;
|
|
232
|
+
readonly previousElementSibling: Element;
|
|
233
|
+
readonly childElementCount: number;
|
|
234
|
+
readonly children: HTMLCollection;
|
|
235
|
+
/**
|
|
236
|
+
* Emits the event corresponding to the miscellaneous icon being clicked
|
|
216
237
|
*
|
|
217
238
|
* @remarks
|
|
218
239
|
*
|
|
219
|
-
* Activated when the user clicks on the
|
|
240
|
+
* Activated when the user clicks on the menu icon on the navigation
|
|
220
241
|
* bar right hand side
|
|
221
242
|
*
|
|
222
243
|
* @internal
|
|
223
244
|
*/
|
|
224
|
-
readonly nextElementSibling: Element;
|
|
225
|
-
readonly previousElementSibling: Element;
|
|
226
|
-
readonly childElementCount: number;
|
|
227
|
-
readonly children: HTMLCollection;
|
|
228
245
|
readonly firstElementChild: Element;
|
|
229
246
|
readonly lastElementChild: Element;
|
|
230
247
|
append(...nodes: (string | Node)[]): void;
|
|
@@ -247,6 +264,22 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
247
264
|
readonly isContentEditable: boolean;
|
|
248
265
|
onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
249
266
|
onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
267
|
+
/**
|
|
268
|
+
* FoundationHeader.
|
|
269
|
+
*
|
|
270
|
+
* @remarks
|
|
271
|
+
* Base MF export used by host application `configure` calls. It does not set up a design system or components. Both are
|
|
272
|
+
* expected to be registered in the host application, which should provide the details of which to the MF via
|
|
273
|
+
* TemplateOptions.
|
|
274
|
+
*
|
|
275
|
+
* See the {@link configure} hook for more information on how to set up and use this micro frontend in your application.
|
|
276
|
+
*
|
|
277
|
+
* @privateRemarks
|
|
278
|
+
* We will override loadRemotes to remove zero. This setup is the inverse of FoundationAuth.
|
|
279
|
+
* We're doing this to avoid a breaking change, so consumers can continue to use Navigation which bundles zero.
|
|
280
|
+
*
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
250
283
|
onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
251
284
|
onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
252
285
|
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
@@ -360,6 +393,7 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
360
393
|
* - The contents of the flyout menu.
|
|
361
394
|
*
|
|
362
395
|
* @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.
|
|
396
|
+
* @param logo-alt-text -Descriptive logo text.
|
|
363
397
|
* @param show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
|
|
364
398
|
* @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
|
|
365
399
|
* @param notification-icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.
|
|
@@ -401,6 +435,7 @@ export declare class Navigation extends Navigation_base {
|
|
|
401
435
|
* If this attribute is not set then the Genesis logo is shown instead
|
|
402
436
|
*/
|
|
403
437
|
logoSrc: any;
|
|
438
|
+
logoAltText: string;
|
|
404
439
|
/**
|
|
405
440
|
* Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar
|
|
406
441
|
* Control via`show-luminance-toggle-button`
|
|
@@ -529,6 +564,16 @@ export declare class Navigation extends Navigation_base {
|
|
|
529
564
|
* @internal
|
|
530
565
|
*/
|
|
531
566
|
toggleNavVisibility(): void;
|
|
567
|
+
/**
|
|
568
|
+
* Explicitly closes the flyout menu on the left
|
|
569
|
+
*
|
|
570
|
+
* @privateRemarks
|
|
571
|
+
* When the user tabs though and out of the flyout, the hamburger menu item will be re-focused and when that occurs we
|
|
572
|
+
* can close the menu to return to normal flow.
|
|
573
|
+
*
|
|
574
|
+
* @internal
|
|
575
|
+
*/
|
|
576
|
+
closeNav(): void;
|
|
532
577
|
/**
|
|
533
578
|
* Emits the event corresponding to the luminance icon being clicked
|
|
534
579
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAEtF,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAuB,MAAM,4BAA4B,CAAC;AAI9F,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKhD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;IAClC,kBAAkB,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC
|
|
1
|
+
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAEtF,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAuB,MAAM,4BAA4B,CAAC;AAI9F,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKhD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;IAClC,kBAAkB,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAqEA;;;;;;;OAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCAgHH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8EH;;;;;;;;;OASG;;;;;;;;;;;;;;;;;;;;;;;;;;IAgCH;;;;;;;;;OASG;;;;;;;;;;;;;;;;;;;;;;;IAiDL;;;;;;;;;;;;;;;OAeG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAzXH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAChD,OAAO,EAAG,OAAO,CAAC;IACb,YAAY,EAAG,YAAY,CAAC;IAE9B,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAEf,WAAW,EAAE,MAAM,CAAoB;IAE7E;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;;;OASG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,8BAA8B;IAI9B;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;;;;;OAQG;IAEH,oBAAoB,EAAE,OAAO,CAAS;IAE1B,eAAe,EAAE,eAAe,CAG1C;IAEF;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;OAEG;IACH,mBAAmB;IAiBnB;;OAEG;IACS,aAAa,EAAE,sBAAsB,EAAE,CAAC;IAEpD;;;;;;;;OAQG;IACG,WAAW;IAMjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;OAKG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM;IAIlC;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;OAQG;IACH,QAAQ;IAIR;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;IAIrB;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,EAAE,WAAW;IAK7B;;;;;;;;OAQG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAKtC;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IACxC,WAAW;CAGlB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAKa,UAAW,SAAQ,UAAU;CAAG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.template.d.ts","sourceRoot":"","sources":["../../../src/main/main.template.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAW5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"main.template.d.ts","sourceRoot":"","sources":["../../../src/main/main.template.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAW5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AA6FzC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,+BA0GvB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,UAAU,CAIpD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,UAAU,CAEpD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,EAAE,YAAY,CAAC,UAAU,CAEjD,CAAC"}
|
package/dist/esm/main/main.js
CHANGED
|
@@ -22,6 +22,7 @@ import { DynamicTemplate as template, LoadingTemplate, MainTemplate } from './ma
|
|
|
22
22
|
* - The contents of the flyout menu.
|
|
23
23
|
*
|
|
24
24
|
* @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.
|
|
25
|
+
* @param logo-alt-text -Descriptive logo text.
|
|
25
26
|
* @param show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
|
|
26
27
|
* @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
|
|
27
28
|
* @param notification-icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.
|
|
@@ -57,6 +58,7 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
|
|
|
57
58
|
* If this attribute is not set then the Genesis logo is shown instead
|
|
58
59
|
*/
|
|
59
60
|
this.logoSrc = logo;
|
|
61
|
+
this.logoAltText = 'Corporate Logo';
|
|
60
62
|
/**
|
|
61
63
|
* Boolean attribute which controls whether to show the connection indicator on the navigation bar
|
|
62
64
|
* Control via `show-connection-indicator`
|
|
@@ -205,6 +207,18 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
|
|
|
205
207
|
toggleNavVisibility() {
|
|
206
208
|
this.sideNavOpen = !this.sideNavOpen;
|
|
207
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* Explicitly closes the flyout menu on the left
|
|
212
|
+
*
|
|
213
|
+
* @privateRemarks
|
|
214
|
+
* When the user tabs though and out of the flyout, the hamburger menu item will be re-focused and when that occurs we
|
|
215
|
+
* can close the menu to return to normal flow.
|
|
216
|
+
*
|
|
217
|
+
* @internal
|
|
218
|
+
*/
|
|
219
|
+
closeNav() {
|
|
220
|
+
this.sideNavOpen = false;
|
|
221
|
+
}
|
|
208
222
|
/**
|
|
209
223
|
* Emits the event corresponding to the luminance icon being clicked
|
|
210
224
|
*
|
|
@@ -296,6 +310,9 @@ __decorate([
|
|
|
296
310
|
__decorate([
|
|
297
311
|
attr({ attribute: 'logo-src' })
|
|
298
312
|
], Navigation.prototype, "logoSrc", void 0);
|
|
313
|
+
__decorate([
|
|
314
|
+
attr({ attribute: 'logo-alt-text' })
|
|
315
|
+
], Navigation.prototype, "logoAltText", void 0);
|
|
299
316
|
__decorate([
|
|
300
317
|
attr({ mode: 'boolean', attribute: 'show-luminance-toggle-button' })
|
|
301
318
|
], Navigation.prototype, "showLuminanceToggleButton", void 0);
|
|
@@ -7,7 +7,10 @@ const sideNavTemplate = html `
|
|
|
7
7
|
position="left"
|
|
8
8
|
?closed=${(x) => !x.sideNavOpen}
|
|
9
9
|
@closed=${(x) => x.toggleNavVisibility()}
|
|
10
|
+
id="side-nav"
|
|
10
11
|
data-test-id="side-nav"
|
|
12
|
+
role="navigation"
|
|
13
|
+
aria-label="Side navigation"
|
|
11
14
|
>
|
|
12
15
|
<img
|
|
13
16
|
slot="title"
|
|
@@ -15,34 +18,42 @@ const sideNavTemplate = html `
|
|
|
15
18
|
class="logo"
|
|
16
19
|
part="side-nav-logo"
|
|
17
20
|
data-test-id="side-nav-logo"
|
|
21
|
+
alt="${(x) => x.logoAltText}"
|
|
18
22
|
/>
|
|
19
23
|
<slot name="menu-contents"></slot>
|
|
20
|
-
|
|
24
|
+
<${buttonTag}
|
|
21
25
|
slot="footer"
|
|
22
26
|
class="logout-container"
|
|
23
27
|
data-test-id="logout-button"
|
|
24
28
|
@click=${(x) => x.logout()}
|
|
29
|
+
aria-label="Sign out"
|
|
25
30
|
>
|
|
26
31
|
<${iconTag} name="sign-out-alt"></${iconTag}>
|
|
27
32
|
Sign out
|
|
28
|
-
|
|
33
|
+
</${buttonTag}>
|
|
29
34
|
</${flyoutTag}>
|
|
30
35
|
`;
|
|
31
36
|
const defaultRouteNavItemsTemplate = html `
|
|
32
37
|
<${buttonTag}
|
|
33
38
|
appearance="neutral-grey"
|
|
34
39
|
class="nav-button"
|
|
35
|
-
value="1"
|
|
36
40
|
@click=${(x) => x.navigateTo('protected')}
|
|
37
41
|
data-test-id="home-button"
|
|
42
|
+
aria-label="Home"
|
|
38
43
|
>
|
|
39
44
|
<${iconTag} name="home"></${iconTag}>
|
|
40
45
|
Home
|
|
41
46
|
</${buttonTag}>
|
|
42
|
-
<${
|
|
47
|
+
<${buttonTag}
|
|
48
|
+
appearance="neutral-grey"
|
|
49
|
+
class="nav-button"
|
|
50
|
+
@click=${(x) => x.navigateTo('not-found')}
|
|
51
|
+
data-test-id="profiles-button"
|
|
52
|
+
aria-label="Profiles"
|
|
53
|
+
>
|
|
43
54
|
<${iconTag} name="users"></${iconTag}>
|
|
44
55
|
Profiles
|
|
45
|
-
</${
|
|
56
|
+
</${buttonTag}>
|
|
46
57
|
`;
|
|
47
58
|
const routeNavItemsTemplate = html `
|
|
48
59
|
<template>
|
|
@@ -54,6 +65,7 @@ const routeNavItemsTemplate = html `
|
|
|
54
65
|
slot="routes"
|
|
55
66
|
@click=${(x, c) => c.parent.navigateTo(x.routePath)}
|
|
56
67
|
data-test-id="${(x) => `${x.routePath}-button`}"
|
|
68
|
+
aria-label=${(x) => x.title}
|
|
57
69
|
>
|
|
58
70
|
${when((x) => x.icon, html `
|
|
59
71
|
<${iconTag}
|
|
@@ -82,21 +94,32 @@ const routeNavItemsTemplate = html `
|
|
|
82
94
|
*/
|
|
83
95
|
export const NavTemplate = html `
|
|
84
96
|
${when((x) => !x.hideSideBar, sideNavTemplate)}
|
|
85
|
-
<div class="nav-listbox" data-test-id="nav-bar">
|
|
97
|
+
<div class="nav-listbox" data-test-id="nav-bar" role="navigation" aria-label="Main menu">
|
|
86
98
|
${app.registerElementsTarget('header-start')}
|
|
87
99
|
<div class="nav-leftside">
|
|
88
100
|
${app.registerElementsTarget('nav-start')}
|
|
89
101
|
${when((x) => !x.hideSideBar, html `
|
|
90
|
-
|
|
102
|
+
<${buttonTag}
|
|
91
103
|
class="bars-container"
|
|
92
104
|
@click=${(x) => x.toggleNavVisibility()}
|
|
93
105
|
data-test-id="hamburger-menu"
|
|
106
|
+
aria-label="Toggle side menu"
|
|
107
|
+
aria-controls="side-nav"
|
|
108
|
+
aria-expanded=${(x) => x.sideNavOpen}
|
|
109
|
+
appearance="stealth"
|
|
110
|
+
@focusin=${(x) => x.closeNav()}
|
|
94
111
|
>
|
|
95
112
|
<${iconTag} name="bars" part="nav-visibility-icon" class="nav-visibility-icon"></${iconTag}>
|
|
96
|
-
|
|
113
|
+
</${buttonTag}>
|
|
97
114
|
`)}
|
|
98
115
|
<div class="logo-container" data-test-id="nav-bar-logo">
|
|
99
|
-
<img
|
|
116
|
+
<img
|
|
117
|
+
src=${(x) => x.logoSrc}
|
|
118
|
+
class="logo"
|
|
119
|
+
part="logo"
|
|
120
|
+
data-test-id="logo"
|
|
121
|
+
alt="${(x) => x.logoAltText}"
|
|
122
|
+
/>
|
|
100
123
|
</div>
|
|
101
124
|
<slot name="routes" data-test-id="route-buttons">
|
|
102
125
|
${(x) => (x.routeNavItems ? routeNavItemsTemplate : defaultRouteNavItemsTemplate)}
|
|
@@ -110,6 +133,7 @@ export const NavTemplate = html `
|
|
|
110
133
|
class="icon-container"
|
|
111
134
|
data-test-id="luminance-toggle-button"
|
|
112
135
|
part="luminance-button"
|
|
136
|
+
aria-label="Luminance toggle"
|
|
113
137
|
>
|
|
114
138
|
<${iconTag}
|
|
115
139
|
@click=${(x) => x.luminanceIconEvent()}
|
|
@@ -120,7 +144,7 @@ export const NavTemplate = html `
|
|
|
120
144
|
</div>
|
|
121
145
|
`)}
|
|
122
146
|
${when((x) => x.showMiscToggleButton, html `
|
|
123
|
-
<div class="icon-container" data-test-id="misc-toggle-button" part="misc-button">
|
|
147
|
+
<div class="icon-container" data-test-id="misc-toggle-button" part="misc-button" aria-label="Misc icon">
|
|
124
148
|
<${iconTag} @click=${(x) => x.miscIconEvent()} name="th" part="misc-icon"></${iconTag}>
|
|
125
149
|
</div>
|
|
126
150
|
`)}
|
|
@@ -136,6 +160,7 @@ export const NavTemplate = html `
|
|
|
136
160
|
data-test-id="language-selector"
|
|
137
161
|
part="language-selector"
|
|
138
162
|
@change="${(x, c) => x.changeLanguage(c.event)}"
|
|
163
|
+
aria-label="Language selector"
|
|
139
164
|
>
|
|
140
165
|
${repeat((x) => x.languageOptions.availableLanguages, html `
|
|
141
166
|
<${optionTag}
|
|
@@ -148,7 +173,7 @@ export const NavTemplate = html `
|
|
|
148
173
|
</${selectTag}>
|
|
149
174
|
`)}
|
|
150
175
|
|
|
151
|
-
<${buttonTag} appearance="neutral-grey" data-test-id="user-button" class="nav-button">
|
|
176
|
+
<${buttonTag} appearance="neutral-grey" data-test-id="user-button" class="nav-button" aria-label="User button">
|
|
152
177
|
<${iconTag} name="user-circle"></${iconTag}>
|
|
153
178
|
${(x) => x.userName}
|
|
154
179
|
</${buttonTag}>
|
|
@@ -563,7 +563,7 @@
|
|
|
563
563
|
{
|
|
564
564
|
"kind": "Class",
|
|
565
565
|
"canonicalReference": "@genesislcap/foundation-header!Navigation:class",
|
|
566
|
-
"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",
|
|
566
|
+
"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 logo - alt-text -Descriptive logo text.\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",
|
|
567
567
|
"excerptTokens": [
|
|
568
568
|
{
|
|
569
569
|
"kind": "Content",
|
|
@@ -855,6 +855,36 @@
|
|
|
855
855
|
"isProtected": false,
|
|
856
856
|
"isAbstract": false
|
|
857
857
|
},
|
|
858
|
+
{
|
|
859
|
+
"kind": "Property",
|
|
860
|
+
"canonicalReference": "@genesislcap/foundation-header!Navigation#logoAltText:member",
|
|
861
|
+
"docComment": "",
|
|
862
|
+
"excerptTokens": [
|
|
863
|
+
{
|
|
864
|
+
"kind": "Content",
|
|
865
|
+
"text": "logoAltText: "
|
|
866
|
+
},
|
|
867
|
+
{
|
|
868
|
+
"kind": "Content",
|
|
869
|
+
"text": "string"
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"kind": "Content",
|
|
873
|
+
"text": ";"
|
|
874
|
+
}
|
|
875
|
+
],
|
|
876
|
+
"isReadonly": false,
|
|
877
|
+
"isOptional": false,
|
|
878
|
+
"releaseTag": "Public",
|
|
879
|
+
"name": "logoAltText",
|
|
880
|
+
"propertyTypeTokenRange": {
|
|
881
|
+
"startIndex": 1,
|
|
882
|
+
"endIndex": 2
|
|
883
|
+
},
|
|
884
|
+
"isStatic": false,
|
|
885
|
+
"isProtected": false,
|
|
886
|
+
"isAbstract": false
|
|
887
|
+
},
|
|
858
888
|
{
|
|
859
889
|
"kind": "Property",
|
|
860
890
|
"canonicalReference": "@genesislcap/foundation-header!Navigation#logoSrc:member",
|
|
@@ -191,6 +191,7 @@ export declare type NavEventDetailMap = {
|
|
|
191
191
|
* - The contents of the flyout menu.
|
|
192
192
|
*
|
|
193
193
|
* @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.
|
|
194
|
+
* @param logo-alt-text -Descriptive logo text.
|
|
194
195
|
* @param show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
|
|
195
196
|
* @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
|
|
196
197
|
* @param notification-icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.
|
|
@@ -232,6 +233,7 @@ export declare class Navigation extends Navigation_base {
|
|
|
232
233
|
* If this attribute is not set then the Genesis logo is shown instead
|
|
233
234
|
*/
|
|
234
235
|
logoSrc: any;
|
|
236
|
+
logoAltText: string;
|
|
235
237
|
/**
|
|
236
238
|
* Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar
|
|
237
239
|
* Control via`show-luminance-toggle-button`
|
|
@@ -360,6 +362,16 @@ export declare class Navigation extends Navigation_base {
|
|
|
360
362
|
* @internal
|
|
361
363
|
*/
|
|
362
364
|
toggleNavVisibility(): void;
|
|
365
|
+
/**
|
|
366
|
+
* Explicitly closes the flyout menu on the left
|
|
367
|
+
*
|
|
368
|
+
* @privateRemarks
|
|
369
|
+
* When the user tabs though and out of the flyout, the hamburger menu item will be re-focused and when that occurs we
|
|
370
|
+
* can close the menu to return to normal flow.
|
|
371
|
+
*
|
|
372
|
+
* @internal
|
|
373
|
+
*/
|
|
374
|
+
closeNav(): void;
|
|
363
375
|
/**
|
|
364
376
|
* Emits the event corresponding to the luminance icon being clicked
|
|
365
377
|
*
|
|
@@ -460,7 +472,14 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
460
472
|
readonly scrollHeight: number;
|
|
461
473
|
scrollLeft: number;
|
|
462
474
|
scrollTop: number;
|
|
463
|
-
readonly scrollWidth: number;
|
|
475
|
+
readonly scrollWidth: number; /**
|
|
476
|
+
* Optional attribute which controls the icon to show on the navigation bar and flyout
|
|
477
|
+
* Control via `logo-src`
|
|
478
|
+
*
|
|
479
|
+
* @remarks
|
|
480
|
+
*
|
|
481
|
+
* If this attribute is not set then the Genesis logo is shown instead
|
|
482
|
+
*/
|
|
464
483
|
readonly shadowRoot: ShadowRoot;
|
|
465
484
|
slot: string;
|
|
466
485
|
readonly tagName: string;
|
|
@@ -482,9 +501,6 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
482
501
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
483
502
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
484
503
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
485
|
-
/**
|
|
486
|
-
* @internal
|
|
487
|
-
*/
|
|
488
504
|
hasAttribute(qualifiedName: string): boolean;
|
|
489
505
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
490
506
|
hasAttributes(): boolean;
|
|
@@ -529,7 +545,9 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
529
545
|
appendChild<T extends Node>(node: T): T;
|
|
530
546
|
cloneNode(deep?: boolean): Node;
|
|
531
547
|
compareDocumentPosition(other: Node): number;
|
|
532
|
-
contains(other: Node): boolean;
|
|
548
|
+
contains(other: Node): boolean; /**
|
|
549
|
+
* If present the defined {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} will be rendered in the header 'routes' slot
|
|
550
|
+
*/
|
|
533
551
|
getRootNode(options?: GetRootNodeOptions): Node;
|
|
534
552
|
hasChildNodes(): boolean;
|
|
535
553
|
insertBefore<T_1 extends Node>(node: T_1, child: Node): T_1;
|
|
@@ -586,6 +604,16 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
586
604
|
ariaPosInSet: string;
|
|
587
605
|
ariaPressed: string;
|
|
588
606
|
ariaReadOnly: string;
|
|
607
|
+
/**
|
|
608
|
+
* Opens the flyout menu on the left hand side
|
|
609
|
+
*
|
|
610
|
+
* @remarks
|
|
611
|
+
*
|
|
612
|
+
* Activated when the user clicks on the menu button on the navigation
|
|
613
|
+
* bar left hand side
|
|
614
|
+
*
|
|
615
|
+
* @internal
|
|
616
|
+
*/
|
|
589
617
|
ariaRequired: string;
|
|
590
618
|
ariaRoleDescription: string;
|
|
591
619
|
ariaRowCount: string;
|
|
@@ -606,20 +634,21 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
606
634
|
before(...nodes: (string | Node)[]): void;
|
|
607
635
|
remove(): void;
|
|
608
636
|
replaceWith(...nodes: (string | Node)[]): void;
|
|
609
|
-
innerHTML: string;
|
|
610
|
-
* Emits the event corresponding to the notification icon being clicked
|
|
611
|
-
*
|
|
612
|
-
* @remarks
|
|
613
|
-
*
|
|
614
|
-
* Activated when the user clicks on the bell icon on the navigation
|
|
615
|
-
* bar right hand side
|
|
616
|
-
*
|
|
617
|
-
* @internal
|
|
618
|
-
*/
|
|
637
|
+
innerHTML: string;
|
|
619
638
|
readonly nextElementSibling: Element;
|
|
620
639
|
readonly previousElementSibling: Element;
|
|
621
640
|
readonly childElementCount: number;
|
|
622
641
|
readonly children: HTMLCollection;
|
|
642
|
+
/**
|
|
643
|
+
* Emits the event corresponding to the miscellaneous icon being clicked
|
|
644
|
+
*
|
|
645
|
+
* @remarks
|
|
646
|
+
*
|
|
647
|
+
* Activated when the user clicks on the menu icon on the navigation
|
|
648
|
+
* bar right hand side
|
|
649
|
+
*
|
|
650
|
+
* @internal
|
|
651
|
+
*/
|
|
623
652
|
readonly firstElementChild: Element;
|
|
624
653
|
readonly lastElementChild: Element;
|
|
625
654
|
append(...nodes: (string | Node)[]): void;
|
|
@@ -642,6 +671,22 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
642
671
|
readonly isContentEditable: boolean;
|
|
643
672
|
onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
644
673
|
onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
674
|
+
/**
|
|
675
|
+
* FoundationHeader.
|
|
676
|
+
*
|
|
677
|
+
* @remarks
|
|
678
|
+
* Base MF export used by host application `configure` calls. It does not set up a design system or components. Both are
|
|
679
|
+
* expected to be registered in the host application, which should provide the details of which to the MF via
|
|
680
|
+
* TemplateOptions.
|
|
681
|
+
*
|
|
682
|
+
* See the {@link configure} hook for more information on how to set up and use this micro frontend in your application.
|
|
683
|
+
*
|
|
684
|
+
* @privateRemarks
|
|
685
|
+
* We will override loadRemotes to remove zero. This setup is the inverse of FoundationAuth.
|
|
686
|
+
* We're doing this to avoid a breaking change, so consumers can continue to use Navigation which bundles zero.
|
|
687
|
+
*
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
645
690
|
onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
646
691
|
onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
647
692
|
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
@@ -0,0 +1,11 @@
|
|
|
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
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
logoAltText: string;
|
|
11
|
+
```
|
|
@@ -27,6 +27,7 @@ export declare class Navigation extends Navigation_base
|
|
|
27
27
|
| [hideSideBar](./foundation-header.navigation.hidesidebar.md) | | boolean | Boolean attribute which controls whether to include the sideNav component Control via<code>hide-side-bar</code> |
|
|
28
28
|
| [i18next](./foundation-header.navigation.i18next.md) | | I18next | |
|
|
29
29
|
| [languageOptions](./foundation-header.navigation.languageoptions.md) | | [LanguageOptions](./foundation-header.languageoptions.md) | |
|
|
30
|
+
| [logoAltText](./foundation-header.navigation.logoalttext.md) | | string | |
|
|
30
31
|
| [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> |
|
|
31
32
|
| [ready](./foundation-header.navigation.ready.md) | | boolean | |
|
|
32
33
|
| [routeButtons](./foundation-header.navigation.routebuttons.md) | | Array<{ index: number; path: string; title: string; icon: string; variant: string; }> | If present the defined route buttons will be rendered in the header 'routes' slot |
|
package/docs/api-report.md
CHANGED
|
@@ -86,6 +86,8 @@ export class Navigation extends Navigation_base {
|
|
|
86
86
|
// (undocumented)
|
|
87
87
|
auth: Auth;
|
|
88
88
|
changeLanguage(e: CustomEvent): void;
|
|
89
|
+
// @internal
|
|
90
|
+
closeNav(): void;
|
|
89
91
|
// (undocumented)
|
|
90
92
|
connectedCallback(): Promise<void>;
|
|
91
93
|
// (undocumented)
|
|
@@ -101,6 +103,8 @@ export class Navigation extends Navigation_base {
|
|
|
101
103
|
languageOptions: LanguageOptions;
|
|
102
104
|
// @internal
|
|
103
105
|
loadRemotes(): Promise<void>;
|
|
106
|
+
// (undocumented)
|
|
107
|
+
logoAltText: string;
|
|
104
108
|
logoSrc: any;
|
|
105
109
|
logout(): Promise<void>;
|
|
106
110
|
// @internal
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-header",
|
|
3
3
|
"description": "Genesis Foundation Header",
|
|
4
|
-
"version": "14.193.
|
|
4
|
+
"version": "14.193.3",
|
|
5
5
|
"license": "SEE LICENSE IN license.txt",
|
|
6
6
|
"main": "dist/esm/index.js",
|
|
7
7
|
"types": "dist/foundation-header.d.ts",
|
|
@@ -76,24 +76,24 @@
|
|
|
76
76
|
}
|
|
77
77
|
},
|
|
78
78
|
"devDependencies": {
|
|
79
|
-
"@genesislcap/foundation-testing": "14.193.
|
|
80
|
-
"@genesislcap/genx": "14.193.
|
|
81
|
-
"@genesislcap/rollup-builder": "14.193.
|
|
82
|
-
"@genesislcap/ts-builder": "14.193.
|
|
83
|
-
"@genesislcap/uvu-playwright-builder": "14.193.
|
|
84
|
-
"@genesislcap/vite-builder": "14.193.
|
|
85
|
-
"@genesislcap/webpack-builder": "14.193.
|
|
79
|
+
"@genesislcap/foundation-testing": "14.193.3",
|
|
80
|
+
"@genesislcap/genx": "14.193.3",
|
|
81
|
+
"@genesislcap/rollup-builder": "14.193.3",
|
|
82
|
+
"@genesislcap/ts-builder": "14.193.3",
|
|
83
|
+
"@genesislcap/uvu-playwright-builder": "14.193.3",
|
|
84
|
+
"@genesislcap/vite-builder": "14.193.3",
|
|
85
|
+
"@genesislcap/webpack-builder": "14.193.3",
|
|
86
86
|
"rimraf": "^5.0.0"
|
|
87
87
|
},
|
|
88
88
|
"dependencies": {
|
|
89
|
-
"@genesislcap/foundation-comms": "14.193.
|
|
90
|
-
"@genesislcap/foundation-events": "14.193.
|
|
91
|
-
"@genesislcap/foundation-i18n": "14.193.
|
|
92
|
-
"@genesislcap/foundation-logger": "14.193.
|
|
93
|
-
"@genesislcap/foundation-shell": "14.193.
|
|
94
|
-
"@genesislcap/foundation-ui": "14.193.
|
|
95
|
-
"@genesislcap/foundation-utils": "14.193.
|
|
96
|
-
"@genesislcap/foundation-zero": "14.193.
|
|
89
|
+
"@genesislcap/foundation-comms": "14.193.3",
|
|
90
|
+
"@genesislcap/foundation-events": "14.193.3",
|
|
91
|
+
"@genesislcap/foundation-i18n": "14.193.3",
|
|
92
|
+
"@genesislcap/foundation-logger": "14.193.3",
|
|
93
|
+
"@genesislcap/foundation-shell": "14.193.3",
|
|
94
|
+
"@genesislcap/foundation-ui": "14.193.3",
|
|
95
|
+
"@genesislcap/foundation-utils": "14.193.3",
|
|
96
|
+
"@genesislcap/foundation-zero": "14.193.3",
|
|
97
97
|
"@microsoft/fast-colors": "^5.3.1",
|
|
98
98
|
"@microsoft/fast-element": "^1.12.0",
|
|
99
99
|
"@microsoft/fast-foundation": "^2.49.4",
|
|
@@ -109,5 +109,5 @@
|
|
|
109
109
|
"access": "public"
|
|
110
110
|
},
|
|
111
111
|
"customElements": "dist/custom-elements.json",
|
|
112
|
-
"gitHead": "
|
|
112
|
+
"gitHead": "38840a2d88af7100ff4b38c9b1440885c67a0799"
|
|
113
113
|
}
|