@genesislcap/foundation-header 9.0.1-alpha-b5c5eb7.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.
Files changed (141) hide show
  1. package/README.md +246 -0
  2. package/dist/1.0.0.remoteEntry.js +1 -0
  3. package/dist/185.185.1368e7afe95e90687d2d.js +2 -0
  4. package/dist/185.bfe96e990dc6f09220d09b8c95f4b54c.js.map +1 -0
  5. package/dist/31607cf9ccd469a62208.svg +3 -0
  6. package/dist/338.338.6641454ca7888d1fe36e.js +2 -0
  7. package/dist/338.94cb9596c131c99ac58a37f38ad25ce7.js.map +1 -0
  8. package/dist/397.397.6f7ab18105495146ee4c.js +3 -0
  9. package/dist/397.397.6f7ab18105495146ee4c.js.LICENSE.txt +1 -0
  10. package/dist/397.b422a54dd9fd412d4aac2a90b8bb0e7a.js.map +1 -0
  11. package/dist/453.453.81dddb2e35aecdceb722.js +326 -0
  12. package/dist/453.547b1f466caf28aca7644e9032ba33d9.js.map +1 -0
  13. package/dist/506.216099078d895d583f069d47bbbbc118.js.map +1 -0
  14. package/dist/506.506.2df96cfa49403c056e18.js +3 -0
  15. package/dist/506.506.2df96cfa49403c056e18.js.LICENSE.txt +4 -0
  16. package/dist/540.540.16a5312961af053a4ac4.js +2 -0
  17. package/dist/540.6abb416013642069288d5369cb3126c7.js.map +1 -0
  18. package/dist/641.5d1b071000ebacbeffeb45846633c4ce.js.map +1 -0
  19. package/dist/641.641.0d19c60ce5b96cee96e9.js +3 -0
  20. package/dist/641.641.0d19c60ce5b96cee96e9.js.LICENSE.txt +4 -0
  21. package/dist/667.667.76a963874a8ced0ba03f.js +2 -0
  22. package/dist/667.e80f70ba5418c8fd00213d1c8ef97b86.js.map +1 -0
  23. package/dist/853.234215e17d31fe35e24b3b9241a6b6fd.js.map +1 -0
  24. package/dist/853.853.2cdc8d94fdad1718e016.js +2 -0
  25. package/dist/868.7e2669623e2fa4a4774231b5d97cd4a4.js.map +1 -0
  26. package/dist/868.868.db0184ec09b3ab0761a3.js +3405 -0
  27. package/dist/dashboard.json +1 -0
  28. package/dist/dts/components/components.d.ts +9 -0
  29. package/dist/dts/components/components.d.ts.map +1 -0
  30. package/dist/dts/components/index.d.ts +2 -0
  31. package/dist/dts/components/index.d.ts.map +1 -0
  32. package/dist/dts/index.d.ts +2 -0
  33. package/dist/dts/index.d.ts.map +1 -0
  34. package/dist/dts/index.federated.d.ts +1 -0
  35. package/dist/dts/index.federated.d.ts.map +1 -0
  36. package/dist/dts/main/index.d.ts +4 -0
  37. package/dist/dts/main/index.d.ts.map +1 -0
  38. package/dist/dts/main/main.d.ts +488 -0
  39. package/dist/dts/main/main.d.ts.map +1 -0
  40. package/dist/dts/main/main.styles.d.ts +10 -0
  41. package/dist/dts/main/main.styles.d.ts.map +1 -0
  42. package/dist/dts/main/main.template.d.ts +59 -0
  43. package/dist/dts/main/main.template.d.ts.map +1 -0
  44. package/dist/dts/styles/colors.d.ts +19 -0
  45. package/dist/dts/styles/colors.d.ts.map +1 -0
  46. package/dist/dts/styles/index.d.ts +3 -0
  47. package/dist/dts/styles/index.d.ts.map +1 -0
  48. package/dist/dts/styles/styles.d.ts +10 -0
  49. package/dist/dts/styles/styles.d.ts.map +1 -0
  50. package/dist/dts/styles/typography.d.ts +5 -0
  51. package/dist/dts/styles/typography.d.ts.map +1 -0
  52. package/dist/dts/tsdoc-metadata.json +11 -0
  53. package/dist/dts/utils/index.d.ts +2 -0
  54. package/dist/dts/utils/index.d.ts.map +1 -0
  55. package/dist/dts/utils/logger.d.ts +2 -0
  56. package/dist/dts/utils/logger.d.ts.map +1 -0
  57. package/dist/esm/assets/logo.svg +3 -0
  58. package/dist/esm/components/components.js +43 -0
  59. package/dist/esm/components/components.js.map +1 -0
  60. package/dist/esm/components/index.js +2 -0
  61. package/dist/esm/components/index.js.map +1 -0
  62. package/dist/esm/index.federated.js +2 -0
  63. package/dist/esm/index.federated.js.map +1 -0
  64. package/dist/esm/index.js +2 -0
  65. package/dist/esm/index.js.map +1 -0
  66. package/dist/esm/main/index.js +4 -0
  67. package/dist/esm/main/index.js.map +1 -0
  68. package/dist/esm/main/main.css +13 -0
  69. package/dist/esm/main/main.js +222 -0
  70. package/dist/esm/main/main.js.map +1 -0
  71. package/dist/esm/main/main.styles.js +250 -0
  72. package/dist/esm/main/main.styles.js.map +1 -0
  73. package/dist/esm/main/main.template.js +149 -0
  74. package/dist/esm/main/main.template.js.map +1 -0
  75. package/dist/esm/styles/colors.js +27 -0
  76. package/dist/esm/styles/colors.js.map +1 -0
  77. package/dist/esm/styles/index.js +3 -0
  78. package/dist/esm/styles/index.js.map +1 -0
  79. package/dist/esm/styles/styles.js +24 -0
  80. package/dist/esm/styles/styles.js.map +1 -0
  81. package/dist/esm/styles/typography.js +20 -0
  82. package/dist/esm/styles/typography.js.map +1 -0
  83. package/dist/esm/utils/index.js +2 -0
  84. package/dist/esm/utils/index.js.map +1 -0
  85. package/dist/esm/utils/logger.js +3 -0
  86. package/dist/esm/utils/logger.js.map +1 -0
  87. package/dist/favicon.ico +0 -0
  88. package/dist/foundation-header.api.json +837 -0
  89. package/dist/foundation-header.d.ts +521 -0
  90. package/dist/foundationHeader.d2a8e8744f9fd401e01219ffc10795af.js.map +1 -0
  91. package/dist/index.ejs +23 -0
  92. package/dist/index.html +10 -0
  93. package/dist/info.ejs +13 -0
  94. package/dist/info.html +19 -0
  95. package/dist/main.93fb4f46c19086cd1c10.js +2 -0
  96. package/dist/main.f149477dcf975f5bec20fdc2d0fce637.js.map +1 -0
  97. package/dist/npm.analytics.13d3017bcb2734b958e1c261c7e620d1.js.map +1 -0
  98. package/dist/npm.analytics.343.868701a34bf55591b35e.js +2 -0
  99. package/dist/npm.consola.713.a6a01a645775febbd05a.js +2 -0
  100. package/dist/npm.consola.d0475457692e79d2065981689ecbe6c8.js.map +1 -0
  101. package/dist/npm.dialog-polyfill.39e8a4cd9784ad9e0690d28f17eefeb3.js.map +1 -0
  102. package/dist/npm.dialog-polyfill.47.857e1cc698756a1d4d9f.js +2 -0
  103. package/dist/npm.finos.690.1d362c820f7a29e44178.js +2 -0
  104. package/dist/npm.finos.7eb5017b5506c0dd6de2c2bee763a997.js.map +1 -0
  105. package/dist/npm.fortawesome.104.6fdfed399ac3d4bcd076.js +2 -0
  106. package/dist/npm.fortawesome.96f1e7115d1e111bde725447b64f04a9.js.map +1 -0
  107. package/dist/npm.microsoft.127.63be836a7ee60f2db5e3.js +6406 -0
  108. package/dist/npm.microsoft.127.63be836a7ee60f2db5e3.js.LICENSE.txt +14 -0
  109. package/dist/npm.microsoft.93b16332ce7f1e3a889ad69e0403d652.js.map +1 -0
  110. package/dist/npm.rxjs.271.3c690069442a312eaee2.js +2 -0
  111. package/dist/npm.rxjs.3e4127a7515023cc78b8548028afb653.js.map +1 -0
  112. package/dist/remoteEntry.js +2 -0
  113. package/dist/serve.json +3 -0
  114. package/docs/api/foundation-header.mainstyles.md +13 -0
  115. package/docs/api/foundation-header.md +25 -0
  116. package/docs/api/foundation-header.naveventdetailmap.md +17 -0
  117. package/docs/api/foundation-header.navigation.auth.md +11 -0
  118. package/docs/api/foundation-header.navigation.connectedcallback.md +15 -0
  119. package/docs/api/foundation-header.navigation.credentialmanager.md +11 -0
  120. package/docs/api/foundation-header.navigation.hidesidebar.md +13 -0
  121. package/docs/api/foundation-header.navigation.logosrc.md +18 -0
  122. package/docs/api/foundation-header.navigation.logout.md +21 -0
  123. package/docs/api/foundation-header.navigation.md +45 -0
  124. package/docs/api/foundation-header.navigation.navigateto.md +28 -0
  125. package/docs/api/foundation-header.navigation.provider.md +11 -0
  126. package/docs/api/foundation-header.navigation.ready.md +11 -0
  127. package/docs/api/foundation-header.navigation.routebuttons.md +19 -0
  128. package/docs/api/foundation-header.navigation.selecttemplate.md +15 -0
  129. package/docs/api/foundation-header.navigation.showluminancetogglebutton.md +18 -0
  130. package/docs/api/foundation-header.navigation.showmisctogglebutton.md +18 -0
  131. package/docs/api/foundation-header.navigation.shownotificationsbutton.md +18 -0
  132. package/docs/api/foundation-header.navigation.sidenavopen.md +11 -0
  133. package/docs/api/foundation-header.navigation.username.md +13 -0
  134. package/docs/api/foundation-header.navtemplate.md +18 -0
  135. package/docs/api/index.md +12 -0
  136. package/docs/api-report.md +75 -0
  137. package/docs/img/foundation-header-replaced-img.png +0 -0
  138. package/docs/img/foundation-header-sidebar.png +0 -0
  139. package/docs/img/foundation-header-standard.png +0 -0
  140. package/license.txt +46 -0
  141. package/package.json +82 -0
