@itwin/appui-react 3.0.0-dev.100

package/lib/esm/appui-react/configurableui/ConfigurableUiManager.d.ts

@@ -0,0 +1,110 @@
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import { FrontstageProvider } from "../frontstage/FrontstageProvider";
+import { KeyboardShortcutProps } from "../keyboardshortcut/KeyboardShortcut";
+import { TaskPropsList } from "../workflow/Task";
+import { WorkflowProps, WorkflowPropsList } from "../workflow/Workflow";
+import { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl";
+import { ActivityTracker } from "./ActivityTracker";
+/** Ui Activity Event Args interface.
+ * @internal
+ */
+export interface UiActivityEventArgs {
+    event: Event;
+}
+/** Ui Activity Event class.
+ * @internal
+ */
+export declare class UiActivityEvent extends BeUiEvent<UiActivityEventArgs> {
+}
+/** Ui Interval Event Args interface
+ * @internal
+ */
+export interface UiIntervalEventArgs {
+    idleTimeout?: number;
+}
+/** Ui Interval Event class.
+ * @internal
+ */
+export declare class UiIntervalEvent extends BeUiEvent<UiIntervalEventArgs> {
+}
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ */
+export declare class ConfigurableUiManager {
+    private static _registeredControls;
+    private static _initialized;
+    /** @internal */
+    static readonly activityTracker: ActivityTracker;
+    /** @internal */
+    static readonly onUiActivityEvent: UiActivityEvent;
+    /** @internal */
+    static readonly onUiIntervalEvent: UiIntervalEvent;
+    /** Initializes the ConfigurableUiManager and registers core controls. */
+    static initialize(): void;
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [ToolUiProvider]($appui-react).
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     */
+    static registerControl(classId: string, constructor: ConfigurableUiControlConstructor): void;
+    /** Determines if a control has been registered based on its classId.
+     * @param classId   the class id of the control to test
+     * @returns  true if the control is registered or false if not
+     */
+    static isControlRegistered(classId: string): boolean;
+    /** Determines if a control has been registered.
+     * @internal
+     */
+    static getConstructorClassId(constructor: ConfigurableUiControlConstructor): string | undefined;
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     */
+    static unregisterControl(classId: string): void;
+    /** Creates a control registered by calling registerControl.
+     * @param classId   the class id of the control to create
+     * @param uniqueId  a unique id for the control
+     * @param options   options passed to the constructor of the control
+     * @param controlId controlId which may not be unique across all control instances.
+     * @returns  the created control
+     */
+    static createControl(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
+    /** Add a Frontstage via a provider into the [[FrontstageManager]].
+     * @param frontstageProvider  Provider of the Frontstage to add
+     */
+    static addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Loads one or more Tasks into the [[TaskManager]].
+     * @param taskPropsList  the list of Tasks to load
+     * @internal
+     * @deprecated
+     */
+    static loadTasks(taskPropsList: TaskPropsList): void;
+    /** Loads a Workflow into the [[WorkflowManager]].
+     * @param workflowProps  the Workflow to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflow(workflowProps: WorkflowProps): void;
+    /** Loads one or more Workflows into the [[WorkflowManager]].
+     * @param workflowPropsList  the list of Workflows to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflows(workflowPropsList: WorkflowPropsList): void;
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     */
+    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement(): HTMLElement;
+    /** Closes all UI popups currently open */
+    static closeUi(): void;
+}
+//# sourceMappingURL=ConfigurableUiManager.d.ts.map

package/lib/esm/appui-react/configurableui/ConfigurableUiManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAA2B,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAOtG,OAAO,EAAe,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAmB,aAAa,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzF,OAAO,EAA0B,gCAAgC,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAK1H,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,KAAK,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS,CAAC,mBAAmB,CAAC;CAAI;AAEvE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,SAAS,CAAC,mBAAmB,CAAC;CAAI;AAEvE;;GAEG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAuD;IACzF,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IAEpC,gBAAgB;IAChB,gBAAuB,eAAe,kBAAyB;IAC/D,gBAAgB;IAChB,gBAAuB,iBAAiB,kBAAyB;IACjE,gBAAgB;IAChB,gBAAuB,iBAAiB,kBAAyB;IAEjE,yEAAyE;WAC3D,UAAU;IA4BxB;;;;;;;;;OASG;WACW,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,gCAAgC,GAAG,IAAI;IAQnG;;;OAGG;WACW,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAK3D;;OAEG;WACW,qBAAqB,CAAC,WAAW,EAAE,gCAAgC,GAAG,MAAM,GAAG,SAAS;IAStG;;OAEG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMtD;;;;;;OAMG;WACW,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAWpI;;OAEG;WACW,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI;IAIjF;;;;OAIG;WACW,SAAS,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI3D;;;;OAIG;WACW,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI9D;;;;OAIG;WACW,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI;IAIvE;;OAEG;WACW,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAIhF,wDAAwD;WAC1C,iBAAiB,IAAI,WAAW;IAM9C,0CAA0C;WAC5B,OAAO,IAAI,IAAI;CAS9B"}

package/lib/esm/appui-react/configurableui/ConfigurableUiManager.js

@@ -0,0 +1,180 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+import { UiError } from "@itwin/appui-abstract";
+import { FrontstageManager } from "../frontstage/FrontstageManager";
+import { KeyboardShortcutManager } from "../keyboardshortcut/KeyboardShortcut";
+import { CubeNavigationAidControl } from "../navigationaids/CubeNavigationAidControl";
+import { DrawingNavigationAidControl } from "../navigationaids/DrawingNavigationAidControl";
+import { SheetNavigationAidControl } from "../navigationaids/SheetNavigationAid";
+import { StandardRotationNavigationAidControl } from "../navigationaids/StandardRotationNavigationAid";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../UiFramework";
+import { TaskManager } from "../workflow/Task";
+import { WorkflowManager } from "../workflow/Workflow";
+import { ToolSettingsManager } from "../zones/toolsettings/ToolSettingsManager";
+import { ConfigurableCreateInfo } from "./ConfigurableUiControl";
+import { ModelessDialogManager } from "../dialog/ModelessDialogManager";
+import { ModalDialogManager } from "../dialog/ModalDialogManager";
+import { MessageManager } from "../messages/MessageManager";
+import { PopupManager } from "../popup/PopupManager";
+import { ActivityTracker } from "./ActivityTracker";
+/** Ui Activity Event class.
+ * @internal
+ */
+export class UiActivityEvent extends BeUiEvent {
+}
+/** Ui Interval Event class.
+ * @internal
+ */
+export class UiIntervalEvent extends BeUiEvent {
+}
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @public
+ */
+export class ConfigurableUiManager {
+    /** Initializes the ConfigurableUiManager and registers core controls. */
+    static initialize() {
+        if (this._initialized)
+            return;
+        // Register core controls
+        ConfigurableUiManager.registerControl(StandardRotationNavigationAidControl.navigationAidId, StandardRotationNavigationAidControl);
+        ConfigurableUiManager.registerControl(SheetNavigationAidControl.navigationAidId, SheetNavigationAidControl);
+        ConfigurableUiManager.registerControl(DrawingNavigationAidControl.navigationAidId, DrawingNavigationAidControl);
+        ConfigurableUiManager.registerControl(CubeNavigationAidControl.navigationAidId, CubeNavigationAidControl);
+        // Initialize SyncUiEventDispatcher so it can register event callbacks.
+        SyncUiEventDispatcher.initialize();
+        // Initialize the FrontstageManager
+        FrontstageManager.initialize();
+        // Initialize the ToolSettingsManager that manages Tool Settings properties.
+        ToolSettingsManager.initialize();
+        // Initialize the modeless dialog manager.
+        ModelessDialogManager.initialize();
+        // Initialize the Keyboard Shortcut manager
+        KeyboardShortcutManager.initialize();
+        this._initialized = true;
+    }
+    /** Registers a control implementing the [[ConfigurableUiElement]] interface.
+     * These controls can be a
+     * [[ContentControl]],
+     * [[NavigationAidControl]],
+     * [[StatusBarWidgetControl]],
+     * [[WidgetControl]] or
+     * [ToolUiProvider]($appui-react).
+     * @param classId the class id of the control to register
+     * @param constructor the constructor of the control to register
+     */
+    static registerControl(classId, constructor) {
+        if (this._registeredControls.get(classId) !== undefined) {
+            throw new UiError(UiFramework.loggerCategory(this), `registerControl: classId '${classId}' already registered`);
+        }
+        this._registeredControls.set(classId, constructor);
+    }
+    /** Determines if a control has been registered based on its classId.
+     * @param classId   the class id of the control to test
+     * @returns  true if the control is registered or false if not
+     */
+    static isControlRegistered(classId) {
+        const constructor = this._registeredControls.get(classId);
+        return constructor !== undefined;
+    }
+    /** Determines if a control has been registered.
+     * @internal
+     */
+    static getConstructorClassId(constructor) {
+        for (const [key, value] of this._registeredControls.entries()) {
+            if (value === constructor)
+                return key;
+        }
+        return undefined;
+    }
+    /** Unregisters a control that has been registered.
+     * @param classId   the class id of the control to unregister
+     */
+    static unregisterControl(classId) {
+        const constructor = this._registeredControls.get(classId);
+        if (constructor)
+            this._registeredControls.delete(classId);
+    }
+    /** Creates a control registered by calling registerControl.
+     * @param classId   the class id of the control to create
+     * @param uniqueId  a unique id for the control
+     * @param options   options passed to the constructor of the control
+     * @param controlId controlId which may not be unique across all control instances.
+     * @returns  the created control
+     */
+    static createControl(classId, uniqueId, options, controlId) {
+        const info = new ConfigurableCreateInfo(classId, uniqueId, controlId !== null && controlId !== void 0 ? controlId : uniqueId);
+        const constructor = this._registeredControls.get(info.classId);
+        if (!constructor) {
+            throw new UiError(UiFramework.loggerCategory(this), `createControl: classId '${classId}' not registered`);
+        }
+        const control = new constructor(info, options);
+        return control;
+    }
+    /** Add a Frontstage via a provider into the [[FrontstageManager]].
+     * @param frontstageProvider  Provider of the Frontstage to add
+     */
+    static addFrontstageProvider(frontstageProvider) {
+        FrontstageManager.addFrontstageProvider(frontstageProvider);
+    }
+    /** Loads one or more Tasks into the [[TaskManager]].
+     * @param taskPropsList  the list of Tasks to load
+     * @internal
+     * @deprecated
+     */
+    static loadTasks(taskPropsList) {
+        TaskManager.loadTasks(taskPropsList); // eslint-disable-line deprecation/deprecation
+    }
+    /** Loads a Workflow into the [[WorkflowManager]].
+     * @param workflowProps  the Workflow to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflow(workflowProps) {
+        WorkflowManager.loadWorkflow(workflowProps); // eslint-disable-line deprecation/deprecation
+    }
+    /** Loads one or more Workflows into the [[WorkflowManager]].
+     * @param workflowPropsList  the list of Workflows to load
+     * @internal
+     * @deprecated
+     */
+    static loadWorkflows(workflowPropsList) {
+        WorkflowManager.loadWorkflows(workflowPropsList); // eslint-disable-line deprecation/deprecation
+    }
+    /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].
+     * @param shortcutList  the properties of the Keyboard Shortcuts to load
+     */
+    static loadKeyboardShortcuts(shortcutList) {
+        KeyboardShortcutManager.loadKeyboardShortcuts(shortcutList);
+    }
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement() {
+        const wrapper = document.getElementById("uifw-configurableui-wrapper");
+        const htmlElement = wrapper;
+        return htmlElement;
+    }
+    /** Closes all UI popups currently open */
+    static closeUi() {
+        MessageManager.closeAllMessages();
+        ModelessDialogManager.closeAll();
+        ModalDialogManager.closeAll();
+        KeyboardShortcutManager.closeShortcutsMenu();
+        UiFramework.closeCursorMenu();
+        PopupManager.clearPopups();
+    }
+}
+ConfigurableUiManager._registeredControls = new Map();
+ConfigurableUiManager._initialized = false;
+/** @internal */
+ConfigurableUiManager.activityTracker = new ActivityTracker();
+/** @internal */
+ConfigurableUiManager.onUiActivityEvent = new UiActivityEvent();
+/** @internal */
+ConfigurableUiManager.onUiIntervalEvent = new UiIntervalEvent();
+//# sourceMappingURL=ConfigurableUiManager.js.map

package/lib/esm/appui-react/configurableui/ConfigurableUiManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableUiManager.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/ConfigurableUiManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEpE,OAAO,EAAE,uBAAuB,EAAyB,MAAM,sCAAsC,CAAC;AACtG,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AAC5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,oCAAoC,EAAE,MAAM,iDAAiD,CAAC;AACvG,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAiB,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAoC,MAAM,sBAAsB,CAAC;AACzF,OAAO,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AAChF,OAAO,EAAE,sBAAsB,EAA2D,MAAM,yBAAyB,CAAC;AAC1H,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AASpD;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAA8B;CAAI;AASvE;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAA8B;CAAI;AAEvE;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAWhC,yEAAyE;IAClE,MAAM,CAAC,UAAU;QACtB,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,yBAAyB;QACzB,qBAAqB,CAAC,eAAe,CAAC,oCAAoC,CAAC,eAAe,EAAE,oCAAoC,CAAC,CAAC;QAClI,qBAAqB,CAAC,eAAe,CAAC,yBAAyB,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAC;QAC5G,qBAAqB,CAAC,eAAe,CAAC,2BAA2B,CAAC,eAAe,EAAE,2BAA2B,CAAC,CAAC;QAChH,qBAAqB,CAAC,eAAe,CAAC,wBAAwB,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC;QAE1G,uEAAuE;QACvE,qBAAqB,CAAC,UAAU,EAAE,CAAC;QAEnC,mCAAmC;QACnC,iBAAiB,CAAC,UAAU,EAAE,CAAC;QAE/B,4EAA4E;QAC5E,mBAAmB,CAAC,UAAU,EAAE,CAAC;QAEjC,0CAA0C;QAC1C,qBAAqB,CAAC,UAAU,EAAE,CAAC;QAEnC,2CAA2C;QAC3C,uBAAuB,CAAC,UAAU,EAAE,CAAC;QAErC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe,CAAC,OAAe,EAAE,WAA6C;QAC1F,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;YACvD,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6BAA6B,OAAO,sBAAsB,CAAC,CAAC;SACjH;QAED,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,mBAAmB,CAAC,OAAe;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,WAAW,KAAK,SAAS,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,WAA6C;QAC/E,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE;YAC7D,IAAI,KAAK,KAAK,WAAW;gBACvB,OAAO,GAAG,CAAC;SACd;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe;QAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,WAAW;YACb,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,OAAe,EAAE,QAAgB,EAAE,OAAa,EAAE,SAAkB;QAC9F,MAAM,IAAI,GAAG,IAAI,sBAAsB,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,QAAQ,CAAC,CAAC;QAClF,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,2BAA2B,OAAO,kBAAkB,CAAC,CAAC;SAC3G;QAED,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,kBAAsC;QACxE,iBAAiB,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,aAA4B;QAClD,WAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAG,8CAA8C;IACxF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,aAA4B;QACrD,eAAe,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAI,8CAA8C;IAChG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,iBAAoC;QAC9D,eAAe,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAG,8CAA8C;IACpG,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB,CAAC,YAAqC;QACvE,uBAAuB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,iBAAiB;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,OAAQ,CAAC;QAC7B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,OAAO;QACnB,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAClC,qBAAqB,CAAC,QAAQ,EAAE,CAAC;QACjC,kBAAkB,CAAC,QAAQ,EAAE,CAAC;QAC9B,uBAAuB,CAAC,kBAAkB,EAAE,CAAC;QAC7C,WAAW,CAAC,eAAe,EAAE,CAAC;QAC9B,YAAY,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;;AAjKc,yCAAmB,GAAG,IAAI,GAAG,EAA4C,CAAC;AAC1E,kCAAY,GAAG,KAAK,CAAC;AAEpC,gBAAgB;AACO,qCAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAC/D,gBAAgB;AACO,uCAAiB,GAAG,IAAI,eAAe,EAAE,CAAC;AACjE,gBAAgB;AACO,uCAAiB,GAAG,IAAI,eAAe,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ConfigurableUi\r\n */\r\n\r\nimport { BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { UiError } from \"@itwin/appui-abstract\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\r\nimport { KeyboardShortcutManager, KeyboardShortcutProps } from \"../keyboardshortcut/KeyboardShortcut\";\r\nimport { CubeNavigationAidControl } from \"../navigationaids/CubeNavigationAidControl\";\r\nimport { DrawingNavigationAidControl } from \"../navigationaids/DrawingNavigationAidControl\";\r\nimport { SheetNavigationAidControl } from \"../navigationaids/SheetNavigationAid\";\r\nimport { StandardRotationNavigationAidControl } from \"../navigationaids/StandardRotationNavigationAid\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { TaskManager, TaskPropsList } from \"../workflow/Task\";\r\nimport { WorkflowManager, WorkflowProps, WorkflowPropsList } from \"../workflow/Workflow\";\r\nimport { ToolSettingsManager } from \"../zones/toolsettings/ToolSettingsManager\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlConstructor, ConfigurableUiElement } from \"./ConfigurableUiControl\";\r\nimport { ModelessDialogManager } from \"../dialog/ModelessDialogManager\";\r\nimport { ModalDialogManager } from \"../dialog/ModalDialogManager\";\r\nimport { MessageManager } from \"../messages/MessageManager\";\r\nimport { PopupManager } from \"../popup/PopupManager\";\r\nimport { ActivityTracker } from \"./ActivityTracker\";\r\n\r\n/** Ui Activity Event Args interface.\r\n * @internal\r\n */\r\nexport interface UiActivityEventArgs {\r\n  event: Event;\r\n}\r\n\r\n/** Ui Activity Event class.\r\n * @internal\r\n */\r\nexport class UiActivityEvent extends BeUiEvent<UiActivityEventArgs> { }\r\n\r\n/** Ui Interval Event Args interface\r\n * @internal\r\n */\r\nexport interface UiIntervalEventArgs {\r\n  idleTimeout?: number;\r\n}\r\n\r\n/** Ui Interval Event class.\r\n * @internal\r\n */\r\nexport class UiIntervalEvent extends BeUiEvent<UiIntervalEventArgs> { }\r\n\r\n/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.\r\n * @public\r\n */\r\nexport class ConfigurableUiManager {\r\n  private static _registeredControls = new Map<string, ConfigurableUiControlConstructor>();\r\n  private static _initialized = false;\r\n\r\n  /** @internal */\r\n  public static readonly activityTracker = new ActivityTracker();\r\n  /** @internal */\r\n  public static readonly onUiActivityEvent = new UiActivityEvent();\r\n  /** @internal */\r\n  public static readonly onUiIntervalEvent = new UiIntervalEvent();\r\n\r\n  /** Initializes the ConfigurableUiManager and registers core controls. */\r\n  public static initialize() {\r\n    if (this._initialized)\r\n      return;\r\n\r\n    // Register core controls\r\n    ConfigurableUiManager.registerControl(StandardRotationNavigationAidControl.navigationAidId, StandardRotationNavigationAidControl);\r\n    ConfigurableUiManager.registerControl(SheetNavigationAidControl.navigationAidId, SheetNavigationAidControl);\r\n    ConfigurableUiManager.registerControl(DrawingNavigationAidControl.navigationAidId, DrawingNavigationAidControl);\r\n    ConfigurableUiManager.registerControl(CubeNavigationAidControl.navigationAidId, CubeNavigationAidControl);\r\n\r\n    // Initialize SyncUiEventDispatcher so it can register event callbacks.\r\n    SyncUiEventDispatcher.initialize();\r\n\r\n    // Initialize the FrontstageManager\r\n    FrontstageManager.initialize();\r\n\r\n    // Initialize the ToolSettingsManager that manages Tool Settings properties.\r\n    ToolSettingsManager.initialize();\r\n\r\n    // Initialize the modeless dialog manager.\r\n    ModelessDialogManager.initialize();\r\n\r\n    // Initialize the Keyboard Shortcut manager\r\n    KeyboardShortcutManager.initialize();\r\n\r\n    this._initialized = true;\r\n  }\r\n\r\n  /** Registers a control implementing the [[ConfigurableUiElement]] interface.\r\n   * These controls can be a\r\n   * [[ContentControl]],\r\n   * [[NavigationAidControl]],\r\n   * [[StatusBarWidgetControl]],\r\n   * [[WidgetControl]] or\r\n   * [ToolUiProvider]($appui-react).\r\n   * @param classId the class id of the control to register\r\n   * @param constructor the constructor of the control to register\r\n   */\r\n  public static registerControl(classId: string, constructor: ConfigurableUiControlConstructor): void {\r\n    if (this._registeredControls.get(classId) !== undefined) {\r\n      throw new UiError(UiFramework.loggerCategory(this), `registerControl: classId '${classId}' already registered`);\r\n    }\r\n\r\n    this._registeredControls.set(classId, constructor);\r\n  }\r\n\r\n  /** Determines if a control has been registered based on its classId.\r\n   * @param classId   the class id of the control to test\r\n   * @returns  true if the control is registered or false if not\r\n   */\r\n  public static isControlRegistered(classId: string): boolean {\r\n    const constructor = this._registeredControls.get(classId);\r\n    return constructor !== undefined;\r\n  }\r\n\r\n  /** Determines if a control has been registered.\r\n   * @internal\r\n   */\r\n  public static getConstructorClassId(constructor: ConfigurableUiControlConstructor): string | undefined {\r\n    for (const [key, value] of this._registeredControls.entries()) {\r\n      if (value === constructor)\r\n        return key;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Unregisters a control that has been registered.\r\n   * @param classId   the class id of the control to unregister\r\n   */\r\n  public static unregisterControl(classId: string): void {\r\n    const constructor = this._registeredControls.get(classId);\r\n    if (constructor)\r\n      this._registeredControls.delete(classId);\r\n  }\r\n\r\n  /** Creates a control registered by calling registerControl.\r\n   * @param classId   the class id of the control to create\r\n   * @param uniqueId  a unique id for the control\r\n   * @param options   options passed to the constructor of the control\r\n   * @param controlId controlId which may not be unique across all control instances.\r\n   * @returns  the created control\r\n   */\r\n  public static createControl(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined {\r\n    const info = new ConfigurableCreateInfo(classId, uniqueId, controlId ?? uniqueId);\r\n    const constructor = this._registeredControls.get(info.classId);\r\n    if (!constructor) {\r\n      throw new UiError(UiFramework.loggerCategory(this), `createControl: classId '${classId}' not registered`);\r\n    }\r\n\r\n    const control = new constructor(info, options);\r\n    return control;\r\n  }\r\n\r\n  /** Add a Frontstage via a provider into the [[FrontstageManager]].\r\n   * @param frontstageProvider  Provider of the Frontstage to add\r\n   */\r\n  public static addFrontstageProvider(frontstageProvider: FrontstageProvider): void {\r\n    FrontstageManager.addFrontstageProvider(frontstageProvider);\r\n  }\r\n\r\n  /** Loads one or more Tasks into the [[TaskManager]].\r\n   * @param taskPropsList  the list of Tasks to load\r\n   * @internal\r\n   * @deprecated\r\n   */\r\n  public static loadTasks(taskPropsList: TaskPropsList): void {   // eslint-disable-line deprecation/deprecation\r\n    TaskManager.loadTasks(taskPropsList);   // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Loads a Workflow into the [[WorkflowManager]].\r\n   * @param workflowProps  the Workflow to load\r\n   * @internal\r\n   * @deprecated\r\n   */\r\n  public static loadWorkflow(workflowProps: WorkflowProps): void {    // eslint-disable-line deprecation/deprecation\r\n    WorkflowManager.loadWorkflow(workflowProps);    // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Loads one or more Workflows into the [[WorkflowManager]].\r\n   * @param workflowPropsList  the list of Workflows to load\r\n   * @internal\r\n   * @deprecated\r\n   */\r\n  public static loadWorkflows(workflowPropsList: WorkflowPropsList): void {   // eslint-disable-line deprecation/deprecation\r\n    WorkflowManager.loadWorkflows(workflowPropsList);   // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  /** Loads one or more Keyboard Shortcuts into the [[KeyboardShortcutManager]].\r\n   * @param shortcutList  the properties of the Keyboard Shortcuts to load\r\n   */\r\n  public static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void {\r\n    KeyboardShortcutManager.loadKeyboardShortcuts(shortcutList);\r\n  }\r\n\r\n  /** Gets the HTML wrapper element for Configurable UI */\r\n  public static getWrapperElement(): HTMLElement {\r\n    const wrapper = document.getElementById(\"uifw-configurableui-wrapper\");\r\n    const htmlElement = wrapper!;\r\n    return htmlElement;\r\n  }\r\n\r\n  /** Closes all UI popups currently open */\r\n  public static closeUi(): void {\r\n    MessageManager.closeAllMessages();\r\n    ModelessDialogManager.closeAll();\r\n    ModalDialogManager.closeAll();\r\n    KeyboardShortcutManager.closeShortcutsMenu();\r\n    UiFramework.closeCursorMenu();\r\n    PopupManager.clearPopups();\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-react/configurableui/TimeTracker.d.ts

@@ -0,0 +1,34 @@
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+/** Time Tracker utility class
+ * @internal
+ */
+export declare class TimeTracker {
+    private _firstActiveTimestamp;
+    private _idleStartTimestamp;
+    private _lastActiveTimestamp;
+    private _totalIdleTime;
+    private _idleCount;
+    private _idleTimeout;
+    private _totalTime;
+    private _idleTime;
+    /** Starts time tracking
+     */
+    startTiming(): void;
+    /** Stops time tracking
+     */
+    stopTiming(): void;
+    /** Gets engagement time in seconds
+     */
+    getEngagementTimeSeconds(): number;
+    /** Gets total time in seconds
+     */
+    getTotalTimeSeconds(): number;
+    /** Gets idle time in seconds
+     */
+    getIdleTimeSeconds(): number;
+    private _idleTimeCounter;
+    private _trackActivity;
+}
+//# sourceMappingURL=TimeTracker.d.ts.map

package/lib/esm/appui-react/configurableui/TimeTracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeTracker.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/TimeTracker.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,qBAAqB,CAAa;IAC1C,OAAO,CAAC,mBAAmB,CAAa;IACxC,OAAO,CAAC,oBAAoB,CAAa;IACzC,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,SAAS,CAAa;IAE9B;OACG;IACI,WAAW,IAAI,IAAI;IAc1B;OACG;IACI,UAAU,IAAI,IAAI;IAQzB;OACG;IACI,wBAAwB,IAAI,MAAM;IAIzC;OACG;IACI,mBAAmB,IAAI,MAAM;IAIpC;OACG;IACI,kBAAkB,IAAI,MAAM;IAInC,OAAO,CAAC,gBAAgB,CAQtB;IAEF,OAAO,CAAC,cAAc,CAQpB;CACH"}

package/lib/esm/appui-react/configurableui/TimeTracker.js

@@ -0,0 +1,78 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import { ConfigurableUiManager } from "./ConfigurableUiManager";
+/** Time Tracker utility class
+ * @internal
+ */
+export class TimeTracker {
+    constructor() {
+        this._firstActiveTimestamp = 0;
+        this._idleStartTimestamp = 0;
+        this._lastActiveTimestamp = 0;
+        this._totalIdleTime = 0;
+        this._idleCount = 0;
+        this._idleTimeout = 5000;
+        this._totalTime = 0;
+        this._idleTime = 0;
+        this._idleTimeCounter = (args) => {
+            var _a;
+            // istanbul ignore next
+            const idleTimeout = (_a = args.idleTimeout) !== null && _a !== void 0 ? _a : this._idleTimeout;
+            // istanbul ignore else
+            if (this._lastActiveTimestamp > 0 && this._idleStartTimestamp === 0 && Date.now() - this._lastActiveTimestamp >= idleTimeout) {
+                this._idleStartTimestamp = Date.now();
+                this._idleCount++;
+            }
+        };
+        this._trackActivity = (_args) => {
+            this._lastActiveTimestamp = Date.now();
+            if (this._idleStartTimestamp > 0) {
+                const lastIdleTime = this._lastActiveTimestamp - this._idleStartTimestamp;
+                this._totalIdleTime += lastIdleTime;
+                this._idleStartTimestamp = 0;
+            }
+        };
+    }
+    /** Starts time tracking
+     */
+    startTiming() {
+        this._totalIdleTime = 0;
+        this._idleStartTimestamp = 0;
+        this._idleCount = 0;
+        this._totalTime = 0;
+        this._idleTime = 0;
+        this._firstActiveTimestamp = Date.now();
+        this._lastActiveTimestamp = this._firstActiveTimestamp;
+        ConfigurableUiManager.onUiIntervalEvent.addListener(this._idleTimeCounter);
+        ConfigurableUiManager.onUiActivityEvent.addListener(this._trackActivity);
+    }
+    /** Stops time tracking
+     */
+    stopTiming() {
+        ConfigurableUiManager.onUiIntervalEvent.removeListener(this._idleTimeCounter);
+        ConfigurableUiManager.onUiActivityEvent.removeListener(this._trackActivity);
+        this._totalTime = Date.now() - this._firstActiveTimestamp;
+        this._idleTime = this._totalIdleTime + this._idleCount * this._idleTimeout;
+    }
+    /** Gets engagement time in seconds
+     */
+    getEngagementTimeSeconds() {
+        return (this._totalTime - this._idleTime) / 1000;
+    }
+    /** Gets total time in seconds
+     */
+    getTotalTimeSeconds() {
+        return this._totalTime / 1000;
+    }
+    /** Gets idle time in seconds
+     */
+    getIdleTimeSeconds() {
+        return this._idleTime / 1000;
+    }
+}
+//# sourceMappingURL=TimeTracker.js.map

package/lib/esm/appui-react/configurableui/TimeTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeTracker.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/TimeTracker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAA4C,MAAM,yBAAyB,CAAC;AAE1G;;GAEG;AACH,MAAM,OAAO,WAAW;IAAxB;QACU,0BAAqB,GAAW,CAAC,CAAC;QAClC,wBAAmB,GAAW,CAAC,CAAC;QAChC,yBAAoB,GAAW,CAAC,CAAC;QACjC,mBAAc,GAAW,CAAC,CAAC;QAC3B,eAAU,GAAW,CAAC,CAAC;QACvB,iBAAY,GAAW,IAAI,CAAC;QAC5B,eAAU,GAAW,CAAC,CAAC;QACvB,cAAS,GAAW,CAAC,CAAC;QA8CtB,qBAAgB,GAAG,CAAC,IAAyB,EAAQ,EAAE;;YAC7D,uBAAuB;YACvB,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,WAAW,mCAAI,IAAI,CAAC,YAAY,CAAC;YAC1D,uBAAuB;YACvB,IAAI,IAAI,CAAC,oBAAoB,GAAG,CAAC,IAAI,IAAI,CAAC,mBAAmB,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,oBAAoB,IAAI,WAAW,EAAE;gBAC5H,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACtC,IAAI,CAAC,UAAU,EAAE,CAAC;aACnB;QACH,CAAC,CAAC;QAEM,mBAAc,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAC5D,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvC,IAAI,IAAI,CAAC,mBAAmB,GAAG,CAAC,EAAE;gBAChC,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,mBAAmB,CAAC;gBAC1E,IAAI,CAAC,cAAc,IAAI,YAAY,CAAC;gBACpC,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;aAC9B;QACH,CAAC,CAAC;IACJ,CAAC;IA/DC;OACG;IACI,WAAW;QAChB,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QAEnB,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAEvD,qBAAqB,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3E,qBAAqB,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3E,CAAC;IAED;OACG;IACI,UAAU;QACf,qBAAqB,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9E,qBAAqB,CAAC,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE5E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC;IAC7E,CAAC;IAED;OACG;IACI,wBAAwB;QAC7B,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IACnD,CAAC;IAED;OACG;IACI,mBAAmB;QACxB,OAAO,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAChC,CAAC;IAED;OACG;IACI,kBAAkB;QACvB,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC/B,CAAC;CAqBF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ConfigurableUi\r\n */\r\n\r\nimport { ConfigurableUiManager, UiActivityEventArgs, UiIntervalEventArgs } from \"./ConfigurableUiManager\";\r\n\r\n/** Time Tracker utility class\r\n * @internal\r\n */\r\nexport class TimeTracker {\r\n  private _firstActiveTimestamp: number = 0;\r\n  private _idleStartTimestamp: number = 0;\r\n  private _lastActiveTimestamp: number = 0;\r\n  private _totalIdleTime: number = 0;\r\n  private _idleCount: number = 0;\r\n  private _idleTimeout: number = 5000;\r\n  private _totalTime: number = 0;\r\n  private _idleTime: number = 0;\r\n\r\n  /** Starts time tracking\r\n   */\r\n  public startTiming(): void {\r\n    this._totalIdleTime = 0;\r\n    this._idleStartTimestamp = 0;\r\n    this._idleCount = 0;\r\n    this._totalTime = 0;\r\n    this._idleTime = 0;\r\n\r\n    this._firstActiveTimestamp = Date.now();\r\n    this._lastActiveTimestamp = this._firstActiveTimestamp;\r\n\r\n    ConfigurableUiManager.onUiIntervalEvent.addListener(this._idleTimeCounter);\r\n    ConfigurableUiManager.onUiActivityEvent.addListener(this._trackActivity);\r\n  }\r\n\r\n  /** Stops time tracking\r\n   */\r\n  public stopTiming(): void {\r\n    ConfigurableUiManager.onUiIntervalEvent.removeListener(this._idleTimeCounter);\r\n    ConfigurableUiManager.onUiActivityEvent.removeListener(this._trackActivity);\r\n\r\n    this._totalTime = Date.now() - this._firstActiveTimestamp;\r\n    this._idleTime = this._totalIdleTime + this._idleCount * this._idleTimeout;\r\n  }\r\n\r\n  /** Gets engagement time in seconds\r\n   */\r\n  public getEngagementTimeSeconds(): number {\r\n    return (this._totalTime - this._idleTime) / 1000;\r\n  }\r\n\r\n  /** Gets total time in seconds\r\n   */\r\n  public getTotalTimeSeconds(): number {\r\n    return this._totalTime / 1000;\r\n  }\r\n\r\n  /** Gets idle time in seconds\r\n   */\r\n  public getIdleTimeSeconds(): number {\r\n    return this._idleTime / 1000;\r\n  }\r\n\r\n  private _idleTimeCounter = (args: UiIntervalEventArgs): void => {\r\n    // istanbul ignore next\r\n    const idleTimeout = args.idleTimeout ?? this._idleTimeout;\r\n    // istanbul ignore else\r\n    if (this._lastActiveTimestamp > 0 && this._idleStartTimestamp === 0 && Date.now() - this._lastActiveTimestamp >= idleTimeout) {\r\n      this._idleStartTimestamp = Date.now();\r\n      this._idleCount++;\r\n    }\r\n  };\r\n\r\n  private _trackActivity = (_args: UiActivityEventArgs): void => {\r\n    this._lastActiveTimestamp = Date.now();\r\n\r\n    if (this._idleStartTimestamp > 0) {\r\n      const lastIdleTime = this._lastActiveTimestamp - this._idleStartTimestamp;\r\n      this._totalIdleTime += lastIdleTime;\r\n      this._idleStartTimestamp = 0;\r\n    }\r\n  };\r\n}\r\n"]}

