@genesislcap/foundation-header 14.360.1-alpha-ed37658.0 → 14.361.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.
@@ -741,6 +741,37 @@
741
741
  "isProtected": false,
742
742
  "isAbstract": false
743
743
  },
744
+ {
745
+ "kind": "Property",
746
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#controlPanel:member",
747
+ "docComment": "",
748
+ "excerptTokens": [
749
+ {
750
+ "kind": "Content",
751
+ "text": "controlPanel: "
752
+ },
753
+ {
754
+ "kind": "Reference",
755
+ "text": "ControlPanel",
756
+ "canonicalReference": "@genesislcap/foundation-header!ControlPanel:class"
757
+ },
758
+ {
759
+ "kind": "Content",
760
+ "text": ";"
761
+ }
762
+ ],
763
+ "isReadonly": false,
764
+ "isOptional": false,
765
+ "releaseTag": "Public",
766
+ "name": "controlPanel",
767
+ "propertyTypeTokenRange": {
768
+ "startIndex": 1,
769
+ "endIndex": 2
770
+ },
771
+ "isStatic": false,
772
+ "isProtected": false,
773
+ "isAbstract": false
774
+ },
744
775
  {
745
776
  "kind": "Method",
746
777
  "canonicalReference": "@genesislcap/foundation-header!Navigation#disconnectedCallback:member(1)",
@@ -1554,6 +1585,36 @@
1554
1585
  "isProtected": false,
1555
1586
  "isAbstract": false
1556
1587
  },