@@ -0,0 +1,837 @@
1
+ {
2
+ "metadata": {
3
+ "toolPackage": "@microsoft/api-extractor",
4
+ "toolVersion": "7.34.4",
5
+ "schemaVersion": 1011,
6
+ "oldestForwardsCompatibleVersion": 1001,
7
+ "tsdocConfig": {
8
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
+ "noStandardTags": true,
10
+ "tagDefinitions": [
11
+ {
12
+ "tagName": "@alpha",
13
+ "syntaxKind": "modifier"
14
+ },
15
+ {
16
+ "tagName": "@beta",
17
+ "syntaxKind": "modifier"
18
+ },
19
+ {
20
+ "tagName": "@defaultValue",
21
+ "syntaxKind": "block"
22
+ },
23
+ {
24
+ "tagName": "@decorator",
25
+ "syntaxKind": "block",
26
+ "allowMultiple": true
27
+ },
28
+ {
29
+ "tagName": "@deprecated",
30
+ "syntaxKind": "block"
31
+ },
32
+ {
33
+ "tagName": "@eventProperty",
34
+ "syntaxKind": "modifier"
35
+ },
36
+ {
37
+ "tagName": "@example",
38
+ "syntaxKind": "block",
39
+ "allowMultiple": true
40
+ },
41
+ {
42
+ "tagName": "@experimental",
43
+ "syntaxKind": "modifier"
44
+ },
45
+ {
46
+ "tagName": "@inheritDoc",
47
+ "syntaxKind": "inline"
48
+ },
49
+ {
50
+ "tagName": "@internal",
51
+ "syntaxKind": "modifier"
52
+ },
53
+ {
54
+ "tagName": "@label",
55
+ "syntaxKind": "inline"
56
+ },
57
+ {
58
+ "tagName": "@link",
59
+ "syntaxKind": "inline",
60
+ "allowMultiple": true
61
+ },
62
+ {
63
+ "tagName": "@override",
64
+ "syntaxKind": "modifier"
65
+ },
66
+ {
67
+ "tagName": "@packageDocumentation",
68
+ "syntaxKind": "modifier"
69
+ },
70
+ {
71
+ "tagName": "@param",
72
+ "syntaxKind": "block",
73
+ "allowMultiple": true
74
+ },
75
+ {
76
+ "tagName": "@privateRemarks",
77
+ "syntaxKind": "block"
78
+ },
79
+ {
80
+ "tagName": "@public",
81
+ "syntaxKind": "modifier"
82
+ },
83
+ {
84
+ "tagName": "@readonly",
85
+ "syntaxKind": "modifier"
86
+ },
87
+ {
88
+ "tagName": "@remarks",
89
+ "syntaxKind": "block"
90
+ },
91
+ {
92
+ "tagName": "@returns",
93
+ "syntaxKind": "block"
94
+ },
95
+ {
96
+ "tagName": "@sealed",
97
+ "syntaxKind": "modifier"
98
+ },
99
+ {
100
+ "tagName": "@see",
101
+ "syntaxKind": "block"
102
+ },
103
+ {
104
+ "tagName": "@throws",
105
+ "syntaxKind": "block",
106
+ "allowMultiple": true
107
+ },
108
+ {
109
+ "tagName": "@typeParam",
110
+ "syntaxKind": "block",
111
+ "allowMultiple": true
112
+ },
113
+ {
114
+ "tagName": "@virtual",
115
+ "syntaxKind": "modifier"
116
+ },
117
+ {
118
+ "tagName": "@betaDocumentation",
119
+ "syntaxKind": "modifier"
120
+ },
121
+ {
122
+ "tagName": "@internalRemarks",
123
+ "syntaxKind": "block"
124
+ },
125
+ {
126
+ "tagName": "@preapproved",
127
+ "syntaxKind": "modifier"
128
+ }
129
+ ],
130
+ "supportForTags": {
131
+ "@alpha": true,
132
+ "@beta": true,
133
+ "@defaultValue": true,
134
+ "@decorator": true,
135
+ "@deprecated": true,
136
+ "@eventProperty": true,
137
+ "@example": true,
138
+ "@experimental": true,
139
+ "@inheritDoc": true,
140
+ "@internal": true,
141
+ "@label": true,
142
+ "@link": true,
143
+ "@override": true,
144
+ "@packageDocumentation": true,
145
+ "@param": true,
146
+ "@privateRemarks": true,
147
+ "@public": true,
148
+ "@readonly": true,
149
+ "@remarks": true,
150
+ "@returns": true,
151
+ "@sealed": true,
152
+ "@see": true,
153
+ "@throws": true,
154
+ "@typeParam": true,
155
+ "@virtual": true,
156
+ "@betaDocumentation": true,
157
+ "@internalRemarks": true,
158
+ "@preapproved": true
159
+ },
160
+ "reportUnsupportedHtmlElements": false
161
+ }
162
+ },
163
+ "kind": "Package",
164
+ "canonicalReference": "@genesislcap/foundation-header!",
165
+ "docComment": "",
166
+ "name": "@genesislcap/foundation-header",
167
+ "preserveMemberOrder": false,
168
+ "members": [
169
+ {
170
+ "kind": "EntryPoint",
171
+ "canonicalReference": "@genesislcap/foundation-header!",
172
+ "name": "",
173
+ "preserveMemberOrder": false,
174
+ "members": [
175
+ {
176
+ "kind": "Variable",
177
+ "canonicalReference": "@genesislcap/foundation-header!MainStyles:var",
178
+ "docComment": "/**\n * Base styles for the foundation-header\n *\n * @returns ElementStyles instance for the foundation-header\n *\n * @public\n */\n",
179
+ "excerptTokens": [
180
+ {
181
+ "kind": "Content",
182
+ "text": "MainStyles: "
183
+ },
184
+ {
185
+ "kind": "Content",
186
+ "text": "import(\"@microsoft/fast-element\")."
187
+ },
188
+ {
189
+ "kind": "Reference",
190
+ "text": "ElementStyles",
191
+ "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
192
+ }
193
+ ],
194
+ "fileUrlPath": "src/main/main.styles.ts",
195
+ "isReadonly": true,
196
+ "releaseTag": "Public",
197
+ "name": "MainStyles",
198
+ "variableTypeTokenRange": {
199
+ "startIndex": 1,
200
+ "endIndex": 3
201
+ }
202
+ },
203
+ {
204
+ "kind": "TypeAlias",
205
+ "canonicalReference": "@genesislcap/foundation-header!NavEventDetailMap:type",
206
+ "docComment": "/**\n * Events dispatched by the navigation control buttons\n *\n * @public\n */\n",
207
+ "excerptTokens": [
208
+ {
209
+ "kind": "Content",
210
+ "text": "export type NavEventDetailMap = "
211
+ },
212
+ {
213
+ "kind": "Content",
214
+ "text": "{\n 'luminance-icon-clicked': void;\n 'misc-icon-clicked': void;\n 'notification-icon-clicked': void;\n}"
215
+ },
216
+ {
217
+ "kind": "Content",
218
+ "text": ";"
219
+ }
220
+ ],
221
+ "fileUrlPath": "src/main/main.ts",
222
+ "releaseTag": "Public",
223
+ "name": "NavEventDetailMap",
224
+ "typeTokenRange": {
225
+ "startIndex": 1,
226
+ "endIndex": 2
227
+ }
228
+ },
229
+ {
230
+ "kind": "Class",
231
+ "canonicalReference": "@genesislcap/foundation-header!Navigation:class",
232
+ "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 show - misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @public\n */\n",
233
+ "excerptTokens": [
234
+ {
235
+ "kind": "Content",
236
+ "text": "export declare class Navigation extends "
237
+ },
238
+ {
239
+ "kind": "Reference",
240
+ "text": "Navigation_base",
241
+ "canonicalReference": "@genesislcap/foundation-header!~Navigation_base"
242
+ },
243
+ {
244
+ "kind": "Content",
245
+ "text": " "
246
+ }
247
+ ],
248
+ "fileUrlPath": "src/main/main.ts",
249
+ "releaseTag": "Public",
250
+ "isAbstract": false,
251
+ "name": "Navigation",
252
+ "preserveMemberOrder": false,
253
+ "members": [
254
+ {
255
+ "kind": "Property",
256
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#auth:member",
257
+ "docComment": "",
258
+ "excerptTokens": [
259
+ {
260
+ "kind": "Content",
261
+ "text": "auth: "
262
+ },
263
+ {
264
+ "kind": "Reference",
265
+ "text": "Auth",
266
+ "canonicalReference": "@genesislcap/foundation-comms!Auth:interface"
267
+ },
268
+ {
269
+ "kind": "Content",
270
+ "text": ";"
271
+ }
272
+ ],
273
+ "isReadonly": false,
274
+ "isOptional": false,
275
+ "releaseTag": "Public",
276
+ "name": "auth",
277
+ "propertyTypeTokenRange": {
278
+ "startIndex": 1,
279
+ "endIndex": 2
280
+ },
281
+ "isStatic": false,
282
+ "isProtected": false,
283
+ "isAbstract": false
284
+ },
285
+ {
286
+ "kind": "Method",
287
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#connectedCallback:member(1)",
288
+ "docComment": "",
289
+ "excerptTokens": [
290
+ {
291
+ "kind": "Content",
292
+ "text": "connectedCallback(): "
293
+ },
294
+ {
295
+ "kind": "Reference",
296
+ "text": "Promise",
297
+ "canonicalReference": "!Promise:interface"
298
+ },
299
+ {
300
+ "kind": "Content",
301
+ "text": "<void>"
302
+ },
303
+ {
304
+ "kind": "Content",
305
+ "text": ";"
306
+ }
307
+ ],
308
+ "isStatic": false,
309
+ "returnTypeTokenRange": {
310
+ "startIndex": 1,
311
+ "endIndex": 3
312
+ },
313
+ "releaseTag": "Public",
314
+ "isProtected": false,
315
+ "overloadIndex": 1,
316
+ "parameters": [],
317
+ "isOptional": false,
318
+ "isAbstract": false,
319
+ "name": "connectedCallback"
320
+ },
321
+ {
322
+ "kind": "Property",
323
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#credentialManager:member",
324
+ "docComment": "",
325
+ "excerptTokens": [
326
+ {
327
+ "kind": "Content",
328
+ "text": "credentialManager: "
329
+ },
330
+ {
331
+ "kind": "Reference",
332
+ "text": "CredentialManager",
333
+ "canonicalReference": "@genesislcap/foundation-comms!CredentialManager:interface"
334
+ },
335
+ {
336
+ "kind": "Content",
337
+ "text": ";"
338
+ }
339
+ ],
340
+ "isReadonly": false,
341
+ "isOptional": false,
342
+ "releaseTag": "Public",
343
+ "name": "credentialManager",
344
+ "propertyTypeTokenRange": {
345
+ "startIndex": 1,
346
+ "endIndex": 2
347
+ },
348
+ "isStatic": false,
349
+ "isProtected": false,
350
+ "isAbstract": false
351
+ },
352
+ {
353
+ "kind": "Property",
354
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#hideSideBar:member",
355
+ "docComment": "/**\n * Boolean attribute which controls whether to include the sideNav component Control via`hide-side-bar`\n */\n",
356
+ "excerptTokens": [
357
+ {
358
+ "kind": "Content",
359
+ "text": "hideSideBar: "
360
+ },
361
+ {
362
+ "kind": "Content",
363
+ "text": "boolean"
364
+ },
365
+ {
366
+ "kind": "Content",
367
+ "text": ";"
368
+ }
369
+ ],
370
+ "isReadonly": false,
371
+ "isOptional": false,
372
+ "releaseTag": "Public",
373
+ "name": "hideSideBar",
374
+ "propertyTypeTokenRange": {
375
+ "startIndex": 1,
376
+ "endIndex": 2
377
+ },
378
+ "isStatic": false,
379
+ "isProtected": false,
380
+ "isAbstract": false
381
+ },
382
+ {
383
+ "kind": "Property",
384
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#logoSrc:member",
385
+ "docComment": "/**\n * Optional attribute which controls the icon to show on the navigation bar and flyout Control via `logo-src`\n *\n * @remarks\n *\n * If this attribute is not set then the Genesis logo is shown instead\n */\n",
386
+ "excerptTokens": [
387
+ {
388
+ "kind": "Content",
389
+ "text": "logoSrc: "
390
+ },
391
+ {
392
+ "kind": "Content",
393
+ "text": "any"
394
+ },
395
+ {
396
+ "kind": "Content",
397
+ "text": ";"
398
+ }
399
+ ],
400
+ "isReadonly": false,
401
+ "isOptional": false,
402
+ "releaseTag": "Public",
403
+ "name": "logoSrc",
404
+ "propertyTypeTokenRange": {
405
+ "startIndex": 1,
406
+ "endIndex": 2
407
+ },
408
+ "isStatic": false,
409
+ "isProtected": false,
410
+ "isAbstract": false
411
+ },
412
+ {
413
+ "kind": "Method",
414
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#logout:member(1)",
415
+ "docComment": "/**\n * Logs the user out of their session\n *\n * @remarks\n *\n * Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires the usage of the auth functionality from {@link @genesislcap/foundation-comms#Auth}.\n *\n * @public\n */\n",
416
+ "excerptTokens": [
417
+ {
418
+ "kind": "Content",
419
+ "text": "logout(): "
420
+ },
421
+ {
422
+ "kind": "Reference",
423
+ "text": "Promise",
424
+ "canonicalReference": "!Promise:interface"
425
+ },
426
+ {
427
+ "kind": "Content",
428
+ "text": "<void>"
429
+ },
430
+ {
431
+ "kind": "Content",
432
+ "text": ";"
433
+ }
434
+ ],
435
+ "isStatic": false,
436
+ "returnTypeTokenRange": {
437
+ "startIndex": 1,
438
+ "endIndex": 3
439
+ },
440
+ "releaseTag": "Public",
441
+ "isProtected": false,
442
+ "overloadIndex": 1,
443
+ "parameters": [],
444
+ "isOptional": false,
445
+ "isAbstract": false,
446
+ "name": "logout"
447
+ },
448
+ {
449
+ "kind": "Method",
450
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#navigateTo:member(1)",
451
+ "docComment": "/**\n * Changes the route of the current page\n *\n * @remarks\n *\n * Requires setup of the Router and usage of the FAST Router\n *\n * @param path - string represeting the new route to move to\n *\n * @public\n */\n",
452
+ "excerptTokens": [
453
+ {
454
+ "kind": "Content",
455
+ "text": "navigateTo(path: "
456
+ },
457
+ {
458
+ "kind": "Content",
459
+ "text": "string"
460
+ },
461
+ {
462
+ "kind": "Content",
463
+ "text": "): "
464
+ },
465
+ {
466
+ "kind": "Content",
467
+ "text": "void"
468
+ },
469
+ {
470
+ "kind": "Content",
471
+ "text": ";"
472
+ }
473
+ ],
474
+ "isStatic": false,
475
+ "returnTypeTokenRange": {
476
+ "startIndex": 3,
477
+ "endIndex": 4
478
+ },
479
+ "releaseTag": "Public",
480
+ "isProtected": false,
481
+ "overloadIndex": 1,
482
+ "parameters": [
483
+ {
484
+ "parameterName": "path",
485
+ "parameterTypeTokenRange": {
486
+ "startIndex": 1,
487
+ "endIndex": 2
488
+ },
489
+ "isOptional": false
490
+ }
491
+ ],
492
+ "isOptional": false,
493
+ "isAbstract": false,
494
+ "name": "navigateTo"
495
+ },
496
+ {
497
+ "kind": "Property",
498
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#provider:member",
499
+ "docComment": "",
500
+ "excerptTokens": [
501
+ {
502
+ "kind": "Content",
503
+ "text": "provider: "
504
+ },
505
+ {
506
+ "kind": "Content",
507
+ "text": "any"
508
+ },
509
+ {
510
+ "kind": "Content",
511
+ "text": ";"
512
+ }
513
+ ],
514
+ "isReadonly": false,
515
+ "isOptional": false,
516
+ "releaseTag": "Public",
517
+ "name": "provider",
518
+ "propertyTypeTokenRange": {
519
+ "startIndex": 1,
520
+ "endIndex": 2
521
+ },
522
+ "isStatic": false,
523
+ "isProtected": false,
524
+ "isAbstract": false
525
+ },
526
+ {
527
+ "kind": "Property",
528
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#ready:member",
529
+ "docComment": "",
530
+ "excerptTokens": [
531
+ {
532
+ "kind": "Content",
533
+ "text": "ready: "
534
+ },
535
+ {
536
+ "kind": "Content",
537
+ "text": "boolean"
538
+ },
539
+ {
540
+ "kind": "Content",
541
+ "text": ";"
542
+ }
543
+ ],
544
+ "isReadonly": false,
545
+ "isOptional": false,
546
+ "releaseTag": "Public",
547
+ "name": "ready",
548
+ "propertyTypeTokenRange": {
549
+ "startIndex": 1,
550
+ "endIndex": 2
551
+ },
552
+ "isStatic": false,
553
+ "isProtected": false,
554
+ "isAbstract": false
555
+ },
556
+ {
557
+ "kind": "Property",
558
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#routeButtons:member",
559
+ "docComment": "/**\n * If present the defined route buttons will be rendered in the header 'routes' slot\n */\n",
560
+ "excerptTokens": [
561
+ {
562
+ "kind": "Content",
563
+ "text": "routeButtons: "
564
+ },
565
+ {
566
+ "kind": "Reference",
567
+ "text": "Array",
568
+ "canonicalReference": "!Array:interface"
569
+ },
570
+ {
571
+ "kind": "Content",
572
+ "text": "<{\n index: number;\n path: string;\n title: string;\n icon: string;\n variant: string;\n }>"
573
+ },
574
+ {
575
+ "kind": "Content",
576
+ "text": ";"
577
+ }
578
+ ],
579
+ "isReadonly": false,
580
+ "isOptional": false,
581
+ "releaseTag": "Public",
582
+ "name": "routeButtons",
583
+ "propertyTypeTokenRange": {
584
+ "startIndex": 1,
585
+ "endIndex": 3
586
+ },
587
+ "isStatic": false,
588
+ "isProtected": false,
589
+ "isAbstract": false
590
+ },
591
+ {
592
+ "kind": "Method",
593
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#selectTemplate:member(1)",
594
+ "docComment": "",
595
+ "excerptTokens": [
596
+ {
597
+ "kind": "Content",
598
+ "text": "selectTemplate(): "
599
+ },
600
+ {
601
+ "kind": "Content",
602
+ "text": "import(\"@microsoft/fast-element\")."
603
+ },
604
+ {
605
+ "kind": "Reference",
606
+ "text": "ViewTemplate",
607
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
608
+ },
609
+ {
610
+ "kind": "Content",
611
+ "text": "<"
612
+ },
613
+ {
614
+ "kind": "Reference",
615
+ "text": "Navigation",
616
+ "canonicalReference": "@genesislcap/foundation-header!Navigation:class"
617
+ },
618
+ {
619
+ "kind": "Content",
620
+ "text": ", any>"
621
+ },
622
+ {
623
+ "kind": "Content",
624
+ "text": ";"
625
+ }
626
+ ],
627
+ "isStatic": false,
628
+ "returnTypeTokenRange": {
629
+ "startIndex": 1,
630
+ "endIndex": 6
631
+ },
632
+ "releaseTag": "Public",
633
+ "isProtected": false,
634
+ "overloadIndex": 1,
635
+ "parameters": [],
636
+ "isOptional": false,
637
+ "isAbstract": false,
638
+ "name": "selectTemplate"
639
+ },
640
+ {
641
+ "kind": "Property",
642
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#showLuminanceToggleButton:member",
643
+ "docComment": "/**\n * Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar Control via`show-luminance-toggle-button`\n *\n * @remarks\n *\n * If the user clicks the icon when shown then this class will emit the 'luminance-icon-clicked' event\n */\n",
644
+ "excerptTokens": [
645
+ {
646
+ "kind": "Content",
647
+ "text": "showLuminanceToggleButton: "
648
+ },
649
+ {
650
+ "kind": "Content",
651
+ "text": "boolean"
652
+ },
653
+ {
654
+ "kind": "Content",
655
+ "text": ";"
656
+ }
657
+ ],
658
+ "isReadonly": false,
659
+ "isOptional": false,
660
+ "releaseTag": "Public",
661
+ "name": "showLuminanceToggleButton",
662
+ "propertyTypeTokenRange": {
663
+ "startIndex": 1,
664
+ "endIndex": 2
665
+ },
666
+ "isStatic": false,
667
+ "isProtected": false,
668
+ "isAbstract": false
669
+ },
670
+ {
671
+ "kind": "Property",
672
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#showMiscToggleButton:member",
673
+ "docComment": "/**\n * Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar Control via `show-luminance-toggle-button`\n *\n * @remarks\n *\n * If the user clicks the icon when shown then this class will emit the 'misc-icon-clicked' event\n */\n",
674
+ "excerptTokens": [
675
+ {
676
+ "kind": "Content",
677
+ "text": "showMiscToggleButton: "
678
+ },
679
+ {
680
+ "kind": "Content",
681
+ "text": "boolean"
682
+ },
683
+ {
684
+ "kind": "Content",
685
+ "text": ";"
686
+ }
687
+ ],
688
+ "isReadonly": false,
689
+ "isOptional": false,
690
+ "releaseTag": "Public",
691
+ "name": "showMiscToggleButton",
692
+ "propertyTypeTokenRange": {
693
+ "startIndex": 1,
694
+ "endIndex": 2
695
+ },
696
+ "isStatic": false,
697
+ "isProtected": false,
698
+ "isAbstract": false
699
+ },
700
+ {
701
+ "kind": "Property",
702
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#showNotificationsButton:member",
703
+ "docComment": "/**\n * Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar Control via `show-notification-button`\n *\n * @remarks\n *\n * If the user clicks the icon when shown then this class will emit the 'notification-icon-clicked' event\n */\n",
704
+ "excerptTokens": [
705
+ {
706
+ "kind": "Content",
707
+ "text": "showNotificationsButton: "
708
+ },
709
+ {
710
+ "kind": "Content",
711
+ "text": "boolean"
712
+ },
713
+ {
714
+ "kind": "Content",
715
+ "text": ";"
716
+ }
717
+ ],
718
+ "isReadonly": false,
719
+ "isOptional": false,
720
+ "releaseTag": "Public",
721
+ "name": "showNotificationsButton",
722
+ "propertyTypeTokenRange": {
723
+ "startIndex": 1,
724
+ "endIndex": 2
725
+ },
726
+ "isStatic": false,
727
+ "isProtected": false,
728
+ "isAbstract": false
729
+ },
730
+ {
731
+ "kind": "Property",
732
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#sideNavOpen:member",
733
+ "docComment": "",
734
+ "excerptTokens": [
735
+ {
736
+ "kind": "Content",
737
+ "text": "sideNavOpen: "
738
+ },
739
+ {
740
+ "kind": "Content",
741
+ "text": "boolean"
742
+ },
743
+ {
744
+ "kind": "Content",
745
+ "text": ";"
746
+ }
747
+ ],
748
+ "isReadonly": false,
749
+ "isOptional": false,
750
+ "releaseTag": "Public",
751
+ "name": "sideNavOpen",
752
+ "propertyTypeTokenRange": {
753
+ "startIndex": 1,
754
+ "endIndex": 2
755
+ },
756
+ "isStatic": false,
757
+ "isProtected": false,
758
+ "isAbstract": false
759
+ },
760
+ {
761
+ "kind": "Property",
762
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#userName:member",
763
+ "docComment": "/**\n * Username of the logged in user\n */\n",
764
+ "excerptTokens": [
765
+ {
766
+ "kind": "Content",
767
+ "text": "userName: "
768
+ },
769
+ {
770
+ "kind": "Content",
771
+ "text": "string"
772
+ },
773
+ {
774
+ "kind": "Content",
775
+ "text": ";"
776
+ }
777
+ ],
778
+ "isReadonly": false,
779
+ "isOptional": false,
780
+ "releaseTag": "Public",
781
+ "name": "userName",
782
+ "propertyTypeTokenRange": {
783
+ "startIndex": 1,
784
+ "endIndex": 2
785
+ },
786
+ "isStatic": false,
787
+ "isProtected": false,
788
+ "isAbstract": false
789
+ }
790
+ ],
791
+ "extendsTokenRange": {
792
+ "startIndex": 1,
793
+ "endIndex": 2
794
+ },
795
+ "implementsTokenRanges": []
796
+ },
797
+ {
798
+ "kind": "Variable",
799
+ "canonicalReference": "@genesislcap/foundation-header!NavTemplate:var",
800
+ "docComment": "/**\n * Template for Navigation class\n *\n * @remarks\n *\n * Contains the template for both the sidenav and the navigation bar\n *\n * @typeParam Navigation - Navigation class\n *\n * @returns ViewTemplate instance of the Navigation html\n *\n * @public\n */\n",
801
+ "excerptTokens": [
802
+ {
803
+ "kind": "Content",
804
+ "text": "NavTemplate: "
805
+ },
806
+ {
807
+ "kind": "Reference",
808
+ "text": "ViewTemplate",
809
+ "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
810
+ },
811
+ {
812
+ "kind": "Content",
813
+ "text": "<"
814
+ },
815
+ {
816
+ "kind": "Reference",
817
+ "text": "Navigation",
818
+ "canonicalReference": "@genesislcap/foundation-header!Navigation:class"
819
+ },
820
+ {
821
+ "kind": "Content",
822
+ "text": ", any>"
823
+ }
824
+ ],
825
+ "fileUrlPath": "src/main/main.template.ts",
826
+ "isReadonly": true,
827
+ "releaseTag": "Public",
828
+ "name": "NavTemplate",
829
+ "variableTypeTokenRange": {
830
+ "startIndex": 1,
831
+ "endIndex": 5
832
+ }
833
+ }
834
+ ]
835
+ }
836
+ ]
837
+ }