@genesislcap/foundation-header 14.302.1-alpha-945e484.0 → 14.302.1-alpha-ecc0cfb.0
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/dts/main/main.d.ts +238 -258
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/dts/main/main.template.d.ts.map +1 -1
- package/dist/dts/styles/colors.d.ts.map +1 -1
- package/dist/dts/styles/styles.d.ts.map +1 -1
- package/dist/dts/tags/tags.d.ts.map +1 -1
- package/dist/esm/main/main.js +1 -1
- package/dist/foundation-header.api.json +1 -1
- package/dist/foundation-header.d.ts +238 -258
- package/dist/tsdoc-metadata.json +1 -1
- package/docs/api/foundation-header.configure.md +3 -33
- package/docs/api/foundation-header.foundationheader.md +3 -29
- package/docs/api/foundation-header.headerconfig.md +3 -41
- package/docs/api/foundation-header.md +25 -225
- package/docs/api/foundation-header.navigation.changelanguage.md +3 -31
- package/docs/api/foundation-header.navigation.handlenavbuttonclick.md +3 -33
- package/docs/api/foundation-header.navigation.md +35 -574
- package/docs/api/foundation-header.navigation.navigateto.md +3 -33
- package/docs/api/foundation-header.navigation.tolocalisedtext.md +3 -31
- package/docs/api/foundation-header.rapidheader.md +3 -29
- package/docs/api/index.md +3 -21
- package/package.json +23 -23
- package/docs/api-report.md.api.md +0 -197
package/dist/tsdoc-metadata.json
CHANGED
|
@@ -14,39 +14,9 @@ export declare function configure(config: Partial<HeaderConfig>): Promise<typeof
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Type
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Description
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th></tr></thead>
|
|
33
|
-
<tbody><tr><td>
|
|
34
|
-
|
|
35
|
-
config
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</td><td>
|
|
39
|
-
|
|
40
|
-
Partial<[HeaderConfig](./foundation-header.headerconfig.md)<!-- -->>
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
A partial HeaderConfig.
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td></tr>
|
|
49
|
-
</tbody></table>
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| config | Partial<[HeaderConfig](./foundation-header.headerconfig.md)<!-- -->> | A partial HeaderConfig. |
|
|
50
20
|
|
|
51
21
|
**Returns:**
|
|
52
22
|
|
|
@@ -21,33 +21,7 @@ See the [configure()](./foundation-header.configure.md) hook for more informatio
|
|
|
21
21
|
|
|
22
22
|
## Methods
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
</th><th>
|
|
30
|
-
|
|
31
|
-
Modifiers
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
</th><th>
|
|
35
|
-
|
|
36
|
-
Description
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
</th></tr></thead>
|
|
40
|
-
<tbody><tr><td>
|
|
41
|
-
|
|
42
|
-
[loadRemotes()](./foundation-header.foundationheader.loadremotes.md)
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
</td><td>
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td><td>
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
</td></tr>
|
|
52
|
-
</tbody></table>
|
|
24
|
+
| Method | Modifiers | Description |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| [loadRemotes()](./foundation-header.foundationheader.loadremotes.md) | | |
|
|
53
27
|
|
|
@@ -15,45 +15,7 @@ export interface HeaderConfig extends PartialGenesisElementDefinition
|
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
</th><th>
|
|
24
|
-
|
|
25
|
-
Modifiers
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
</th><th>
|
|
29
|
-
|
|
30
|
-
Type
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
</th><th>
|
|
34
|
-
|
|
35
|
-
Description
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</th></tr></thead>
|
|
39
|
-
<tbody><tr><td>
|
|
40
|
-
|
|
41
|
-
[templateOptions](./foundation-header.headerconfig.templateoptions.md)
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
</td><td>
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
</td><td>
|
|
48
|
-
|
|
49
|
-
TemplateOptions
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
</td><td>
|
|
53
|
-
|
|
54
|
-
Template options.
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
</td></tr>
|
|
58
|
-
</tbody></table>
|
|
18
|
+
| Property | Modifiers | Type | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| [templateOptions](./foundation-header.headerconfig.templateoptions.md) | | TemplateOptions | Template options. |
|
|
59
21
|
|
|
@@ -6,241 +6,41 @@
|
|
|
6
6
|
|
|
7
7
|
## Classes
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
</th><th>
|
|
15
|
-
|
|
16
|
-
Description
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
</th></tr></thead>
|
|
20
|
-
<tbody><tr><td>
|
|
21
|
-
|
|
22
|
-
[FoundationHeader](./foundation-header.foundationheader.md)
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
</td><td>
|
|
26
|
-
|
|
27
|
-
FoundationHeader.
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
</td></tr>
|
|
31
|
-
<tr><td>
|
|
32
|
-
|
|
33
|
-
[Navigation](./foundation-header.navigation.md)
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
</td><td>
|
|
37
|
-
|
|
38
|
-
Navigation micro-frontend includes navigation bar and flyout menu
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
</td></tr>
|
|
42
|
-
<tr><td>
|
|
43
|
-
|
|
44
|
-
[RapidHeader](./foundation-header.rapidheader.md)
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
</td><td>
|
|
48
|
-
|
|
49
|
-
RapidHeader is a rapid version of the header micro-frontend.
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
</td></tr>
|
|
53
|
-
</tbody></table>
|
|
9
|
+
| Class | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| [FoundationHeader](./foundation-header.foundationheader.md) | FoundationHeader. |
|
|
12
|
+
| [Navigation](./foundation-header.navigation.md) | Navigation micro-frontend includes navigation bar and flyout menu |
|
|
13
|
+
| [RapidHeader](./foundation-header.rapidheader.md) | RapidHeader is a rapid version of the header micro-frontend. |
|
|
54
14
|
|
|
55
15
|
## Functions
|
|
56
16
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</th><th>
|
|
63
|
-
|
|
64
|
-
Description
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
</th></tr></thead>
|
|
68
|
-
<tbody><tr><td>
|
|
69
|
-
|
|
70
|
-
[configure(config)](./foundation-header.configure.md)
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
</td><td>
|
|
74
|
-
|
|
75
|
-
A function that allows configuring the header micro-frontend with name and templateOptions.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</td></tr>
|
|
79
|
-
</tbody></table>
|
|
17
|
+
| Function | Description |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| [configure(config)](./foundation-header.configure.md) | A function that allows configuring the header micro-frontend with name and templateOptions. |
|
|
80
20
|
|
|
81
21
|
## Interfaces
|
|
82
22
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
</th><th>
|
|
89
|
-
|
|
90
|
-
Description
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
</th></tr></thead>
|
|
94
|
-
<tbody><tr><td>
|
|
95
|
-
|
|
96
|
-
[HeaderConfig](./foundation-header.headerconfig.md)
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
</td><td>
|
|
100
|
-
|
|
101
|
-
HeaderConfig DI interface.
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
</td></tr>
|
|
105
|
-
</tbody></table>
|
|
23
|
+
| Interface | Description |
|
|
24
|
+
| --- | --- |
|
|
25
|
+
| [HeaderConfig](./foundation-header.headerconfig.md) | HeaderConfig DI interface. |
|
|
106
26
|
|
|
107
27
|
## Variables
|
|
108
28
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
</th><th>
|
|
115
|
-
|
|
116
|
-
Description
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
</th></tr></thead>
|
|
120
|
-
<tbody><tr><td>
|
|
121
|
-
|
|
122
|
-
[defaultHeaderConfig](./foundation-header.defaultheaderconfig.md)
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
</td><td>
|
|
126
|
-
|
|
127
|
-
Default HeaderConfig DI implementation.
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
</td></tr>
|
|
131
|
-
<tr><td>
|
|
132
|
-
|
|
133
|
-
[MainStyles](./foundation-header.mainstyles.md)
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
</td><td>
|
|
137
|
-
|
|
138
|
-
Base styles for the foundation-header
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
</td></tr>
|
|
142
|
-
<tr><td>
|
|
143
|
-
|
|
144
|
-
[navTemplate](./foundation-header.navtemplate.md)
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
</td><td>
|
|
148
|
-
|
|
149
|
-
Template for Navigation class
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
</td></tr>
|
|
153
|
-
</tbody></table>
|
|
29
|
+
| Variable | Description |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| [defaultHeaderConfig](./foundation-header.defaultheaderconfig.md) | Default HeaderConfig DI implementation. |
|
|
32
|
+
| [MainStyles](./foundation-header.mainstyles.md) | Base styles for the foundation-header |
|
|
33
|
+
| [navTemplate](./foundation-header.navtemplate.md) | Template for Navigation class |
|
|
154
34
|
|
|
155
35
|
## Type Aliases
|
|
156
36
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
</th></tr></thead>
|
|
168
|
-
<tbody><tr><td>
|
|
169
|
-
|
|
170
|
-
[ElementTargetId](./foundation-header.elementtargetid.md)
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
</td><td>
|
|
174
|
-
|
|
175
|
-
Package element integration targets.
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
</td></tr>
|
|
179
|
-
<tr><td>
|
|
180
|
-
|
|
181
|
-
[HeaderTargetId](./foundation-header.headertargetid.md)
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
</td><td>
|
|
185
|
-
|
|
186
|
-
Header integration targets.
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
</td></tr>
|
|
190
|
-
<tr><td>
|
|
191
|
-
|
|
192
|
-
[LanguageOptions](./foundation-header.languageoptions.md)
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
</td><td>
|
|
196
|
-
|
|
197
|
-
Options for the language selector
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
</td></tr>
|
|
201
|
-
<tr><td>
|
|
202
|
-
|
|
203
|
-
[NavEventDetailMap](./foundation-header.naveventdetailmap.md)
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
</td><td>
|
|
207
|
-
|
|
208
|
-
Events dispatched by the navigation control buttons
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
</td></tr>
|
|
212
|
-
<tr><td>
|
|
213
|
-
|
|
214
|
-
[NavTargetId](./foundation-header.navtargetid.md)
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
</td><td>
|
|
218
|
-
|
|
219
|
-
Nav integration targets.
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
</td></tr>
|
|
223
|
-
<tr><td>
|
|
224
|
-
|
|
225
|
-
[SideNavTargetId](./foundation-header.sidenavtargetid.md)
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
</td><td>
|
|
229
|
-
|
|
230
|
-
Side nav integration targets.
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
</td></tr>
|
|
234
|
-
<tr><td>
|
|
235
|
-
|
|
236
|
-
[StyleTargetId](./foundation-header.styletargetid.md)
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
</td><td>
|
|
240
|
-
|
|
241
|
-
Package style integration targets.
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
</td></tr>
|
|
245
|
-
</tbody></table>
|
|
37
|
+
| Type Alias | Description |
|
|
38
|
+
| --- | --- |
|
|
39
|
+
| [ElementTargetId](./foundation-header.elementtargetid.md) | Package element integration targets. |
|
|
40
|
+
| [HeaderTargetId](./foundation-header.headertargetid.md) | Header integration targets. |
|
|
41
|
+
| [LanguageOptions](./foundation-header.languageoptions.md) | Options for the language selector |
|
|
42
|
+
| [NavEventDetailMap](./foundation-header.naveventdetailmap.md) | Events dispatched by the navigation control buttons |
|
|
43
|
+
| [NavTargetId](./foundation-header.navtargetid.md) | Nav integration targets. |
|
|
44
|
+
| [SideNavTargetId](./foundation-header.sidenavtargetid.md) | Side nav integration targets. |
|
|
45
|
+
| [StyleTargetId](./foundation-header.styletargetid.md) | Package style integration targets. |
|
|
246
46
|
|
|
@@ -14,37 +14,9 @@ changeLanguage(e: CustomEvent): void;
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Type
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Description
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th></tr></thead>
|
|
33
|
-
<tbody><tr><td>
|
|
34
|
-
|
|
35
|
-
e
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</td><td>
|
|
39
|
-
|
|
40
|
-
CustomEvent
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td></tr>
|
|
47
|
-
</tbody></table>
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| e | CustomEvent | |
|
|
48
20
|
|
|
49
21
|
**Returns:**
|
|
50
22
|
|
|
@@ -14,39 +14,9 @@ handleNavButtonClick(routeNavItem: FoundationRouteNavItem): void;
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Type
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Description
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th></tr></thead>
|
|
33
|
-
<tbody><tr><td>
|
|
34
|
-
|
|
35
|
-
routeNavItem
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</td><td>
|
|
39
|
-
|
|
40
|
-
FoundationRouteNavItem
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
The navigation item that was clicked
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td></tr>
|
|
49
|
-
</tbody></table>
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| routeNavItem | FoundationRouteNavItem | The navigation item that was clicked |
|
|
50
20
|
|
|
51
21
|
**Returns:**
|
|
52
22
|
|