1588
+ {
1589
+ "kind": "Property",
1590
+ "canonicalReference": "@genesislcap/foundation-header!Navigation#showControlPanel:member",
1591
+ "docComment": "/**\n * Boolean attribute which controls whether to show the control panel toggle on the navigation bar Control via `show-control-panel`\n */\n",
1592
+ "excerptTokens": [
1593
+ {
1594
+ "kind": "Content",
1595
+ "text": "showControlPanel: "
1596
+ },
1597
+ {
1598
+ "kind": "Content",
1599
+ "text": "boolean"
1600
+ },
1601
+ {
1602
+ "kind": "Content",
1603
+ "text": ";"
1604
+ }
1605
+ ],
1606
+ "isReadonly": false,
1607
+ "isOptional": false,
1608
+ "releaseTag": "Public",
1609
+ "name": "showControlPanel",
1610
+ "propertyTypeTokenRange": {
1611
+ "startIndex": 1,
1612
+ "endIndex": 2
1613
+ },
1614
+ "isStatic": false,
1615
+ "isProtected": false,
1616
+ "isAbstract": false
1617
+ },
1557
1618
  {
1558
1619
  "kind": "Property",
1559
1620
  "canonicalReference": "@genesislcap/foundation-header!Navigation#showEnvironmentIndicator:member",
@@ -5,14 +5,16 @@ import { ElementStyles } from '@microsoft/fast-element';
5
5
  import { EmitOptions } from '@genesislcap/foundation-events';
6
6
  import { EmitReturn } from '@genesislcap/foundation-events';
7
7
  import { FoundationRouteNavItem } from '@genesislcap/foundation-ui';
8
+ import { GenesisElement } from '@genesislcap/web-core';
8
9
  import { I18next } from '@genesislcap/foundation-i18n';
9
10
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
10
11
  import { LoginRouting } from '@genesislcap/foundation-login';
12
+ import { Modal } from '@genesislcap/foundation-ui';
11
13
  import { PartialGenesisElementDefinition } from '@genesislcap/web-core';
12
14
  import { SyntheticViewTemplate } from '@genesislcap/web-core';
13
15
  import { TemplateElementDependency } from '@genesislcap/foundation-ui';
14
16
  import { User } from '@genesislcap/foundation-user';
15
- import type { ViewTemplate } from '@genesislcap/web-core';
17
+ import { ViewTemplate } from '@genesislcap/web-core';
16
18
 
17
19
  /**
18
20
  * A function that allows configuring the header micro-frontend with name and templateOptions.
@@ -39,6 +41,108 @@ import type { ViewTemplate } from '@genesislcap/web-core';
39
41
  */
40
42
  export declare function configure(config: Partial<HeaderConfig>): Promise<Navigation>;
41
43
 
44
+ /**
45
+ * control-panel
46
+ * @internal
47
+ */
48
+ export declare class ControlPanel extends GenesisElement {
49
+ /**
50
+ * @internal
51
+ */
52
+ foundationLayoutKeys: SelectableKey[];
53
+ /**
54
+ * @internal
55
+ */
56
+ gridStateKeys: SelectableKey[];
57
+ /**
58
+ * @internal
59
+ */
60
+ filterModelKeys: SelectableKey[];
61
+ /**
62
+ * @internal
63
+ */
64
+ kvStorageKeys: SelectableKey[];
65
+ /**
66
+ * @internal
67
+ */
68
+ controlPanelModal: Modal;
69
+ /**
70
+ * @internal
71
+ */
72
+ private session;
73
+ /**
74
+ * @internal
75
+ */
76
+ private kvStorage;
77
+ /**
78
+ * @internal
79
+ * Check if any foundation layouts are selected
80
+ */
81
+ get hasSelectedLayouts(): boolean;
82
+ /**
83
+ * @internal
84
+ * Check if any grid states are selected
85
+ */
86
+ get hasSelectedGridStates(): boolean;
87
+ /**
88
+ * @internal
89
+ * Check if any filter models are selected
90
+ */
91
+ get hasSelectedFilterModels(): boolean;
92
+ /**
93
+ * @internal
94
+ * Check if any KV storage items are selected
95
+ */
96
+ get hasSelectedKVStorageItems(): boolean;
97
+ connectedCallback(): void;
98
+ disconnectedCallback(): void;
99
+ private handleKeyDown;
100
+ private handleKeyDownBound;
101
+ /**
102
+ * @internal
103
+ */
104
+ showDialog(): Promise<void>;
105
+ private toggleSelection;
106
+ /**
107
+ * @internal
108
+ */
109
+ toggleLayoutSelection(key: string): void;
110
+ /**
111
+ * @internal
112
+ */
113
+ toggleGridSelection(key: string): void;
114
+ /**
115
+ * @internal
116
+ */
117
+ toggleFilterModelSelection(key: string): void;
118
+ /**
119
+ * @internal
120
+ */
121
+ toggleKVStorageSelection(key: string): void;
122
+ /**
123
+ * @internal
124
+ */
125
+ deleteSelectedLayouts(): void;
126
+ /**
127
+ * @internal
128
+ */
129
+ deleteSelectedGridStates(): void;
130
+ /**
131
+ * @internal
132
+ */
133
+ deleteSelectedFilterModels(): void;
134
+ /**
135
+ * @internal
136
+ */
137
+ deleteSelectedKVStorageItems(): Promise<void>;
138
+ private deleteKeysFromSessionStorage;
139
+ private deleteKeysFromLocalStorage;
140
+ private getKeysForSessionStorageItem;
141
+ private getKeysForStorageItem;
142
+ private getKeysForKVStorage;
143
+ private deleteKeysFromKVStorage;
144
+ }
145
+
42
146
  /**
43
147
  * Default HeaderConfig DI implementation.
44
148
  * @public
@@ -249,6 +353,7 @@ export declare class Navigation extends Navigation_base {
249
353
  loginRouting: LoginRouting;
250
354
  user: User;
251
355
  luminanceToggle: boolean;
356
+ controlPanel: ControlPanel;
252
357
  /**
253
358
  * @internal
254
359
  * Flag to indicate if the component is ready
@@ -380,6 +485,11 @@ export declare class Navigation extends Navigation_base {
380
485
  * Control via `show-environment-indicator`
381
486
  */
382
487
  showEnvironmentIndicator: boolean;
488
+ /**
489
+ * Boolean attribute which controls whether to show the control panel toggle on the navigation bar
490
+ * Control via `show-control-panel`
491
+ */
492
+ showControlPanel: boolean;
383
493
  /**
384
494
  * Boolean attribute which controls whether to show the language selector on the navigation bar
385
495
  * Control via `show-language-selector`
@@ -538,6 +648,10 @@ export declare class Navigation extends Navigation_base {
538
648
  * @internal
539
649
  */
540
650
  notificationIconEvent(): void;
651
+ /**
652
+ * @internal
653
+ */
654
+ toggleControlPanel(): void;
541
655
  /**
542
656
  * Changes the language of the application
543
657
  *
@@ -1007,6 +1121,11 @@ export declare class RapidHeader extends Navigation {
1007
1121
  selectTemplate(): ViewTemplate<Navigation>;
1008
1122
  }
1009
1123
 
1124
+ declare interface SelectableKey {
1125
+ key: string;
1126
+ selected: boolean;
1127
+ }
1128
+
1010
1129
  /**
1011
1130
  * Side nav integration targets.
1012
1131
  *
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md) &gt; [controlPanel](./foundation-header.navigation.controlpanel.md)
4
+
5
+ ## Navigation.controlPanel property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ controlPanel: ControlPanel;
11
+ ```
@@ -73,6 +73,23 @@ Container
73
73
  </td><td>
74
74
 
75
75
 
76
+ </td></tr>
77
+ <tr><td>
78
+
79
+ [controlPanel](./foundation-header.navigation.controlpanel.md)
80
+
81
+
82
+ </td><td>
83
+
84
+
85
+ </td><td>
86
+
87
+ ControlPanel
88
+
89
+
90
+ </td><td>
91
+
92
+
76
93
  </td></tr>
77
94
  <tr><td>
78
95
 
@@ -390,6 +407,25 @@ boolean
390
407
  Boolean attribute which controls whether to show the connection indicator on the navigation bar Control via `show-connection-indicator`
391
408
 
392
409
 
410
+ </td></tr>
411
+ <tr><td>
412
+
413
+ [showControlPanel](./foundation-header.navigation.showcontrolpanel.md)
414
+
415
+
416
+ </td><td>
417
+
418
+
419
+ </td><td>
420
+
421
+ boolean
422
+
423
+
424
+ </td><td>
425
+
426
+ Boolean attribute which controls whether to show the control panel toggle on the navigation bar Control via `show-control-panel`
427
+
428
+
393
429
  </td></tr>
394
430
  <tr><td>
395
431
 
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md) &gt; [showControlPanel](./foundation-header.navigation.showcontrolpanel.md)
4
+
5
+ ## Navigation.showControlPanel property
6
+
7
+ Boolean attribute which controls whether to show the control panel toggle on the navigation bar Control via `show-control-panel`
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ showControlPanel: boolean;
13
+ ```
@@ -11,18 +11,64 @@ import { ElementStyles } from '@microsoft/fast-element';
11
11
  import { EmitOptions } from '@genesislcap/foundation-events';
12
12
  import { EmitReturn } from '@genesislcap/foundation-events';
13
13
  import { FoundationRouteNavItem } from '@genesislcap/foundation-ui';
14
+ import { GenesisElement } from '@genesislcap/web-core';
14
15
  import { I18next } from '@genesislcap/foundation-i18n';
15
16
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
16
17
  import { LoginRouting } from '@genesislcap/foundation-login';
18
+ import { Modal } from '@genesislcap/foundation-ui';
17
19
  import { PartialGenesisElementDefinition } from '@genesislcap/web-core';
18
20
  import { SyntheticViewTemplate } from '@genesislcap/web-core';
19
21
  import { TemplateElementDependency } from '@genesislcap/foundation-ui';
20
22
  import { User } from '@genesislcap/foundation-user';
21
- import type { ViewTemplate } from '@genesislcap/web-core';
23
+ import { ViewTemplate } from '@genesislcap/web-core';
22
24
 
23
25
  // @public
24
26
  export function configure(config: Partial<HeaderConfig>): Promise<Navigation>;
25
27
 
28
+ // Warning: (ae-internal-missing-underscore) The name "ControlPanel" should be prefixed with an underscore because the declaration is marked as @internal
29
+ //
30
+ // @internal
31
+ export class ControlPanel extends GenesisElement {
32
+ // (undocumented)
33
+ connectedCallback(): void;
34
+ // (undocumented)
35
+ controlPanelModal: Modal;
36
+ // (undocumented)
37
+ deleteSelectedFilterModels(): void;
38
+ // (undocumented)
39
+ deleteSelectedGridStates(): void;
40
+ // (undocumented)
41
+ deleteSelectedKVStorageItems(): Promise<void>;
42
+ // (undocumented)
43
+ deleteSelectedLayouts(): void;
44
+ // (undocumented)
45
+ disconnectedCallback(): void;
46
+ // (undocumented)
47
+ filterModelKeys: SelectableKey[];
48
+ // Warning: (ae-forgotten-export) The symbol "SelectableKey" needs to be exported by the entry point index.d.ts
49
+ //
50
+ // (undocumented)
51
+ foundationLayoutKeys: SelectableKey[];
52
+ // (undocumented)
53
+ gridStateKeys: SelectableKey[];
54
+ get hasSelectedFilterModels(): boolean;
55
+ get hasSelectedGridStates(): boolean;
56
+ get hasSelectedKVStorageItems(): boolean;
57
+ get hasSelectedLayouts(): boolean;
58
+ // (undocumented)
59
+ kvStorageKeys: SelectableKey[];
60
+ // (undocumented)
61
+ showDialog(): Promise<void>;
62
+ // (undocumented)
63
+ toggleFilterModelSelection(key: string): void;
64
+ // (undocumented)
65
+ toggleGridSelection(key: string): void;
66
+ // (undocumented)
67
+ toggleKVStorageSelection(key: string): void;
68
+ // (undocumented)
69
+ toggleLayoutSelection(key: string): void;
70
+ }
71
+
26
72
  // @public
27
73
  export const defaultHeaderConfig: HeaderConfig;
28
74
 
@@ -103,6 +149,10 @@ export class Navigation extends Navigation_base {
103
149
  connectedCallback(): Promise<void>;
104
150
  // (undocumented)
105
151
  container: Container;
152
+ // Warning: (ae-incompatible-release-tags) The symbol "controlPanel" is marked as @public, but its signature references "ControlPanel" which is marked as @internal
153
+ //
154
+ // (undocumented)
155
+ controlPanel: ControlPanel;
106
156
  disconnectedCallback(): void;
107
157
  enableInactivityMonitoring: boolean;
108
158
  handleNavButtonClick(routeNavItem: FoundationRouteNavItem): void;
@@ -155,6 +205,7 @@ export class Navigation extends Navigation_base {
155
205
  get shouldShowAccountMenu(): boolean;
156
206
  showAccountMenu: boolean;
157
207
  showConnectionIndicator: boolean;
208
+ showControlPanel: boolean;
158
209
  showEnvironmentIndicator: boolean;
159
210
  showLanguageSelector: boolean;
160
211
  showLuminanceToggleButton: boolean;
@@ -165,6 +216,8 @@ export class Navigation extends Navigation_base {
165
216
  showNotificationsButtonChanged(): void;
166
217
  // @internal
167
218
  sideNavOpen: boolean;
219
+ // @internal (undocumented)
220
+ toggleControlPanel(): void;
168
221
  // @internal
169
222
  toggleNavVisibility(): void;
170
223
  toLocalisedText(text: string): string;
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.360.1-alpha-ed37658.0",
4
+ "version": "14.361.0",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-header.d.ts",
@@ -77,28 +77,28 @@
77
77
  }
78
78
  },
79
79
  "devDependencies": {
80
- "@genesislcap/foundation-testing": "14.360.1-alpha-ed37658.0",
81
- "@genesislcap/genx": "14.360.1-alpha-ed37658.0",
82
- "@genesislcap/rollup-builder": "14.360.1-alpha-ed37658.0",
83
- "@genesislcap/ts-builder": "14.360.1-alpha-ed37658.0",
84
- "@genesislcap/uvu-playwright-builder": "14.360.1-alpha-ed37658.0",
85
- "@genesislcap/vite-builder": "14.360.1-alpha-ed37658.0",
86
- "@genesislcap/webpack-builder": "14.360.1-alpha-ed37658.0"
80
+ "@genesislcap/foundation-testing": "14.361.0",
81
+ "@genesislcap/genx": "14.361.0",
82
+ "@genesislcap/rollup-builder": "14.361.0",
83
+ "@genesislcap/ts-builder": "14.361.0",
84
+ "@genesislcap/uvu-playwright-builder": "14.361.0",
85
+ "@genesislcap/vite-builder": "14.361.0",
86
+ "@genesislcap/webpack-builder": "14.361.0"
87
87
  },
88
88
  "dependencies": {
89
- "@genesislcap/foundation-auth": "14.360.1-alpha-ed37658.0",
90
- "@genesislcap/foundation-comms": "14.360.1-alpha-ed37658.0",
91
- "@genesislcap/foundation-events": "14.360.1-alpha-ed37658.0",
92
- "@genesislcap/foundation-i18n": "14.360.1-alpha-ed37658.0",
93
- "@genesislcap/foundation-logger": "14.360.1-alpha-ed37658.0",
94
- "@genesislcap/foundation-login": "14.360.1-alpha-ed37658.0",
95
- "@genesislcap/foundation-shell": "14.360.1-alpha-ed37658.0",
96
- "@genesislcap/foundation-ui": "14.360.1-alpha-ed37658.0",
97
- "@genesislcap/foundation-user": "14.360.1-alpha-ed37658.0",
98
- "@genesislcap/foundation-utils": "14.360.1-alpha-ed37658.0",
99
- "@genesislcap/foundation-zero": "14.360.1-alpha-ed37658.0",
100
- "@genesislcap/rapid-design-system": "14.360.1-alpha-ed37658.0",
101
- "@genesislcap/web-core": "14.360.1-alpha-ed37658.0"
89
+ "@genesislcap/foundation-auth": "14.361.0",
90
+ "@genesislcap/foundation-comms": "14.361.0",
91
+ "@genesislcap/foundation-events": "14.361.0",
92
+ "@genesislcap/foundation-i18n": "14.361.0",
93
+ "@genesislcap/foundation-logger": "14.361.0",
94
+ "@genesislcap/foundation-login": "14.361.0",
95
+ "@genesislcap/foundation-shell": "14.361.0",
96
+ "@genesislcap/foundation-ui": "14.361.0",
97
+ "@genesislcap/foundation-user": "14.361.0",
98
+ "@genesislcap/foundation-utils": "14.361.0",
99
+ "@genesislcap/foundation-zero": "14.361.0",
100
+ "@genesislcap/rapid-design-system": "14.361.0",
101
+ "@genesislcap/web-core": "14.361.0"
102
102
  },
103
103
  "repository": {
104
104
  "type": "git",
@@ -109,5 +109,5 @@
109
109
  "access": "public"
110
110
  },
111
111
  "customElements": "dist/custom-elements.json",
112
- "gitHead": "02f2f5b60ca8547f7bb0ddad0583b00447edde46"
112
+ "gitHead": "d90c8400d0f62376f4565db20ddd1f1d496c86a5"
113
113
  }