package/lib/esm/appui-react/configurableui/configurableui.scss

@@ -0,0 +1,80 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+@import "~@itwin/core-react/lib/cjs/core-react/base/base";
+@import "~@itwin/core-react/lib/cjs/core-react/icons/variables";
+@import "~@itwin/core-react/lib/cjs/core-react/inputs/variables";
+@import "~@itwin/core-react/lib/cjs/core-react/style/itwinui-overrides";
+@import "~@itwin/core-react/lib/cjs/core-react/style/themecolors";
+@import "~@itwin/core-react/lib/cjs/core-react/style/variables";
+@import "~@itwin/core-react/lib/cjs/core-react/z-index";
+@import "~@itwin/appui-layout-react/lib/cjs/appui-layout-react/footer/variables";
+@import "~@itwin/itwinui-css/scss/style/space";
+@import "~@itwin/itwinui-css/scss/style/typography";
+@import "../variables";
+
+#uifw-configurableui-wrapper {
+  position: relative;
+  left: 0;
+  top: 0;
+  width: 100%;
+  height: 100%;
+  overflow: hidden;
+  font-size: $iui-font-size;
+}
+
+#uifw-frontstage-composer {
+  width: 100%;
+  height: 100%;
+}
+
+.uifw-unselectable {
+  user-select: none;
+}
+
+.uifw-centered {
+  @include uicore-centered;
+}
+
+.uifw-dragdrop-layer {
+  cursor: grabbing;
+  position: fixed;
+  pointer-events: none;
+  @include uicore-z-index(dragdrop);
+  left: 0;
+  top: 0;
+  height: 100%;
+  width: 100%;
+}
+
+.uifw-element-tooltip-container {
+  position: fixed;
+  left: 0;
+  top: 0;
+  width: 100%;
+  height: 100%;
+  pointer-events: none;
+
+  @include uicore-z-index(tooltip);
+
+  >.uifw-element-tooltip {
+    width: max-content;
+    font-size: $iui-font-size;
+  }
+
+  >.nz-popup-tooltip {
+    border: {
+      color: $uifw-popup-border-color;
+      radius: $uifw-popup-border-radius;
+      style: solid;
+      width: $uifw-popup-border-width;
+    }
+  }
+}
+
+.uifw-app-button-small {
+  margin-bottom: 6px;
+}
+
+@include itwinui-style-overrides;

