@genesislcap/foundation-header 14.140.0 → 14.141.1
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 +555 -25
- package/dist/dts/components/zero-components.d.ts +6 -0
- package/dist/dts/components/zero-components.d.ts.map +1 -0
- package/dist/dts/config/config.d.ts +33 -0
- package/dist/dts/config/config.d.ts.map +1 -0
- package/dist/dts/config/configure.d.ts +27 -0
- package/dist/dts/config/configure.d.ts.map +1 -0
- package/dist/dts/config/index.d.ts +2 -0
- package/dist/dts/config/index.d.ts.map +1 -1
- package/dist/dts/config/templates.d.ts +34 -0
- package/dist/dts/config/templates.d.ts.map +1 -0
- package/dist/dts/main/index.d.ts +1 -1
- package/dist/dts/main/index.d.ts.map +1 -1
- package/dist/dts/main/main.d.ts +64 -22
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/dts/main/main.styles.d.ts.map +1 -1
- package/dist/dts/main/main.template.d.ts.map +1 -1
- package/dist/dts/tags/index.d.ts +2 -0
- package/dist/dts/tags/index.d.ts.map +1 -0
- package/dist/dts/tags/tags.d.ts +36 -0
- package/dist/dts/tags/tags.d.ts.map +1 -0
- package/dist/esm/components/zero-components.js +48 -0
- package/dist/esm/config/config.js +18 -0
- package/dist/esm/config/configure.js +56 -0
- package/dist/esm/config/index.js +2 -0
- package/dist/esm/config/templates.js +14 -0
- package/dist/esm/main/index.js +1 -1
- package/dist/esm/main/main.js +57 -22
- package/dist/esm/main/main.styles.js +56 -133
- package/dist/esm/main/main.template.js +32 -28
- package/dist/esm/tags/index.js +1 -0
- package/dist/esm/tags/tags.js +39 -0
- package/dist/foundation-header.api.json +219 -0
- package/dist/foundation-header.d.ts +200 -24
- package/docs/api/foundation-header.configure.md +46 -0
- package/docs/api/foundation-header.defaultheaderconfig.md +13 -0
- package/docs/api/foundation-header.foundationheader.md +39 -0
- package/docs/api/foundation-header.headerconfig.md +21 -0
- package/docs/api/foundation-header.headerconfig.templateoptions.md +18 -0
- package/docs/api/foundation-header.md +14 -0
- package/docs/api/foundation-header.navigation.headerconfig.md +11 -0
- package/docs/api/foundation-header.navigation.md +1 -0
- package/docs/api-report.md +46 -2
- package/package.json +14 -12
- package/dist/dts/components/components.d.ts +0 -9
- package/dist/dts/components/components.d.ts.map +0 -1
- package/dist/dts/components/index.d.ts +0 -2
- package/dist/dts/components/index.d.ts.map +0 -1
- package/dist/esm/components/components.js +0 -42
- package/dist/esm/components/index.js +0 -1
|
@@ -33,48 +33,79 @@
|
|
|
33
33
|
},
|
|
34
34
|
{
|
|
35
35
|
"kind": "javascript-module",
|
|
36
|
-
"path": "src/components/components.ts",
|
|
36
|
+
"path": "src/components/zero-components.ts",
|
|
37
37
|
"declarations": [
|
|
38
38
|
{
|
|
39
39
|
"kind": "function",
|
|
40
|
-
"name": "
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
"kind": "function",
|
|
44
|
-
"name": "loadRemotes",
|
|
45
|
-
"description": "Load the wp5 module federation remote versions, or fallback to code split bundled versions.\nYou would really be targeting the client's design system, components etc here. For now just targeting zero."
|
|
40
|
+
"name": "registerCommonZeroComponents",
|
|
41
|
+
"description": "registerCommonZeroComponents.",
|
|
42
|
+
"privacy": "public"
|
|
46
43
|
}
|
|
47
44
|
],
|
|
48
45
|
"exports": [
|
|
49
46
|
{
|
|
50
47
|
"kind": "js",
|
|
51
|
-
"name": "
|
|
48
|
+
"name": "registerCommonZeroComponents",
|
|
52
49
|
"declaration": {
|
|
53
|
-
"name": "
|
|
54
|
-
"module": "src/components/components.ts"
|
|
50
|
+
"name": "registerCommonZeroComponents",
|
|
51
|
+
"module": "src/components/zero-components.ts"
|
|
55
52
|
}
|
|
56
|
-
}
|
|
53
|
+
}
|
|
54
|
+
]
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"kind": "javascript-module",
|
|
58
|
+
"path": "src/config/config.ts",
|
|
59
|
+
"declarations": [
|
|
60
|
+
{
|
|
61
|
+
"kind": "variable",
|
|
62
|
+
"name": "defaultHeaderConfig",
|
|
63
|
+
"type": {
|
|
64
|
+
"text": "HeaderConfig"
|
|
65
|
+
},
|
|
66
|
+
"default": "{\n name: 'foundation-header',\n templateOptions: defaultTemplateOptions,\n}",
|
|
67
|
+
"description": "Default HeaderConfig DI implementation.",
|
|
68
|
+
"privacy": "public"
|
|
69
|
+
}
|
|
70
|
+
],
|
|
71
|
+
"exports": [
|
|
57
72
|
{
|
|
58
73
|
"kind": "js",
|
|
59
|
-
"name": "
|
|
74
|
+
"name": "defaultHeaderConfig",
|
|
60
75
|
"declaration": {
|
|
61
|
-
"name": "
|
|
62
|
-
"module": "src/
|
|
76
|
+
"name": "defaultHeaderConfig",
|
|
77
|
+
"module": "src/config/config.ts"
|
|
63
78
|
}
|
|
64
79
|
}
|
|
65
80
|
]
|
|
66
81
|
},
|
|
67
82
|
{
|
|
68
83
|
"kind": "javascript-module",
|
|
69
|
-
"path": "src/
|
|
70
|
-
"declarations": [
|
|
84
|
+
"path": "src/config/configure.ts",
|
|
85
|
+
"declarations": [
|
|
86
|
+
{
|
|
87
|
+
"kind": "function",
|
|
88
|
+
"name": "configure",
|
|
89
|
+
"parameters": [
|
|
90
|
+
{
|
|
91
|
+
"name": "config",
|
|
92
|
+
"type": {
|
|
93
|
+
"text": "Partial<HeaderConfig>"
|
|
94
|
+
},
|
|
95
|
+
"description": "A partial HeaderConfig."
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"description": "A function that allows configuring the header micro-frontend with name and templateOptions.",
|
|
99
|
+
"privacy": "public"
|
|
100
|
+
}
|
|
101
|
+
],
|
|
71
102
|
"exports": [
|
|
72
103
|
{
|
|
73
104
|
"kind": "js",
|
|
74
|
-
"name": "
|
|
105
|
+
"name": "configure",
|
|
75
106
|
"declaration": {
|
|
76
|
-
"name": "
|
|
77
|
-
"
|
|
107
|
+
"name": "configure",
|
|
108
|
+
"module": "src/config/configure.ts"
|
|
78
109
|
}
|
|
79
110
|
}
|
|
80
111
|
]
|
|
@@ -84,6 +115,22 @@
|
|
|
84
115
|
"path": "src/config/index.ts",
|
|
85
116
|
"declarations": [],
|
|
86
117
|
"exports": [
|
|
118
|
+
{
|
|
119
|
+
"kind": "js",
|
|
120
|
+
"name": "*",
|
|
121
|
+
"declaration": {
|
|
122
|
+
"name": "*",
|
|
123
|
+
"package": "./config"
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"kind": "js",
|
|
128
|
+
"name": "*",
|
|
129
|
+
"declaration": {
|
|
130
|
+
"name": "*",
|
|
131
|
+
"package": "./configure"
|
|
132
|
+
}
|
|
133
|
+
},
|
|
87
134
|
{
|
|
88
135
|
"kind": "js",
|
|
89
136
|
"name": "*",
|
|
@@ -100,6 +147,32 @@
|
|
|
100
147
|
"declarations": [],
|
|
101
148
|
"exports": []
|
|
102
149
|
},
|
|
150
|
+
{
|
|
151
|
+
"kind": "javascript-module",
|
|
152
|
+
"path": "src/config/templates.ts",
|
|
153
|
+
"declarations": [
|
|
154
|
+
{
|
|
155
|
+
"kind": "variable",
|
|
156
|
+
"name": "defaultTemplateOptions",
|
|
157
|
+
"type": {
|
|
158
|
+
"text": "TemplateOptions"
|
|
159
|
+
},
|
|
160
|
+
"default": "{\n icon: 'zero-icon',\n button: 'zero-button',\n connectionIndicator: 'zero-connection-indicator',\n select: 'zero-select',\n option: 'zero-option',\n flyout: 'zero-flyout',\n}",
|
|
161
|
+
"description": "defaultTemplateOptions.",
|
|
162
|
+
"privacy": "public"
|
|
163
|
+
}
|
|
164
|
+
],
|
|
165
|
+
"exports": [
|
|
166
|
+
{
|
|
167
|
+
"kind": "js",
|
|
168
|
+
"name": "defaultTemplateOptions",
|
|
169
|
+
"declaration": {
|
|
170
|
+
"name": "defaultTemplateOptions",
|
|
171
|
+
"module": "src/config/templates.ts"
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
]
|
|
175
|
+
},
|
|
103
176
|
{
|
|
104
177
|
"kind": "javascript-module",
|
|
105
178
|
"path": "src/main/index.ts",
|
|
@@ -115,10 +188,10 @@
|
|
|
115
188
|
},
|
|
116
189
|
{
|
|
117
190
|
"kind": "js",
|
|
118
|
-
"name": "
|
|
191
|
+
"name": "*",
|
|
119
192
|
"declaration": {
|
|
120
|
-
"name": "
|
|
121
|
-
"
|
|
193
|
+
"name": "*",
|
|
194
|
+
"package": "./main.template"
|
|
122
195
|
}
|
|
123
196
|
},
|
|
124
197
|
{
|
|
@@ -165,7 +238,7 @@
|
|
|
165
238
|
{
|
|
166
239
|
"kind": "variable",
|
|
167
240
|
"name": "NavTemplate",
|
|
168
|
-
"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 <div\n class=\"bars-container\"\n @click=${(x) => x.toggleNavVisibility()}\n data-test-id=\"hamburger-menu\"\n >\n
|
|
241
|
+
"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 <div\n class=\"bars-container\"\n @click=${(x) => x.toggleNavVisibility()}\n data-test-id=\"hamburger-menu\"\n >\n <${iconTag} name=\"bars\" part=\"nav-visibility-icon\" class=\"nav-visibility-icon\"></${iconTag}>\n </div>\n `,\n )}\n <div class=\"logo-container\" data-test-id=\"nav-bar-logo\">\n <img src=${(x) => x.logoSrc} class=\"logo\" part=\"logo\" />\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 >\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\">\n <${iconTag} @click=${(x) => x.miscIconEvent()} name=\"th\" part=\"misc-icon\"></${iconTag}>\n </div>\n `,\n )}\n <!-- ${when(\n (x) => x.showNotificationsButton,\n html<Navigation>`\n <div\n class=\"icon-container\"\n data-test-id=\"notifications-button\"\n part=\"notifications-button\"\n >\n <${iconTag}\n variant=\"regular\"\n @click=${(x) => x.notificationIconEvent()}\n name=\"bell\"\n part=\"notifications-icon\"\n ></${iconTag}>\n <slot name=\"notifications-icon-end\"></slot>\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 >\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\">\n <${iconTag} name=\"user-circle\"></${iconTag}>\n ${(x) => x.userName}\n </${buttonTag}>\n </div>\n ${app.registerElementsTarget<HeaderTargetId>(['header', 'header-end'])}\n </div>\n`",
|
|
169
242
|
"description": "Template for Navigation class",
|
|
170
243
|
"return": {
|
|
171
244
|
"type": {
|
|
@@ -216,6 +289,13 @@
|
|
|
216
289
|
"text": "I18next"
|
|
217
290
|
}
|
|
218
291
|
},
|
|
292
|
+
{
|
|
293
|
+
"kind": "field",
|
|
294
|
+
"name": "headerConfig",
|
|
295
|
+
"type": {
|
|
296
|
+
"text": "HeaderConfig"
|
|
297
|
+
}
|
|
298
|
+
},
|
|
219
299
|
{
|
|
220
300
|
"kind": "field",
|
|
221
301
|
"name": "ready",
|
|
@@ -476,8 +556,429 @@
|
|
|
476
556
|
"name": "FASTElement",
|
|
477
557
|
"package": "@microsoft/fast-element"
|
|
478
558
|
},
|
|
479
|
-
"tagName": "foundation-header",
|
|
480
559
|
"customElement": true
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"kind": "class",
|
|
563
|
+
"description": "FoundationHeader is a zero version of the header micro-frontend.",
|
|
564
|
+
"name": "FoundationHeader",
|
|
565
|
+
"superclass": {
|
|
566
|
+
"name": "Navigation",
|
|
567
|
+
"module": "src/main/main.ts"
|
|
568
|
+
},
|
|
569
|
+
"tagName": "foundation-header",
|
|
570
|
+
"customElement": true,
|
|
571
|
+
"attributes": [
|
|
572
|
+
{
|
|
573
|
+
"name": "logo-src",
|
|
574
|
+
"type": {
|
|
575
|
+
"text": "any"
|
|
576
|
+
},
|
|
577
|
+
"default": "logo",
|
|
578
|
+
"description": "Optional attribute which controls the icon to show on the navigation bar and flyout\nControl via `logo-src`",
|
|
579
|
+
"resolveInitializer": {
|
|
580
|
+
"module": "/src/assets/logo.svg"
|
|
581
|
+
},
|
|
582
|
+
"fieldName": "logoSrc",
|
|
583
|
+
"inheritedFrom": {
|
|
584
|
+
"name": "Navigation",
|
|
585
|
+
"module": "src/main/main.ts"
|
|
586
|
+
}
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "show-luminance-toggle-button",
|
|
590
|
+
"type": {
|
|
591
|
+
"text": "boolean"
|
|
592
|
+
},
|
|
593
|
+
"description": "Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar\nControl via`show-luminance-toggle-button`",
|
|
594
|
+
"fieldName": "showLuminanceToggleButton",
|
|
595
|
+
"inheritedFrom": {
|
|
596
|
+
"name": "Navigation",
|
|
597
|
+
"module": "src/main/main.ts"
|
|
598
|
+
}
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
"name": "show-misc-toggle-button",
|
|
602
|
+
"type": {
|
|
603
|
+
"text": "boolean"
|
|
604
|
+
},
|
|
605
|
+
"description": "Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar\nControl via `show-luminance-toggle-button`",
|
|
606
|
+
"fieldName": "showMiscToggleButton",
|
|
607
|
+
"inheritedFrom": {
|
|
608
|
+
"name": "Navigation",
|
|
609
|
+
"module": "src/main/main.ts"
|
|
610
|
+
}
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"name": "show-notification-button",
|
|
614
|
+
"type": {
|
|
615
|
+
"text": "boolean"
|
|
616
|
+
},
|
|
617
|
+
"description": "Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar\nControl via `show-notification-button`",
|
|
618
|
+
"deprecated": "- Add/Remove PBC Notify via `genx` instead.",
|
|
619
|
+
"fieldName": "showNotificationsButton",
|
|
620
|
+
"inheritedFrom": {
|
|
621
|
+
"name": "Navigation",
|
|
622
|
+
"module": "src/main/main.ts"
|
|
623
|
+
}
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"name": "show-connection-indicator",
|
|
627
|
+
"type": {
|
|
628
|
+
"text": "boolean"
|
|
629
|
+
},
|
|
630
|
+
"default": "true",
|
|
631
|
+
"description": "Boolean attribute which controls whether to show the connection indicator on the navigation bar\nControl via `show-connection-indicator`",
|
|
632
|
+
"fieldName": "showConnectionIndicator",
|
|
633
|
+
"inheritedFrom": {
|
|
634
|
+
"name": "Navigation",
|
|
635
|
+
"module": "src/main/main.ts"
|
|
636
|
+
}
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "show-language-selector",
|
|
640
|
+
"type": {
|
|
641
|
+
"text": "boolean"
|
|
642
|
+
},
|
|
643
|
+
"default": "false",
|
|
644
|
+
"description": "Boolean attribute which controls whether to show the language selector on the navigation bar\nControl via `show-language-selector`",
|
|
645
|
+
"fieldName": "showLanguageSelector",
|
|
646
|
+
"inheritedFrom": {
|
|
647
|
+
"name": "Navigation",
|
|
648
|
+
"module": "src/main/main.ts"
|
|
649
|
+
}
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
"name": "hide-side-bar",
|
|
653
|
+
"type": {
|
|
654
|
+
"text": "boolean"
|
|
655
|
+
},
|
|
656
|
+
"description": "Boolean attribute which controls whether to include the sideNav component\nControl via`hide-side-bar`",
|
|
657
|
+
"fieldName": "hideSideBar",
|
|
658
|
+
"inheritedFrom": {
|
|
659
|
+
"name": "Navigation",
|
|
660
|
+
"module": "src/main/main.ts"
|
|
661
|
+
}
|
|
662
|
+
}
|
|
663
|
+
],
|
|
664
|
+
"members": [
|
|
665
|
+
{
|
|
666
|
+
"kind": "field",
|
|
667
|
+
"name": "auth",
|
|
668
|
+
"type": {
|
|
669
|
+
"text": "Auth"
|
|
670
|
+
},
|
|
671
|
+
"inheritedFrom": {
|
|
672
|
+
"name": "Navigation",
|
|
673
|
+
"module": "src/main/main.ts"
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"kind": "field",
|
|
678
|
+
"name": "credentialManager",
|
|
679
|
+
"type": {
|
|
680
|
+
"text": "CredentialManager"
|
|
681
|
+
},
|
|
682
|
+
"inheritedFrom": {
|
|
683
|
+
"name": "Navigation",
|
|
684
|
+
"module": "src/main/main.ts"
|
|
685
|
+
}
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
"kind": "field",
|
|
689
|
+
"name": "i18next",
|
|
690
|
+
"type": {
|
|
691
|
+
"text": "I18next"
|
|
692
|
+
},
|
|
693
|
+
"inheritedFrom": {
|
|
694
|
+
"name": "Navigation",
|
|
695
|
+
"module": "src/main/main.ts"
|
|
696
|
+
}
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"kind": "field",
|
|
700
|
+
"name": "headerConfig",
|
|
701
|
+
"type": {
|
|
702
|
+
"text": "HeaderConfig"
|
|
703
|
+
},
|
|
704
|
+
"inheritedFrom": {
|
|
705
|
+
"name": "Navigation",
|
|
706
|
+
"module": "src/main/main.ts"
|
|
707
|
+
}
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"kind": "field",
|
|
711
|
+
"name": "ready",
|
|
712
|
+
"type": {
|
|
713
|
+
"text": "boolean"
|
|
714
|
+
},
|
|
715
|
+
"default": "false",
|
|
716
|
+
"inheritedFrom": {
|
|
717
|
+
"name": "Navigation",
|
|
718
|
+
"module": "src/main/main.ts"
|
|
719
|
+
}
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"kind": "field",
|
|
723
|
+
"name": "userName",
|
|
724
|
+
"type": {
|
|
725
|
+
"text": "string"
|
|
726
|
+
},
|
|
727
|
+
"privacy": "public",
|
|
728
|
+
"description": "Username of the logged in user",
|
|
729
|
+
"inheritedFrom": {
|
|
730
|
+
"name": "Navigation",
|
|
731
|
+
"module": "src/main/main.ts"
|
|
732
|
+
}
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"kind": "field",
|
|
736
|
+
"name": "sideNavOpen",
|
|
737
|
+
"type": {
|
|
738
|
+
"text": "boolean"
|
|
739
|
+
},
|
|
740
|
+
"default": "false",
|
|
741
|
+
"inheritedFrom": {
|
|
742
|
+
"name": "Navigation",
|
|
743
|
+
"module": "src/main/main.ts"
|
|
744
|
+
}
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
"kind": "field",
|
|
748
|
+
"name": "logoSrc",
|
|
749
|
+
"type": {
|
|
750
|
+
"text": "any"
|
|
751
|
+
},
|
|
752
|
+
"default": "logo",
|
|
753
|
+
"description": "Optional attribute which controls the icon to show on the navigation bar and flyout\nControl via `logo-src`",
|
|
754
|
+
"inheritedFrom": {
|
|
755
|
+
"name": "Navigation",
|
|
756
|
+
"module": "src/main/main.ts"
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"kind": "field",
|
|
761
|
+
"name": "showLuminanceToggleButton",
|
|
762
|
+
"type": {
|
|
763
|
+
"text": "boolean"
|
|
764
|
+
},
|
|
765
|
+
"description": "Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar\nControl via`show-luminance-toggle-button`",
|
|
766
|
+
"inheritedFrom": {
|
|
767
|
+
"name": "Navigation",
|
|
768
|
+
"module": "src/main/main.ts"
|
|
769
|
+
}
|
|
770
|
+
},
|
|
771
|
+
{
|
|
772
|
+
"kind": "field",
|
|
773
|
+
"name": "showMiscToggleButton",
|
|
774
|
+
"type": {
|
|
775
|
+
"text": "boolean"
|
|
776
|
+
},
|
|
777
|
+
"description": "Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar\nControl via `show-luminance-toggle-button`",
|
|
778
|
+
"inheritedFrom": {
|
|
779
|
+
"name": "Navigation",
|
|
780
|
+
"module": "src/main/main.ts"
|
|
781
|
+
}
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"kind": "field",
|
|
785
|
+
"name": "showNotificationsButton",
|
|
786
|
+
"type": {
|
|
787
|
+
"text": "boolean"
|
|
788
|
+
},
|
|
789
|
+
"description": "Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar\nControl via `show-notification-button`",
|
|
790
|
+
"deprecated": "- Add/Remove PBC Notify via `genx` instead.",
|
|
791
|
+
"inheritedFrom": {
|
|
792
|
+
"name": "Navigation",
|
|
793
|
+
"module": "src/main/main.ts"
|
|
794
|
+
}
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
"kind": "field",
|
|
798
|
+
"name": "showConnectionIndicator",
|
|
799
|
+
"type": {
|
|
800
|
+
"text": "boolean"
|
|
801
|
+
},
|
|
802
|
+
"default": "true",
|
|
803
|
+
"description": "Boolean attribute which controls whether to show the connection indicator on the navigation bar\nControl via `show-connection-indicator`",
|
|
804
|
+
"inheritedFrom": {
|
|
805
|
+
"name": "Navigation",
|
|
806
|
+
"module": "src/main/main.ts"
|
|
807
|
+
}
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"kind": "field",
|
|
811
|
+
"name": "showLanguageSelector",
|
|
812
|
+
"type": {
|
|
813
|
+
"text": "boolean"
|
|
814
|
+
},
|
|
815
|
+
"default": "false",
|
|
816
|
+
"description": "Boolean attribute which controls whether to show the language selector on the navigation bar\nControl via `show-language-selector`",
|
|
817
|
+
"inheritedFrom": {
|
|
818
|
+
"name": "Navigation",
|
|
819
|
+
"module": "src/main/main.ts"
|
|
820
|
+
}
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"kind": "field",
|
|
824
|
+
"name": "languageOptions",
|
|
825
|
+
"type": {
|
|
826
|
+
"text": "LanguageOptions"
|
|
827
|
+
},
|
|
828
|
+
"default": "{\n availableLanguages: Object.keys(this.i18next.config.resources ?? {}),\n selectedLanguage: this.i18next.config.lng,\n }",
|
|
829
|
+
"inheritedFrom": {
|
|
830
|
+
"name": "Navigation",
|
|
831
|
+
"module": "src/main/main.ts"
|
|
832
|
+
}
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
"kind": "field",
|
|
836
|
+
"name": "hideSideBar",
|
|
837
|
+
"type": {
|
|
838
|
+
"text": "boolean"
|
|
839
|
+
},
|
|
840
|
+
"description": "Boolean attribute which controls whether to include the sideNav component\nControl via`hide-side-bar`",
|
|
841
|
+
"inheritedFrom": {
|
|
842
|
+
"name": "Navigation",
|
|
843
|
+
"module": "src/main/main.ts"
|
|
844
|
+
}
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
"kind": "field",
|
|
848
|
+
"name": "routeButtons",
|
|
849
|
+
"type": {
|
|
850
|
+
"text": "Array<{\n index: number;\n path: string;\n title: string;\n icon: string;\n variant: string;\n }>"
|
|
851
|
+
},
|
|
852
|
+
"description": "If present the defined route buttons will be rendered in the header 'routes' slot",
|
|
853
|
+
"deprecated": "- Use `routeNavItems` instead.",
|
|
854
|
+
"inheritedFrom": {
|
|
855
|
+
"name": "Navigation",
|
|
856
|
+
"module": "src/main/main.ts"
|
|
857
|
+
}
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
"kind": "field",
|
|
861
|
+
"name": "routeNavItems",
|
|
862
|
+
"type": {
|
|
863
|
+
"text": "FoundationRouteNavItem[]"
|
|
864
|
+
},
|
|
865
|
+
"description": "If present the defined @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems will be rendered in the header 'routes' slot",
|
|
866
|
+
"inheritedFrom": {
|
|
867
|
+
"name": "Navigation",
|
|
868
|
+
"module": "src/main/main.ts"
|
|
869
|
+
}
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"kind": "method",
|
|
873
|
+
"name": "selectTemplate",
|
|
874
|
+
"inheritedFrom": {
|
|
875
|
+
"name": "Navigation",
|
|
876
|
+
"module": "src/main/main.ts"
|
|
877
|
+
}
|
|
878
|
+
},
|
|
879
|
+
{
|
|
880
|
+
"kind": "method",
|
|
881
|
+
"name": "logout",
|
|
882
|
+
"privacy": "public",
|
|
883
|
+
"description": "Logs the user out of their session",
|
|
884
|
+
"inheritedFrom": {
|
|
885
|
+
"name": "Navigation",
|
|
886
|
+
"module": "src/main/main.ts"
|
|
887
|
+
}
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
"kind": "method",
|
|
891
|
+
"name": "navigateTo",
|
|
892
|
+
"privacy": "public",
|
|
893
|
+
"parameters": [
|
|
894
|
+
{
|
|
895
|
+
"name": "path",
|
|
896
|
+
"type": {
|
|
897
|
+
"text": "string"
|
|
898
|
+
},
|
|
899
|
+
"description": "string represeting the new route to move to"
|
|
900
|
+
}
|
|
901
|
+
],
|
|
902
|
+
"description": "Changes the route of the current page",
|
|
903
|
+
"inheritedFrom": {
|
|
904
|
+
"name": "Navigation",
|
|
905
|
+
"module": "src/main/main.ts"
|
|
906
|
+
}
|
|
907
|
+
},
|
|
908
|
+
{
|
|
909
|
+
"kind": "method",
|
|
910
|
+
"name": "changeLanguage",
|
|
911
|
+
"parameters": [
|
|
912
|
+
{
|
|
913
|
+
"name": "e",
|
|
914
|
+
"type": {
|
|
915
|
+
"text": "CustomEvent"
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
],
|
|
919
|
+
"description": "Changes the language of the application",
|
|
920
|
+
"inheritedFrom": {
|
|
921
|
+
"name": "Navigation",
|
|
922
|
+
"module": "src/main/main.ts"
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"kind": "method",
|
|
927
|
+
"name": "toLocalisedText",
|
|
928
|
+
"return": {
|
|
929
|
+
"type": {
|
|
930
|
+
"text": "string"
|
|
931
|
+
}
|
|
932
|
+
},
|
|
933
|
+
"parameters": [
|
|
934
|
+
{
|
|
935
|
+
"name": "text",
|
|
936
|
+
"type": {
|
|
937
|
+
"text": "string"
|
|
938
|
+
}
|
|
939
|
+
}
|
|
940
|
+
],
|
|
941
|
+
"description": "To localised text",
|
|
942
|
+
"inheritedFrom": {
|
|
943
|
+
"name": "Navigation",
|
|
944
|
+
"module": "src/main/main.ts"
|
|
945
|
+
}
|
|
946
|
+
}
|
|
947
|
+
],
|
|
948
|
+
"events": [
|
|
949
|
+
{
|
|
950
|
+
"description": "Dispatched when the user clicks on the luminance toggle icon in the navigation bar.",
|
|
951
|
+
"name": "luminance-icon-clicked",
|
|
952
|
+
"inheritedFrom": {
|
|
953
|
+
"name": "Navigation",
|
|
954
|
+
"module": "src/main/main.ts"
|
|
955
|
+
}
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
"description": "Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.",
|
|
959
|
+
"name": "misc-icon-clicked",
|
|
960
|
+
"inheritedFrom": {
|
|
961
|
+
"name": "Navigation",
|
|
962
|
+
"module": "src/main/main.ts"
|
|
963
|
+
}
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"description": "Dispatched when the user clicks on the notification icon in the navigation bar.",
|
|
967
|
+
"name": "notification-icon-clicked",
|
|
968
|
+
"inheritedFrom": {
|
|
969
|
+
"name": "Navigation",
|
|
970
|
+
"module": "src/main/main.ts"
|
|
971
|
+
}
|
|
972
|
+
},
|
|
973
|
+
{
|
|
974
|
+
"description": "Dispatched when the user changes the language in the language selector.",
|
|
975
|
+
"name": "language-changed",
|
|
976
|
+
"inheritedFrom": {
|
|
977
|
+
"name": "Navigation",
|
|
978
|
+
"module": "src/main/main.ts"
|
|
979
|
+
}
|
|
980
|
+
}
|
|
981
|
+
]
|
|
481
982
|
}
|
|
482
983
|
],
|
|
483
984
|
"exports": [
|
|
@@ -489,11 +990,19 @@
|
|
|
489
990
|
"module": "src/main/main.ts"
|
|
490
991
|
}
|
|
491
992
|
},
|
|
993
|
+
{
|
|
994
|
+
"kind": "js",
|
|
995
|
+
"name": "FoundationHeader",
|
|
996
|
+
"declaration": {
|
|
997
|
+
"name": "FoundationHeader",
|
|
998
|
+
"module": "src/main/main.ts"
|
|
999
|
+
}
|
|
1000
|
+
},
|
|
492
1001
|
{
|
|
493
1002
|
"kind": "custom-element-definition",
|
|
494
1003
|
"name": "foundation-header",
|
|
495
1004
|
"declaration": {
|
|
496
|
-
"name": "
|
|
1005
|
+
"name": "FoundationHeader",
|
|
497
1006
|
"module": "src/main/main.ts"
|
|
498
1007
|
}
|
|
499
1008
|
}
|
|
@@ -660,6 +1169,27 @@
|
|
|
660
1169
|
}
|
|
661
1170
|
]
|
|
662
1171
|
},
|
|
1172
|
+
{
|
|
1173
|
+
"kind": "javascript-module",
|
|
1174
|
+
"path": "src/tags/index.ts",
|
|
1175
|
+
"declarations": [],
|
|
1176
|
+
"exports": [
|
|
1177
|
+
{
|
|
1178
|
+
"kind": "js",
|
|
1179
|
+
"name": "*",
|
|
1180
|
+
"declaration": {
|
|
1181
|
+
"name": "*",
|
|
1182
|
+
"package": "./tags"
|
|
1183
|
+
}
|
|
1184
|
+
}
|
|
1185
|
+
]
|
|
1186
|
+
},
|
|
1187
|
+
{
|
|
1188
|
+
"kind": "javascript-module",
|
|
1189
|
+
"path": "src/tags/tags.ts",
|
|
1190
|
+
"declarations": [],
|
|
1191
|
+
"exports": []
|
|
1192
|
+
},
|
|
663
1193
|
{
|
|
664
1194
|
"kind": "javascript-module",
|
|
665
1195
|
"path": "src/utils/index.ts",
|