@genesislcap/foundation-header 14.70.2 → 14.70.4-es2021.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.
@@ -290,6 +290,20 @@
290
290
  "description": "Changes the route of the current page"
291
291
  }
292
292
  ],
293
+ "events": [
294
+ {
295
+ "description": "Dispatched when the user clicks on the luminance toggle icon in the navigation bar.",
296
+ "name": "luminance-icon-clicked"
297
+ },
298
+ {
299
+ "description": "Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.",
300
+ "name": "misc-icon-clicked"
301
+ },
302
+ {
303
+ "description": "Dispatched when the user clicks on the notification icon in the navigation bar.",
304
+ "name": "notification-icon-clicked"
305
+ }
306
+ ],
293
307
  "attributes": [
294
308
  {
295
309
  "name": "logo-src",
@@ -33,6 +33,11 @@ declare const Navigation_base: abstract new (...args: any[]) => {
33
33
  * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
34
34
  *
35
35
  * @public
36
+ *
37
+ * @fires luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.
38
+ * @fires misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.
39
+ * @fires notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.
40
+ *
36
41
  */
37
42
  export declare class Navigation extends Navigation_base {
38
43
  auth: Auth;
@@ -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;AAUtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;AAKF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;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;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}
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;AAUtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;AAKF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;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;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}
@@ -1,4 +1,3 @@
1
- import { __awaiter } from "tslib";
2
1
  /**
3
2
  * These DS / Component imports will be replaced with an import from the local alpha design system.
4
3
  * We're just fixing something on our side to allow you to extend zero.
@@ -16,27 +15,27 @@ function loadZeroFallback() {
16
15
  /* webpackMode: "lazy" */
17
16
  '@genesislcap/foundation-zero');
18
17
  }
19
- export const loadZeroDesignSystem = () => __awaiter(void 0, void 0, void 0, function* () {
18
+ export const loadZeroDesignSystem = async () => {
20
19
  let type = ResourceType.remote;
21
20
  try {
22
21
  // @ts-ignore
23
- return yield import('foundationZero/ZeroDesignSystem');
22
+ return await import('foundationZero/ZeroDesignSystem');
24
23
  }
25
24
  catch (e) {
26
25
  type = ResourceType.local;
27
- return yield loadZeroFallback();
26
+ return await loadZeroFallback();
28
27
  }
29
28
  finally {
30
29
  logger.debug(`Using '${type}' version of foundationZero/DesignSystem`);
31
30
  }
32
- });
31
+ };
33
32
  /**
34
33
  * Load the wp5 module federation remote versions, or fallback to code split bundled versions.
35
34
  * You would really be targeting the client's design system, components etc here. For now just targeting zero.
36
35
  */
37
- export const loadRemotes = () => __awaiter(void 0, void 0, void 0, function* () {
38
- const { registerZeroDesignSystem } = yield loadZeroDesignSystem();
36
+ export const loadRemotes = async () => {
37
+ const { registerZeroDesignSystem } = await loadZeroDesignSystem();
39
38
  return {
40
39
  ZeroDesignSystem: registerZeroDesignSystem(),
41
40
  };
42
- });
41
+ };
@@ -1,4 +1,4 @@
1
- import { __awaiter, __decorate } from "tslib";
1
+ import { __decorate } from "tslib";
2
2
  import { Auth, CredentialManager } from '@genesislcap/foundation-comms';
3
3
  import { EventEmitter } from '@genesislcap/foundation-events';
4
4
  import { FASTElement, customElement, observable, attr } from '@microsoft/fast-element';
@@ -26,6 +26,11 @@ import { DynamicTemplate as template, LoadingTemplate, MainTemplate } from './ma
26
26
  * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
27
27
  *
28
28
  * @public
29
+ *
30
+ * @fires luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.
31
+ * @fires misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.
32
+ * @fires notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.
33
+ *
29
34
  */