package/lib/esm/appui-react/configurableui/state.d.ts

@@ -0,0 +1,48 @@
+/** @packageDocumentation
+ * @module State
+ */
+import { ActionsUnion } from "../redux/redux-ts";
+import { FrameworkVersionId } from "../UiFramework";
+/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.
+ *  Since these are also used as sync ids they should be in lowercase.
+ * @public
+ */
+export declare enum ConfigurableUiActionId {
+    SetSnapMode = "configurableui:set_snapmode",
+    SetTheme = "configurableui:set_theme",
+    SetToolPrompt = "configurableui:set_toolprompt",
+    SetWidgetOpacity = "configurableui:set_widget_opacity",
+    SetDragInteraction = "configurableui:set-drag-interaction",
+    SetFrameworkVersion = "configurableui:set-framework-version"
+}
+/** The portion of state managed by the ConfigurableUiReducer.
+ * @public
+ */
+export interface ConfigurableUiState {
+    snapMode: number;
+    toolPrompt: string;
+    theme: string;
+    widgetOpacity: number;
+    useDragInteraction: boolean;
+    frameworkVersion: FrameworkVersionId;
+}
+/** An object with a function that creates each ConfigurableUiReducer that can be handled by our reducer.
+ * @public
+ */
+export declare const ConfigurableUiActions: {
+    setSnapMode: (snapMode: number) => import("../redux/redux-ts").ActionWithPayload<ConfigurableUiActionId.SetSnapMode, number>;
+    setTheme: (theme: string) => import("../redux/redux-ts").ActionWithPayload<ConfigurableUiActionId.SetTheme, string>;
+    setToolPrompt: (toolPrompt: string) => import("../redux/redux-ts").ActionWithPayload<ConfigurableUiActionId.SetToolPrompt, string>;
+    setWidgetOpacity: (opacity: number) => import("../redux/redux-ts").ActionWithPayload<ConfigurableUiActionId.SetWidgetOpacity, number>;
+    setDragInteraction: (dragInteraction: boolean) => import("../redux/redux-ts").ActionWithPayload<ConfigurableUiActionId.SetDragInteraction, boolean>;
+    setFrameworkVersion: (frameworkVersion: FrameworkVersionId) => import("../redux/redux-ts").ActionWithPayload<ConfigurableUiActionId.SetFrameworkVersion, FrameworkVersionId>;
+};
+/** Union of ConfigurableUi Redux actions
+ * @public
+ */
+export declare type ConfigurableUiActionsUnion = ActionsUnion<typeof ConfigurableUiActions>;
+/** Handles actions to update ConfigurableUiState.
+ * @public
+ */
+export declare function ConfigurableUiReducer(state: ConfigurableUiState | undefined, action: ConfigurableUiActionsUnion): ConfigurableUiState;
+//# sourceMappingURL=state.d.ts.map

package/lib/esm/appui-react/configurableui/state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/state.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAgB,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAIpD;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,WAAW,gCAAgC;IAC3C,QAAQ,6BAA6B;IACrC,aAAa,kCAAkC;IAC/C,gBAAgB,sCAAsC;IACtD,kBAAkB,wCAAwC;IAC1D,mBAAmB,yCAAyC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,gBAAgB,EAAE,kBAAkB,CAAC;CACtC;AAYD;;GAEG;AACH,eAAO,MAAM,qBAAqB;4BACR,MAAM;sBAGpB,MAAM;gCAGD,MAAM;gCAGT,MAAM;0CACoB,OAAO;4CACL,kBAAkB;CAC3D,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG,YAAY,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpF;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,iCAAoC,EAAE,MAAM,EAAE,0BAA0B,GAAG,mBAAmB,CAyBxI"}