@genesislcap/foundation-header 14.314.2 → 14.314.3-alpha-c442ac5.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/README.md +322 -0
- package/dist/custom-elements.json +445 -21
- package/dist/dts/main/main.d.ts +44 -0
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/esm/main/main.js +82 -0
- package/dist/foundation-header.api.json +122 -1
- package/dist/foundation-header.d.ts +44 -0
- package/docs/api/foundation-header.navigation.disconnectedcallback.md +17 -0
- package/docs/api/foundation-header.navigation.enableinactivitymonitoring.md +18 -0
- package/docs/api/foundation-header.navigation.inactivitytimeoutminutes.md +18 -0
- package/docs/api/foundation-header.navigation.inactivitywarningminutes.md +18 -0
- package/docs/api/foundation-header.navigation.md +71 -0
- package/docs/api-report.md.api.md +4 -0
- package/package.json +22 -22
package/dist/esm/main/main.js
CHANGED
|
@@ -6,6 +6,7 @@ import { I18next } from '@genesislcap/foundation-i18n';
|
|
|
6
6
|
import { LoginConfig, LoginRouting } from '@genesislcap/foundation-login';
|
|
7
7
|
import { FoundationRouteNav } from '@genesislcap/foundation-ui';
|
|
8
8
|
import { User } from '@genesislcap/foundation-user';
|
|
9
|
+
import { InactivityManager } from '@genesislcap/foundation-utils';
|
|
9
10
|
import { attr, Container, customElement, GenesisElement, observable } from '@genesislcap/web-core';
|
|
10
11
|
import logo from '../assets/logo.svg';
|
|
11
12
|
import { HeaderConfig } from '../config/config';
|
|
@@ -13,6 +14,9 @@ import { rapidTemplate } from '../templates/rapid.template';
|
|
|
13
14
|
import { logger } from '../utils';
|
|
14
15
|
import { MainStyles as styles } from './main.styles';
|
|
15
16
|
import { LoadingTemplate, mainTemplate, dynamicTemplate as template } from './main.template';
|
|
17
|
+
// Default values for inactivity monitoring
|
|
18
|
+
const DEFAULT_INACTIVITY_TIMEOUT_MINUTES = 30;
|
|
19
|
+
const DEFAULT_INACTIVITY_WARNING_MINUTES = 5;
|
|
16
20
|
/**
|
|
17
21
|
* Navigation micro-frontend includes navigation bar and flyout menu
|
|
18
22
|
*
|
|
@@ -41,6 +45,9 @@ import { LoadingTemplate, mainTemplate, dynamicTemplate as template } from './ma
|
|
|
41
45
|
* @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.
|
|
42
46
|
* @param routeNavItems - Array of {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} which define the route buttons to be displayed in the navigation bar.
|
|
43
47
|
* @param languageOptions - Object which defines the language options to be displayed in the language selector.
|
|
48
|
+
* @param inactivity-timeout-minutes - Number attribute which sets the inactivity timeout in minutes (default: 30).
|
|
49
|
+
* @param inactivity-warning-minutes - Number attribute which sets the inactivity warning time in minutes before timeout (default: 5).
|
|
50
|
+
* @param enable-inactivity-monitoring - Boolean attribute which controls whether to enable inactivity monitoring (default: true).
|
|
44
51
|
*
|
|
45
52
|
* @public
|
|
46
53
|
*
|
|
@@ -67,6 +74,35 @@ let Navigation = class Navigation extends EventEmitter(GenesisElement) {
|
|
|
67
74
|
* Flag to indicate if the sideNav is open
|
|
68
75
|
*/
|
|
69
76
|
this.sideNavOpen = false;
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
* Inactivity manager instance
|
|
80
|
+
*/
|
|
81
|
+
this.inactivityManager = null;
|
|
82
|
+
/**
|
|
83
|
+
* Number attribute which sets the inactivity timeout in minutes
|
|
84
|
+
* Control via `inactivity-timeout-minutes`
|
|
85
|
+
*
|
|
86
|
+
* @remarks
|
|
87
|
+
* Default is 30 minutes
|
|
88
|
+
*/
|
|
89
|
+
this.inactivityTimeoutMinutes = DEFAULT_INACTIVITY_TIMEOUT_MINUTES;
|
|
90
|
+
/**
|
|
91
|
+
* Number attribute which sets the inactivity warning time in minutes before timeout
|
|
92
|
+
* Control via `inactivity-warning-minutes`
|
|
93
|
+
*
|
|
94
|
+
* @remarks
|
|
95
|
+
* Default is 5 minutes
|
|
96
|
+
*/
|
|
97
|
+
this.inactivityWarningMinutes = DEFAULT_INACTIVITY_WARNING_MINUTES;
|
|
98
|
+
/**
|
|
99
|
+
* Boolean attribute which controls whether to enable inactivity monitoring
|
|
100
|
+
* Control via `enable-inactivity-monitoring`
|
|
101
|
+
*
|
|
102
|
+
* @remarks
|
|
103
|
+
* Default is true
|
|
104
|
+
*/
|
|
105
|
+
this.enableInactivityMonitoring = true;
|
|
70
106
|
/**
|
|
71
107
|
* Optional attribute which controls the icon to show on the navigation bar and flyout
|
|
72
108
|
* Control via `logo-src`
|
|
@@ -144,11 +180,48 @@ let Navigation = class Navigation extends EventEmitter(GenesisElement) {
|
|
|
144
180
|
this.setLuminance();
|
|
145
181
|
yield this.loadRemotes();
|
|
146
182
|
this.userName = (_a = this.user.userName) !== null && _a !== void 0 ? _a : 'Genesis User';
|
|
183
|
+
this.initializeInactivityManager();
|
|
147
184
|
});
|
|
148
185
|
}
|
|
149
186
|
setLuminance() {
|
|
150
187
|
localStorage.setItem('luminance', this.luminanceToggle ? 'light' : 'dark');
|
|
151
188
|
}
|
|
189
|
+
/**
|
|
190
|
+
* Initialize the inactivity manager
|
|
191
|
+
*/
|
|
192
|
+
initializeInactivityManager() {
|
|
193
|
+
// Check if inactivity monitoring is enabled
|
|
194
|
+
if (!this.enableInactivityMonitoring) {
|
|
195
|
+
logger.debug('Inactivity monitoring is disabled');
|
|
196
|
+
return;
|
|
197
|
+
}
|
|
198
|
+
this.inactivityManager = new InactivityManager({
|
|
199
|
+
timeoutMinutes: this.inactivityTimeoutMinutes,
|
|
200
|
+
warningMinutes: this.inactivityWarningMinutes,
|
|
201
|
+
onLogout: () => {
|
|
202
|
+
this.logout();
|
|
203
|
+
},
|
|
204
|
+
});
|
|
205
|
+
// Start the inactivity manager
|
|
206
|
+
this.inactivityManager.start();
|
|
207
|
+
logger.debug(`Inactivity manager initialized and started with timeout: ${this.inactivityTimeoutMinutes}min, warning: ${this.inactivityWarningMinutes}min`);
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* Clean up the inactivity manager
|
|
211
|
+
*/
|
|
212
|
+
cleanupInactivityManager() {
|
|
213
|
+
if (this.inactivityManager) {
|
|
214
|
+
this.inactivityManager.destroy();
|
|
215
|
+
this.inactivityManager = null;
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* Called when the component is disconnected from the DOM
|
|
220
|
+
*/
|
|
221
|
+
disconnectedCallback() {
|
|
222
|
+
super.disconnectedCallback();
|
|
223
|
+
this.cleanupInactivityManager();
|
|
224
|
+
}
|
|
152
225
|
/**
|
|
153
226
|
* @internal
|
|
154
227
|
*/
|
|
@@ -389,6 +462,15 @@ __decorate([
|
|
|
389
462
|
__decorate([
|
|
390
463
|
observable
|
|
391
464
|
], Navigation.prototype, "sideNavOpen", void 0);
|
|
465
|
+
__decorate([
|
|
466
|
+
attr({ attribute: 'inactivity-timeout-minutes' })
|
|
467
|
+
], Navigation.prototype, "inactivityTimeoutMinutes", void 0);
|
|
468
|
+
__decorate([
|
|
469
|
+
attr({ attribute: 'inactivity-warning-minutes' })
|
|
470
|
+
], Navigation.prototype, "inactivityWarningMinutes", void 0);
|
|
471
|
+
__decorate([
|
|
472
|
+
attr({ mode: 'boolean', attribute: 'enable-inactivity-monitoring' })
|
|
473
|
+
], Navigation.prototype, "enableInactivityMonitoring", void 0);
|
|
392
474
|
__decorate([
|
|
393
475
|
attr({ attribute: 'logo-src' })
|
|
394
476
|
], Navigation.prototype, "logoSrc", void 0);
|
|
@@ -572,7 +572,7 @@
|
|
|
572
572
|
{
|
|
573
573
|
"kind": "Class",
|
|
574
574
|
"canonicalReference": "@genesislcap/foundation-header!Navigation:class",
|
|
575
|
-
"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 logo - alt-text -Descriptive logo text.\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 notification - icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @param show - connection-indicator - Boolean attribute which controls whether the navigation bar will display the connection indicator.\n *\n * @param show - environment-indicator - Boolean attribute which controls whether the navigation bar will display the environment indicator.\n *\n * @param show - language-selector - Boolean attribute which controls whether the navigation bar will display the language selector.\n *\n * @param hide - side-bar - Boolean attribute which controls whether the navigation bar will display the side bar.\n *\n * @param show - account-menu - Boolean attribute which controls whether the navigation bar will display the account menu.\n *\n * @param logout - button-position - String attribute which controls the position of the logout button in the header.\n *\n * @param userName - String which defines the username to be displayed in the navigation bar.\n *\n * @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.\n *\n * @param routeNavItems - Array of {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} which define the route buttons to be displayed in the navigation bar.\n *\n * @param languageOptions - Object which defines the language options to be displayed in the language selector.\n *\n * @fires\n *\n * luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.\n *\n * @fires\n *\n * misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.\n *\n * @fires\n *\n * notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.\n *\n * @fires\n *\n * language-changed - Dispatched when the user changes the language in the language selector.\n *\n * @fires\n *\n * logout-clicked - Dispatched when the user clicks logout button.\n *\n * @fires\n *\n * nav-button-clicked - Dispatched when the user clicks a navigation button.\n *\n * @public\n */\n",
|
|
575
|
+
"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 logo - alt-text -Descriptive logo text.\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 notification - icon-clicked - Boolean attribute which controls whether the navigation bar will display the show notification icon.\n *\n * @param show - connection-indicator - Boolean attribute which controls whether the navigation bar will display the connection indicator.\n *\n * @param show - environment-indicator - Boolean attribute which controls whether the navigation bar will display the environment indicator.\n *\n * @param show - language-selector - Boolean attribute which controls whether the navigation bar will display the language selector.\n *\n * @param hide - side-bar - Boolean attribute which controls whether the navigation bar will display the side bar.\n *\n * @param show - account-menu - Boolean attribute which controls whether the navigation bar will display the account menu.\n *\n * @param logout - button-position - String attribute which controls the position of the logout button in the header.\n *\n * @param userName - String which defines the username to be displayed in the navigation bar.\n *\n * @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.\n *\n * @param routeNavItems - Array of {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} which define the route buttons to be displayed in the navigation bar.\n *\n * @param languageOptions - Object which defines the language options to be displayed in the language selector.\n *\n * @param inactivity - timeout-minutes - Number attribute which sets the inactivity timeout in minutes (default: 30).\n *\n * @param inactivity - warning-minutes - Number attribute which sets the inactivity warning time in minutes before timeout (default: 5).\n *\n * @param enable - inactivity-monitoring - Boolean attribute which controls whether to enable inactivity monitoring (default: true).\n *\n * @fires\n *\n * luminance-icon-clicked - Dispatched when the user clicks on the luminance toggle icon in the navigation bar.\n *\n * @fires\n *\n * misc-icon-clicked - Dispatched when the user clicks on the miscellaneous behaviour icon in the navigation bar.\n *\n * @fires\n *\n * notification-icon-clicked - Dispatched when the user clicks on the notification icon in the navigation bar.\n *\n * @fires\n *\n * language-changed - Dispatched when the user changes the language in the language selector.\n *\n * @fires\n *\n * logout-clicked - Dispatched when the user clicks logout button.\n *\n * @fires\n *\n * nav-button-clicked - Dispatched when the user clicks a navigation button.\n *\n * @public\n */\n",
|
|
576
576
|
"excerptTokens": [
|
|
577
577
|
{
|
|
578
578
|
"kind": "Content",
|
|
@@ -741,6 +741,67 @@
|
|
|
741
741
|
"isProtected": false,
|
|
742
742
|
"isAbstract": false
|
|
743
743
|
},
|
|
744
|
+
{
|
|
745
|
+
"kind": "Method",
|
|
746
|
+
"canonicalReference": "@genesislcap/foundation-header!Navigation#disconnectedCallback:member(1)",
|
|
747
|
+
"docComment": "/**\n * Called when the component is disconnected from the DOM\n */\n",
|
|
748
|
+
"excerptTokens": [
|
|
749
|
+
{
|
|
750
|
+
"kind": "Content",
|
|
751
|
+
"text": "disconnectedCallback(): "
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"kind": "Content",
|
|
755
|
+
"text": "void"
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
"kind": "Content",
|
|
759
|
+
"text": ";"
|
|
760
|
+
}
|
|
761
|
+
],
|
|
762
|
+
"isStatic": false,
|
|
763
|
+
"returnTypeTokenRange": {
|
|
764
|
+
"startIndex": 1,
|
|
765
|
+
"endIndex": 2
|
|
766
|
+
},
|
|
767
|
+
"releaseTag": "Public",
|
|
768
|
+
"isProtected": false,
|
|
769
|
+
"overloadIndex": 1,
|
|
770
|
+
"parameters": [],
|
|
771
|
+
"isOptional": false,
|
|
772
|
+
"isAbstract": false,
|
|
773
|
+
"name": "disconnectedCallback"
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"kind": "Property",
|
|
777
|
+
"canonicalReference": "@genesislcap/foundation-header!Navigation#enableInactivityMonitoring:member",
|
|
778
|
+
"docComment": "/**\n * Boolean attribute which controls whether to enable inactivity monitoring Control via `enable-inactivity-monitoring`\n *\n * @remarks\n *\n * Default is true\n */\n",
|
|
779
|
+
"excerptTokens": [
|
|
780
|
+
{
|
|
781
|
+
"kind": "Content",
|
|
782
|
+
"text": "enableInactivityMonitoring: "
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"kind": "Content",
|
|
786
|
+
"text": "boolean"
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"kind": "Content",
|
|
790
|
+
"text": ";"
|
|
791
|
+
}
|
|
792
|
+
],
|
|
793
|
+
"isReadonly": false,
|
|
794
|
+
"isOptional": false,
|
|
795
|
+
"releaseTag": "Public",
|
|
796
|
+
"name": "enableInactivityMonitoring",
|
|
797
|
+
"propertyTypeTokenRange": {
|
|
798
|
+
"startIndex": 1,
|
|
799
|
+
"endIndex": 2
|
|
800
|
+
},
|
|
801
|
+
"isStatic": false,
|
|
802
|
+
"isProtected": false,
|
|
803
|
+
"isAbstract": false
|
|
804
|
+
},
|
|
744
805
|
{
|
|
745
806
|
"kind": "Method",
|
|
746
807
|
"canonicalReference": "@genesislcap/foundation-header!Navigation#handleNavButtonClick:member(1)",
|
|
@@ -882,6 +943,66 @@
|
|
|
882
943
|
"isProtected": false,
|
|
883
944
|
"isAbstract": false
|
|
884
945
|
},
|
|
946
|
+
{
|
|
947
|
+
"kind": "Property",
|
|
948
|
+
"canonicalReference": "@genesislcap/foundation-header!Navigation#inactivityTimeoutMinutes:member",
|
|
949
|
+
"docComment": "/**\n * Number attribute which sets the inactivity timeout in minutes Control via `inactivity-timeout-minutes`\n *\n * @remarks\n *\n * Default is 30 minutes\n */\n",
|
|
950
|
+
"excerptTokens": [
|
|
951
|
+
{
|
|
952
|
+
"kind": "Content",
|
|
953
|
+
"text": "inactivityTimeoutMinutes: "
|
|
954
|
+
},
|
|
955
|
+
{
|
|
956
|
+
"kind": "Content",
|
|
957
|
+
"text": "number"
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
"kind": "Content",
|
|
961
|
+
"text": ";"
|
|
962
|
+
}
|
|
963
|
+
],
|
|
964
|
+
"isReadonly": false,
|
|
965
|
+
"isOptional": false,
|
|
966
|
+
"releaseTag": "Public",
|
|
967
|
+
"name": "inactivityTimeoutMinutes",
|
|
968
|
+
"propertyTypeTokenRange": {
|
|
969
|
+
"startIndex": 1,
|
|
970
|
+
"endIndex": 2
|
|
971
|
+
},
|
|
972
|
+
"isStatic": false,
|
|
973
|
+
"isProtected": false,
|
|
974
|
+
"isAbstract": false
|
|
975
|
+
},
|
|
976
|
+
{
|
|
977
|
+
"kind": "Property",
|
|
978
|
+
"canonicalReference": "@genesislcap/foundation-header!Navigation#inactivityWarningMinutes:member",
|
|
979
|
+
"docComment": "/**\n * Number attribute which sets the inactivity warning time in minutes before timeout Control via `inactivity-warning-minutes`\n *\n * @remarks\n *\n * Default is 5 minutes\n */\n",
|
|
980
|
+
"excerptTokens": [
|
|
981
|
+
{
|
|
982
|
+
"kind": "Content",
|
|
983
|
+
"text": "inactivityWarningMinutes: "
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"kind": "Content",
|
|
987
|
+
"text": "number"
|
|
988
|
+
},
|
|
989
|
+
{
|
|
990
|
+
"kind": "Content",
|
|
991
|
+
"text": ";"
|
|
992
|
+
}
|
|
993
|
+
],
|
|
994
|
+
"isReadonly": false,
|
|
995
|
+
"isOptional": false,
|
|
996
|
+
"releaseTag": "Public",
|
|
997
|
+
"name": "inactivityWarningMinutes",
|
|
998
|
+
"propertyTypeTokenRange": {
|
|
999
|
+
"startIndex": 1,
|
|
1000
|
+
"endIndex": 2
|
|
1001
|
+
},
|
|
1002
|
+
"isStatic": false,
|
|
1003
|
+
"isProtected": false,
|
|
1004
|
+
"isAbstract": false
|
|
1005
|
+
},
|
|
885
1006
|
{
|
|
886
1007
|
"kind": "Property",
|
|
887
1008
|
"canonicalReference": "@genesislcap/foundation-header!Navigation#languageOptions:member",
|
|
@@ -227,6 +227,9 @@ export declare type NavEventDetailMap = {
|
|
|
227
227
|
* @param routeButtons - Array of objects which define the route buttons to be displayed in the navigation bar.
|
|
228
228
|
* @param routeNavItems - Array of {@link @genesislcap/foundation-ui#FoundationRouteNavItem | FoundationRouteNavItems} which define the route buttons to be displayed in the navigation bar.
|
|
229
229
|
* @param languageOptions - Object which defines the language options to be displayed in the language selector.
|
|
230
|
+
* @param inactivity-timeout-minutes - Number attribute which sets the inactivity timeout in minutes (default: 30).
|
|
231
|
+
* @param inactivity-warning-minutes - Number attribute which sets the inactivity warning time in minutes before timeout (default: 5).
|
|
232
|
+
* @param enable-inactivity-monitoring - Boolean attribute which controls whether to enable inactivity monitoring (default: true).
|
|
230
233
|
*
|
|
231
234
|
* @public
|
|
232
235
|
*
|
|
@@ -260,11 +263,52 @@ export declare class Navigation extends Navigation_base {
|
|
|
260
263
|
* Flag to indicate if the sideNav is open
|
|
261
264
|
*/
|
|
262
265
|
sideNavOpen: boolean;
|
|
266
|
+
/**
|
|
267
|
+
* @internal
|
|
268
|
+
* Inactivity manager instance
|
|
269
|
+
*/
|
|
270
|
+
private inactivityManager;
|
|
271
|
+
/**
|
|
272
|
+
* Number attribute which sets the inactivity timeout in minutes
|
|
273
|
+
* Control via `inactivity-timeout-minutes`
|
|
274
|
+
*
|
|
275
|
+
* @remarks
|
|
276
|
+
* Default is 30 minutes
|
|
277
|
+
*/
|
|
278
|
+
inactivityTimeoutMinutes: number;
|
|
279
|
+
/**
|
|
280
|
+
* Number attribute which sets the inactivity warning time in minutes before timeout
|
|
281
|
+
* Control via `inactivity-warning-minutes`
|
|
282
|
+
*
|
|
283
|
+
* @remarks
|
|
284
|
+
* Default is 5 minutes
|
|
285
|
+
*/
|
|
286
|
+
inactivityWarningMinutes: number;
|
|
287
|
+
/**
|
|
288
|
+
* Boolean attribute which controls whether to enable inactivity monitoring
|
|
289
|
+
* Control via `enable-inactivity-monitoring`
|
|
290
|
+
*
|
|
291
|
+
* @remarks
|
|
292
|
+
* Default is true
|
|
293
|
+
*/
|
|
294
|
+
enableInactivityMonitoring: boolean;
|
|
263
295
|
/**
|
|
264
296
|
* Called when the component is connected to the DOM
|
|
265
297
|
*/
|
|
266
298
|
connectedCallback(): Promise<void>;
|
|
267
299
|
setLuminance(): void;
|
|
300
|
+
/**
|
|
301
|
+
* Initialize the inactivity manager
|
|
302
|
+
*/
|
|
303
|
+
private initializeInactivityManager;
|
|
304
|
+
/**
|
|
305
|
+
* Clean up the inactivity manager
|
|
306
|
+
*/
|
|
307
|
+
private cleanupInactivityManager;
|
|
308
|
+
/**
|
|
309
|
+
* Called when the component is disconnected from the DOM
|
|
310
|
+
*/
|
|
311
|
+
disconnectedCallback(): void;
|
|
268
312
|
/**
|
|
269
313
|
* Optional attribute which controls the icon to show on the navigation bar and flyout
|
|
270
314
|
* Control via `logo-src`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [disconnectedCallback](./foundation-header.navigation.disconnectedcallback.md)
|
|
4
|
+
|
|
5
|
+
## Navigation.disconnectedCallback() method
|
|
6
|
+
|
|
7
|
+
Called when the component is disconnected from the DOM
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
disconnectedCallback(): void;
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [enableInactivityMonitoring](./foundation-header.navigation.enableinactivitymonitoring.md)
|
|
4
|
+
|
|
5
|
+
## Navigation.enableInactivityMonitoring property
|
|
6
|
+
|
|
7
|
+
Boolean attribute which controls whether to enable inactivity monitoring Control via `enable-inactivity-monitoring`
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
enableInactivityMonitoring: boolean;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Default is true
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [inactivityTimeoutMinutes](./foundation-header.navigation.inactivitytimeoutminutes.md)
|
|
4
|
+
|
|
5
|
+
## Navigation.inactivityTimeoutMinutes property
|
|
6
|
+
|
|
7
|
+
Number attribute which sets the inactivity timeout in minutes Control via `inactivity-timeout-minutes`
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
inactivityTimeoutMinutes: number;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Default is 30 minutes
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [inactivityWarningMinutes](./foundation-header.navigation.inactivitywarningminutes.md)
|
|
4
|
+
|
|
5
|
+
## Navigation.inactivityWarningMinutes property
|
|
6
|
+
|
|
7
|
+
Number attribute which sets the inactivity warning time in minutes before timeout Control via `inactivity-warning-minutes`
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
inactivityWarningMinutes: number;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Default is 5 minutes
|
|
18
|
+
|
|
@@ -73,6 +73,25 @@ Container
|
|
|
73
73
|
</td><td>
|
|
74
74
|
|
|
75
75
|
|
|
76
|
+
</td></tr>
|
|
77
|
+
<tr><td>
|
|
78
|
+
|
|
79
|
+
[enableInactivityMonitoring](./foundation-header.navigation.enableinactivitymonitoring.md)
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
</td><td>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
</td><td>
|
|
86
|
+
|
|
87
|
+
boolean
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
</td><td>
|
|
91
|
+
|
|
92
|
+
Boolean attribute which controls whether to enable inactivity monitoring Control via `enable-inactivity-monitoring`
|
|
93
|
+
|
|
94
|
+
|
|
76
95
|
</td></tr>
|
|
77
96
|
<tr><td>
|
|
78
97
|
|
|
@@ -126,6 +145,44 @@ I18next
|
|
|
126
145
|
</td><td>
|
|
127
146
|
|
|
128
147
|
|
|
148
|
+
</td></tr>
|
|
149
|
+
<tr><td>
|
|
150
|
+
|
|
151
|
+
[inactivityTimeoutMinutes](./foundation-header.navigation.inactivitytimeoutminutes.md)
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</td><td>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</td><td>
|
|
158
|
+
|
|
159
|
+
number
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</td><td>
|
|
163
|
+
|
|
164
|
+
Number attribute which sets the inactivity timeout in minutes Control via `inactivity-timeout-minutes`
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
</td></tr>
|
|
168
|
+
<tr><td>
|
|
169
|
+
|
|
170
|
+
[inactivityWarningMinutes](./foundation-header.navigation.inactivitywarningminutes.md)
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
</td><td>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
</td><td>
|
|
177
|
+
|
|
178
|
+
number
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</td><td>
|
|
182
|
+
|
|
183
|
+
Number attribute which sets the inactivity warning time in minutes before timeout Control via `inactivity-warning-minutes`
|
|
184
|
+
|
|
185
|
+
|
|
129
186
|
</td></tr>
|
|
130
187
|
<tr><td>
|
|
131
188
|
|
|
@@ -512,6 +569,20 @@ Changes the language of the application
|
|
|
512
569
|
Called when the component is connected to the DOM
|
|
513
570
|
|
|
514
571
|
|
|
572
|
+
</td></tr>
|
|
573
|
+
<tr><td>
|
|
574
|
+
|
|
575
|
+
[disconnectedCallback()](./foundation-header.navigation.disconnectedcallback.md)
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
</td><td>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</td><td>
|
|
582
|
+
|
|
583
|
+
Called when the component is disconnected from the DOM
|
|
584
|
+
|
|
585
|
+
|
|
515
586
|
</td></tr>
|
|
516
587
|
<tr><td>
|
|
517
588
|
|
|
@@ -103,12 +103,16 @@ export class Navigation extends Navigation_base {
|
|
|
103
103
|
connectedCallback(): Promise<void>;
|
|
104
104
|
// (undocumented)
|
|
105
105
|
container: Container;
|
|
106
|
+
disconnectedCallback(): void;
|
|
107
|
+
enableInactivityMonitoring: boolean;
|
|
106
108
|
handleNavButtonClick(routeNavItem: FoundationRouteNavItem): void;
|
|
107
109
|
// (undocumented)
|
|
108
110
|
headerConfig: HeaderConfig;
|
|
109
111
|
hideSideBar: boolean;
|
|
110
112
|
// (undocumented)
|
|
111
113
|
i18next: I18next;
|
|
114
|
+
inactivityTimeoutMinutes: number;
|
|
115
|
+
inactivityWarningMinutes: number;
|
|
112
116
|
// @internal (undocumented)
|
|
113
117
|
isUserPermitted(permission: string): boolean;
|
|
114
118
|
languageOptions: LanguageOptions;
|
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.314.
|
|
4
|
+
"version": "14.314.3-alpha-c442ac5.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.314.
|
|
81
|
-
"@genesislcap/genx": "14.314.
|
|
82
|
-
"@genesislcap/rollup-builder": "14.314.
|
|
83
|
-
"@genesislcap/ts-builder": "14.314.
|
|
84
|
-
"@genesislcap/uvu-playwright-builder": "14.314.
|
|
85
|
-
"@genesislcap/vite-builder": "14.314.
|
|
86
|
-
"@genesislcap/webpack-builder": "14.314.
|
|
80
|
+
"@genesislcap/foundation-testing": "14.314.3-alpha-c442ac5.0",
|
|
81
|
+
"@genesislcap/genx": "14.314.3-alpha-c442ac5.0",
|
|
82
|
+
"@genesislcap/rollup-builder": "14.314.3-alpha-c442ac5.0",
|
|
83
|
+
"@genesislcap/ts-builder": "14.314.3-alpha-c442ac5.0",
|
|
84
|
+
"@genesislcap/uvu-playwright-builder": "14.314.3-alpha-c442ac5.0",
|
|
85
|
+
"@genesislcap/vite-builder": "14.314.3-alpha-c442ac5.0",
|
|
86
|
+
"@genesislcap/webpack-builder": "14.314.3-alpha-c442ac5.0"
|
|
87
87
|
},
|
|
88
88
|
"dependencies": {
|
|
89
|
-
"@genesislcap/foundation-auth": "14.314.
|
|
90
|
-
"@genesislcap/foundation-comms": "14.314.
|
|
91
|
-
"@genesislcap/foundation-events": "14.314.
|
|
92
|
-
"@genesislcap/foundation-i18n": "14.314.
|
|
93
|
-
"@genesislcap/foundation-logger": "14.314.
|
|
94
|
-
"@genesislcap/foundation-login": "14.314.
|
|
95
|
-
"@genesislcap/foundation-shell": "14.314.
|
|
96
|
-
"@genesislcap/foundation-ui": "14.314.
|
|
97
|
-
"@genesislcap/foundation-user": "14.314.
|
|
98
|
-
"@genesislcap/foundation-utils": "14.314.
|
|
99
|
-
"@genesislcap/foundation-zero": "14.314.
|
|
100
|
-
"@genesislcap/rapid-design-system": "14.314.
|
|
101
|
-
"@genesislcap/web-core": "14.314.
|
|
89
|
+
"@genesislcap/foundation-auth": "14.314.3-alpha-c442ac5.0",
|
|
90
|
+
"@genesislcap/foundation-comms": "14.314.3-alpha-c442ac5.0",
|
|
91
|
+
"@genesislcap/foundation-events": "14.314.3-alpha-c442ac5.0",
|
|
92
|
+
"@genesislcap/foundation-i18n": "14.314.3-alpha-c442ac5.0",
|
|
93
|
+
"@genesislcap/foundation-logger": "14.314.3-alpha-c442ac5.0",
|
|
94
|
+
"@genesislcap/foundation-login": "14.314.3-alpha-c442ac5.0",
|
|
95
|
+
"@genesislcap/foundation-shell": "14.314.3-alpha-c442ac5.0",
|
|
96
|
+
"@genesislcap/foundation-ui": "14.314.3-alpha-c442ac5.0",
|
|
97
|
+
"@genesislcap/foundation-user": "14.314.3-alpha-c442ac5.0",
|
|
98
|
+
"@genesislcap/foundation-utils": "14.314.3-alpha-c442ac5.0",
|
|
99
|
+
"@genesislcap/foundation-zero": "14.314.3-alpha-c442ac5.0",
|
|
100
|
+
"@genesislcap/rapid-design-system": "14.314.3-alpha-c442ac5.0",
|
|
101
|
+
"@genesislcap/web-core": "14.314.3-alpha-c442ac5.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": "
|
|
112
|
+
"gitHead": "44cdac4151cf2a095e8ba2a01c206882ed8f671c"
|
|
113
113
|
}
|