30
35
  let Navigation = class Navigation extends EventEmitter(FASTElement) {
31
36
  constructor() {
@@ -48,18 +53,13 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
48
53
  */
49
54
  this.showConnectionIndicator = true;
50
55
  }
51
- connectedCallback() {
52
- const _super = Object.create(null, {
53
- connectedCallback: { get: () => super.connectedCallback }
54
- });
55
- return __awaiter(this, void 0, void 0, function* () {
56
- _super.connectedCallback.call(this);
57
- logger.debug(`foundation-header is now connected to the DOM`);
58
- yield this.loadRemotes();
59
- this.userName = this.auth.loggedUserResult
60
- ? this.auth.loggedUserResult.username
61
- : 'Genesis User';
62
- });
56
+ async connectedCallback() {
57
+ super.connectedCallback();
58
+ logger.debug(`foundation-header is now connected to the DOM`);
59
+ await this.loadRemotes();
60
+ this.userName = this.auth.loggedUserResult
61
+ ? this.auth.loggedUserResult.username
62
+ : 'Genesis User';
63
63
  }
64
64
  /**
65
65
  * Load remote components
@@ -70,11 +70,9 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
70
70
  *
71
71
  * @internal
72
72
  */
73
- loadRemotes() {
74
- return __awaiter(this, void 0, void 0, function* () {
75
- const remoteComponents = yield Components.loadRemotes();
76
- this.ready = true;
77
- });
73
+ async loadRemotes() {
74
+ const remoteComponents = await Components.loadRemotes();
75
+ this.ready = true;
78
76
  }
79
77
  selectTemplate() {
80
78
  return this.ready ? MainTemplate : LoadingTemplate;
@@ -89,23 +87,21 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
89
87
  *
90
88
  * @public
91
89
  */
92
- logout() {
93
- return __awaiter(this, void 0, void 0, function* () {
94
- logger.debug('logout submission');
95
- try {
96
- const result = yield this.auth.logout();
97
- if (!result.success) {
98
- logger.error(`Couldn't log out`, result);
99
- return;
100
- }
101
- logger.debug('logged out', result);
102
- yield this.credentialManager.preventSilentAccess();
103
- this.navigateTo('/');
104
- }
105
- catch (err) {
106
- logger.error(`Error: ${err.message}`);
90
+ async logout() {
91
+ logger.debug('logout submission');
92
+ try {
93
+ const result = await this.auth.logout();
94
+ if (!result.success) {
95
+ logger.error(`Couldn't log out`, result);
96
+ return;
107
97
  }
108
- });
98
+ logger.debug('logged out', result);
99
+ await this.credentialManager.preventSilentAccess();
100
+ this.navigateTo('/');
101
+ }
102
+ catch (err) {
103
+ logger.error(`Error: ${err.message}`);
104
+ }
109
105
  }
110
106
  /**
111
107
  * Changes the route of the current page
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.70.2",
4
+ "version": "14.70.4-es2021.1",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-header.d.ts",
@@ -50,15 +50,15 @@
50
50
  "test:debug": "genx test --debug"
51
51
  },
52
52
  "devDependencies": {
53
- "@genesislcap/foundation-testing": "14.70.2",
54
- "@genesislcap/genx": "14.70.2",
53
+ "@genesislcap/foundation-testing": "14.70.4-es2021.1",
54
+ "@genesislcap/genx": "14.70.4-es2021.1",
55
55
  "rimraf": "^3.0.2"
56
56
  },
57
57
  "dependencies": {
58
- "@genesislcap/foundation-comms": "14.70.2",
59
- "@genesislcap/foundation-events": "14.70.2",
60
- "@genesislcap/foundation-utils": "14.70.2",
61
- "@genesislcap/foundation-zero": "14.70.2",
58
+ "@genesislcap/foundation-comms": "14.70.4-es2021.1",
59
+ "@genesislcap/foundation-events": "14.70.4-es2021.1",
60
+ "@genesislcap/foundation-utils": "14.70.4-es2021.1",
61
+ "@genesislcap/foundation-zero": "14.70.4-es2021.1",
62
62
  "@microsoft/fast-colors": "^5.1.4",
63
63
  "@microsoft/fast-components": "^2.21.3",
64
64
  "@microsoft/fast-element": "^1.7.0",
@@ -74,5 +74,5 @@
74
74
  "access": "public"
75
75
  },
76
76
  "customElements": "dist/custom-elements.json",
77
- "gitHead": "efc54c4f5968451219d8ab6da8a0c73cb054c2b7"
77
+ "gitHead": "5d0d8ee36cfd068cfc6211033b326d0a978cfc05"
78
78
  }
@@ -1,837 +0,0 @@
1
- {
2
- "metadata": {
3
- "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.34.9",
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#ready:member",
499
- "docComment": "",
500
- "excerptTokens": [
501
- {
502
- "kind": "Content",
503
- "text": "ready: "
504
- },
505
- {
506
- "kind": "Content",
507
- "text": "boolean"
508
- },
509
- {
510
- "kind": "Content",
511
- "text": ";"
512
- }
513
- ],
514
- "isReadonly": false,
515
- "isOptional": false,
516
- "releaseTag": "Public",
517
- "name": "ready",
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#routeButtons:member",
529
- "docComment": "/**\n * If present the defined route buttons will be rendered in the header 'routes' slot\n */\n",
530
- "excerptTokens": [
531
- {
532
- "kind": "Content",
533
- "text": "routeButtons: "
534
- },
535
- {
536
- "kind": "Reference",
537
- "text": "Array",
538
- "canonicalReference": "!Array:interface"
539
- },
540
- {
541
- "kind": "Content",
542
- "text": "<{\n index: number;\n path: string;\n title: string;\n icon: string;\n variant: string;\n }>"
543
- },
544
- {
545
- "kind": "Content",
546
- "text": ";"
547
- }
548
- ],
549
- "isReadonly": false,
550
- "isOptional": false,
551
- "releaseTag": "Public",
552
- "name": "routeButtons",
553
- "propertyTypeTokenRange": {
554
- "startIndex": 1,
555
- "endIndex": 3
556
- },
557
- "isStatic": false,
558
- "isProtected": false,
559
- "isAbstract": false
560
- },
561
- {
562
- "kind": "Method",
563
- "canonicalReference": "@genesislcap/foundation-header!Navigation#selectTemplate:member(1)",
564
- "docComment": "",
565
- "excerptTokens": [
566
- {
567
- "kind": "Content",
568
- "text": "selectTemplate(): "
569
- },
570
- {
571
- "kind": "Content",
572
- "text": "import(\"@microsoft/fast-element\")."
573
- },
574
- {
575
- "kind": "Reference",
576
- "text": "ViewTemplate",
577
- "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
578
- },
579
- {
580
- "kind": "Content",
581
- "text": "<"
582
- },
583
- {
584
- "kind": "Reference",
585
- "text": "Navigation",
586
- "canonicalReference": "@genesislcap/foundation-header!Navigation:class"
587
- },
588
- {
589
- "kind": "Content",
590
- "text": ", any>"
591
- },
592
- {
593
- "kind": "Content",
594
- "text": ";"
595
- }
596
- ],
597
- "isStatic": false,
598
- "returnTypeTokenRange": {
599
- "startIndex": 1,
600
- "endIndex": 6
601
- },
602
- "releaseTag": "Public",
603
- "isProtected": false,
604
- "overloadIndex": 1,
605
- "parameters": [],
606
- "isOptional": false,
607
- "isAbstract": false,
608
- "name": "selectTemplate"
609
- },
610
- {
611
- "kind": "Property",
612
- "canonicalReference": "@genesislcap/foundation-header!Navigation#showConnectionIndicator:member",
613
- "docComment": "/**\n * Boolean attribute which controls whether to show the connection indicator on the navigation bar Control via `show-connection-indicator`\n */\n",
614
- "excerptTokens": [
615
- {
616
- "kind": "Content",
617
- "text": "showConnectionIndicator: "
618
- },
619
- {
620
- "kind": "Content",
621
- "text": "boolean"
622
- },
623
- {
624
- "kind": "Content",
625
- "text": ";"
626
- }
627
- ],
628
- "isReadonly": false,
629
- "isOptional": false,
630
- "releaseTag": "Public",
631
- "name": "showConnectionIndicator",
632
- "propertyTypeTokenRange": {
633
- "startIndex": 1,
634
- "endIndex": 2
635
- },
636
- "isStatic": false,
637
- "isProtected": false,
638
- "isAbstract": false
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
- }
@@ -1,218 +0,0 @@
1
- import { Auth } from '@genesislcap/foundation-comms';
2
- import { Controller } from '@microsoft/fast-element';
3
- import { CredentialManager } from '@genesislcap/foundation-comms';
4
- import { ElementStyles } from '@microsoft/fast-element';
5
- import { EmitOptions } from '@genesislcap/foundation-events';
6
- import { EmitReturn } from '@genesislcap/foundation-events';
7
- import { ViewTemplate } from '@microsoft/fast-element';
8
-
9
- /**
10
- * Base styles for the foundation-header
11
- *
12
- * @returns ElementStyles instance for the foundation-header
13
- *
14
- * @public
15
- */
16
- export declare const MainStyles: ElementStyles;
17
-
18
- /**
19
- * Events dispatched by the navigation control buttons
20
- * @public
21
- */
22
- export declare type NavEventDetailMap = {
23
- 'luminance-icon-clicked': void;
24
- 'misc-icon-clicked': void;
25
- 'notification-icon-clicked': void;
26
- };
27
-
28
- /**
29
- * Navigation micro-frontend includes navigation bar and flyout menu
30
- *
31
- * @remarks
32
- *
33
- * `foundation-header` micro-frontend can be added to the project to include a navigation bar
34
- * and flyout menu. There are multiple ways that the behaviour of the component can be configured
35
- * - the icon shown on the navigation bar and flyout menu (this shows the Genesis logo by default).
36
- * - navigation links at the left-hand side of the navigation bar.
37
- * - the control buttons on the right-hand side of the navigation bar can be shown or hidden, and their behaviour controlled via event listeners
38
- * - The contents of the flyout menu.
39
- *
40
- * @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.
41
- * @param show-luminance-toggle-button - Boolean attribute which controls whether the navigation bar will display the luminance toggle icon.
42
- * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the miscellaneous behaviour icon.
43
- * @param show-misc-toggle-button - Boolean attribute which controls whether the navigation bar will display the show notification icon.
44
- *
45
- * @public
46
- */
47
- export declare class Navigation extends Navigation_base {
48
- auth: Auth;
49
- credentialManager: CredentialManager;
50
- ready: boolean;
51
- /**
52
- * Username of the logged in user
53
- */
54
- userName: string;
55
- sideNavOpen: boolean;
56
- connectedCallback(): Promise<void>;
57
- /**
58
- * Optional attribute which controls the icon to show on the navigation bar and flyout
59
- * Control via `logo-src`
60
- *
61
- * @remarks
62
- *
63
- * If this attribute is not set then the Genesis logo is shown instead
64
- */
65
- logoSrc: any;
66
- /**
67
- * Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar
68
- * Control via`show-luminance-toggle-button`
69
- *
70
- * @remarks
71
- *
72
- * If the user clicks the icon when shown then this class will emit the 'luminance-icon-clicked' event
73
- */
74
- showLuminanceToggleButton: boolean;
75
- /**
76
- * Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar
77
- * Control via `show-luminance-toggle-button`
78
- *
79
- * @remarks
80
- *
81
- * If the user clicks the icon when shown then this class will emit the 'misc-icon-clicked' event
82
- */
83
- showMiscToggleButton: boolean;
84
- /**
85
- * Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar
86
- * Control via `show-notification-button`
87
- *
88
- * @remarks
89
- *
90
- * If the user clicks the icon when shown then this class will emit the 'notification-icon-clicked' event
91
- */
92
- showNotificationsButton: boolean;
93
- /**
94
- * Boolean attribute which controls whether to show the connection indicator on the navigation bar
95
- * Control via `show-connection-indicator`
96
- *
97
- */
98
- showConnectionIndicator: boolean;
99
- /**
100
- * Boolean attribute which controls whether to include the sideNav component
101
- * Control via`hide-side-bar`
102
- *
103
- */
104
- hideSideBar: boolean;
105
- /**
106
- * If present the defined route buttons will be rendered in the header 'routes' slot
107
- */
108
- routeButtons: Array<{
109
- index: number;
110
- path: string;
111
- title: string;
112
- icon: string;
113
- variant: string;
114
- }>;
115
- /**
116
- * Load remote components
117
- *
118
- * @remarks
119
- *
120
- * With regards to module federation
121
- *
122
- * @internal
123
- */
124
- loadRemotes(): Promise<void>;
125
- selectTemplate(): ViewTemplate<Navigation, any>;
126
- /**
127
- * Logs the user out of their session
128
- *
129
- * @remarks
130
- *
131
- * Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires
132
- * the usage of the auth functionality from {@link @genesislcap/foundation-comms#Auth}.
133
- *
134
- * @public
135
- */
136
- logout(): Promise<void>;
137
- /**
138
- * Changes the route of the current page
139
- *
140
- * @remarks
141
- *
142
- * Requires setup of the Router and usage of the FAST Router
143
- *
144
- * @param path - string represeting the new route to move to
145
- *
146
- * @public
147
- */
148
- navigateTo(path: string): void;
149
- /**
150
- * Opens the flyout menu on the left hand side
151
- *
152
- * @remarks
153
- *
154
- * Activated when the user clicks on the menu button on the navigation
155
- * bar left hand side
156
- *
157
- * @internal
158
- */
159
- toggleNavVisibility(): void;
160
- /**
161
- * Emits the event corresponding to the luminance icon being clicked
162
- *
163
- * @remarks
164
- *
165
- * Activated when the user clicks on the moon icon on the navigation
166
- * bar right hand side
167
- *
168
- * @internal
169
- */
170
- luminanceIconEvent(): void;
171
- /**
172
- * Emits the event corresponding to the miscellaneous icon being clicked
173
- *
174
- * @remarks
175
- *
176
- * Activated when the user clicks on the menu icon on the navigation
177
- * bar right hand side
178
- *
179
- * @internal
180
- */
181
- miscIconEvent(): void;
182
- /**
183
- * Emits the event corresponding to the notification icon being clicked
184
- *
185
- * @remarks
186
- *
187
- * Activated when the user clicks on the bell icon on the navigation
188
- * bar right hand side
189
- *
190
- * @internal
191
- */
192
- notificationIconEvent(): void;
193
- }
194
-
195
- declare const Navigation_base: abstract new (...args: any[]) => {
196
- $emit<K extends "luminance-icon-clicked" | "misc-icon-clicked" | "notification-icon-clicked">(...args: NavEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: NavEventDetailMap[K], options?: EmitOptions]): EmitReturn;
197
- readonly $fastController: Controller;
198
- connectedCallback(): void;
199
- disconnectedCallback(): void;
200
- attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
201
- };
202
-
203
- /**
204
- * Template for Navigation class
205
- *
206
- * @remarks
207
- *
208
- * Contains the template for both the sidenav and the navigation bar
209
- *
210
- * @typeParam Navigation - Navigation class
211
- *
212
- * @returns ViewTemplate instance of the Navigation html
213
- *
214
- * @public
215
- */
216
- export declare const NavTemplate: ViewTemplate<Navigation, any>;
217
-
218
- export { }
@@ -1,11 +0,0 @@
1
- // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
- // It should be published with your NPM package. It should not be tracked by Git.
3
- {
4
- "tsdocVersion": "0.12",
5
- "toolPackages": [
6
- {
7
- "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.34.9"
9
- }
10
- ]
11
- }