@itwin/appui-react 4.17.0 → 5.0.0-dev.2

package/lib/appui-react/configurableui/InternalConfigurableUiManager.d.ts

@@ -0,0 +1,66 @@
+/** @packageDocumentation
+ * @module ConfigurableUi
+ */
+import type { ConfigurableUiControlConstructor, ConfigurableUiElement } from "./ConfigurableUiControl.js";
+import { ActivityTracker } from "./ActivityTracker.js";
+import { BeUiEvent } from "@itwin/core-bentley";
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @internal
+ */
+export declare class InternalConfigurableUiManager {
+    private static _registeredControls;
+    private static _initialized;
+    /** @internal */
+    static readonly activityTracker: ActivityTracker;
+    /** @internal */
+    static readonly onUiActivityEvent: BeUiEvent<{
+        event: Event;
+    }>;
+    /** @internal */
+    static readonly onUiIntervalEvent: BeUiEvent<{
+        idleTimeout?: number | undefined;
+    }>;
+    /** Initializes the InternalConfigurableUiManager and registers core controls.
+     * @internal
+     */
+    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 register(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 isRegistered(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 unregister(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 create(classId: string, uniqueId: string, options?: any, controlId?: string): ConfigurableUiElement | undefined;
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement(): HTMLElement;
+    /** Assists in the transition to context wrapper exported from Configurable UI */
+    static getWrapperDocument(): Document;
+    /** Closes all UI popups currently open */
+    static closeUi(): void;
+}
+//# sourceMappingURL=InternalConfigurableUiManager.d.ts.map

package/lib/appui-react/configurableui/InternalConfigurableUiManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalConfigurableUiManager.d.ts","sourceRoot":"","sources":["../../../src/appui-react/configurableui/InternalConfigurableUiManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAQH,OAAO,KAAK,EACV,gCAAgC,EAChC,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAWhD;;GAEG;AACH,qBAAa,6BAA6B;IACxC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAG9B;IACJ,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IAEpC,gBAAgB;IAChB,gBAAuB,eAAe,kBAAyB;IAC/D,gBAAgB;IAChB,gBAAuB,iBAAiB;eAC/B,KAAK;OACT;IACL,gBAAgB;IAChB,gBAAuB,iBAAiB;;OAEnC;IAEL;;OAEG;WACW,UAAU;IA2CxB;;;;;;;;;OASG;WACW,QAAQ,CACpB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,gCAAgC,GAC5C,IAAI;IAWP;;;OAGG;WACW,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAKpD;;OAEG;WACW,qBAAqB,CACjC,WAAW,EAAE,gCAAgC,GAC5C,MAAM,GAAG,SAAS;IAQrB;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK/C;;;;;;OAMG;WACW,MAAM,CAClB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,GAAG,EACb,SAAS,CAAC,EAAE,MAAM,GACjB,qBAAqB,GAAG,SAAS;IAkBpC,wDAAwD;WAC1C,iBAAiB,IAAI,WAAW;IAM9C,iFAAiF;WACnE,kBAAkB,IAAI,QAAQ;IAK5C,0CAA0C;WAC5B,OAAO,IAAI,IAAI;CAS9B"}

package/lib/appui-react/configurableui/InternalConfigurableUiManager.js

@@ -0,0 +1,145 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { UiError } from "@itwin/appui-abstract";
+import { CubeNavigationAidControl } from "../navigationaids/CubeNavigationAidControl.js";
+import { DrawingNavigationAidControl } from "../navigationaids/DrawingNavigationAidControl.js";
+import { SheetNavigationAidControl } from "../navigationaids/SheetNavigationAid.js";
+import { StandardRotationNavigationAidControl } from "../navigationaids/StandardRotationNavigationAid.js";
+import { UiFramework } from "../UiFramework.js";
+import { ConfigurableCreateInfo } from "./ConfigurableUiControl.js";
+import { MessageManager } from "../messages/MessageManager.js";
+import { PopupManager } from "../popup/PopupManager.js";
+import { ActivityTracker } from "./ActivityTracker.js";
+import { BeUiEvent } from "@itwin/core-bentley";
+import { InternalFrontstageManager } from "../frontstage/InternalFrontstageManager.js";
+import { InternalToolSettingsManager } from "../toolsettings/InternalToolSettingsManager.js";
+import { InternalModelessDialogManager } from "../dialog/InternalModelessDialogManager.js";
+import { InternalContentDialogManager } from "../dialog/InternalContentDialogManager.js";
+import { InternalKeyboardShortcutManager } from "../keyboardshortcut/InternalKeyboardShortcut.js";
+import { InternalModalDialogManager } from "../dialog/InternalModalDialogManager.js";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher.js";
+/* eslint-disable deprecation/deprecation */
+/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.
+ * @internal
+ */
+export class InternalConfigurableUiManager {
+    /** Initializes the InternalConfigurableUiManager and registers core controls.
+     * @internal
+     */
+    static initialize() {
+        if (this._initialized)
+            return;
+        // Register core controls
+        InternalConfigurableUiManager.register(StandardRotationNavigationAidControl.navigationAidId, StandardRotationNavigationAidControl);
+        InternalConfigurableUiManager.register(SheetNavigationAidControl.navigationAidId, SheetNavigationAidControl);
+        InternalConfigurableUiManager.register(DrawingNavigationAidControl.navigationAidId, DrawingNavigationAidControl);
+        InternalConfigurableUiManager.register(CubeNavigationAidControl.navigationAidId, CubeNavigationAidControl);
+        // Initialize SyncUiEventDispatcher so it can register event callbacks.
+        SyncUiEventDispatcher.initialize();
+        // Initialize the FrontstageManager
+        InternalFrontstageManager.initialize();
+        // Initialize the ToolSettingsManager that manages Tool Settings properties.
+        InternalToolSettingsManager.initialize();
+        // Initialize dialog managers that allow one or more dialogs to be open at a time. These managers adjust the z-indexing
+        // to ensure the most recently focused dialog of a specific type displays above its siblings.
+        InternalModelessDialogManager.initialize();
+        // ContentDialog have a z-index just above the fixed content views and below all other UI elements.
+        InternalContentDialogManager.initialize();
+        // Initialize the Keyboard Shortcut manager
+        InternalKeyboardShortcutManager.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 register(classId, constructor) {
+        if (this._registeredControls.get(classId) !== undefined) {
+            throw new UiError(UiFramework.loggerCategory("InternalConfigurableUiManager"), `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 isRegistered(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 unregister(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 create(classId, uniqueId, options, controlId) {
+        const info = new ConfigurableCreateInfo(classId, uniqueId, controlId ?? uniqueId);
+        const constructor = this._registeredControls.get(info.classId);
+        if (!constructor) {
+            throw new UiError(UiFramework.loggerCategory("InternalConfigurableUiManager"), `createControl: classId '${classId}' not registered`);
+        }
+        const control = new constructor(info, options);
+        return control;
+    }
+    /** Gets the HTML wrapper element for Configurable UI */
+    static getWrapperElement() {
+        const wrapper = document.getElementById("uifw-configurableui-wrapper");
+        const htmlElement = wrapper;
+        return htmlElement;
+    }
+    /** Assists in the transition to context wrapper exported from Configurable UI */
+    static getWrapperDocument() {
+        const wrapper = document.getElementById("uifw-configurableui-wrapper");
+        return wrapper?.ownerDocument ?? document;
+    }
+    /** Closes all UI popups currently open */
+    static closeUi() {
+        MessageManager.closeAllMessages();
+        InternalModelessDialogManager.closeAll();
+        InternalModalDialogManager.closeAll();
+        InternalContentDialogManager.closeAll();
+        UiFramework.keyboardShortcuts.closeMenu();
+        UiFramework.closeCursorMenu();
+        PopupManager.clearPopups();
+    }
+}
+InternalConfigurableUiManager._registeredControls = new Map();
+InternalConfigurableUiManager._initialized = false;
+/** @internal */
+InternalConfigurableUiManager.activityTracker = new ActivityTracker();
+/** @internal */
+InternalConfigurableUiManager.onUiActivityEvent = new BeUiEvent();
+/** @internal */
+InternalConfigurableUiManager.onUiIntervalEvent = new BeUiEvent();
+//# sourceMappingURL=InternalConfigurableUiManager.js.map

package/lib/appui-react/configurableui/InternalConfigurableUiManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalConfigurableUiManager.js","sourceRoot":"","sources":["../../../src/appui-react/configurableui/InternalConfigurableUiManager.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,EAAE,2BAA2B,EAAE,MAAM,kDAAkD,CAAC;AAC/F,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACpF,OAAO,EAAE,oCAAoC,EAAE,MAAM,oDAAoD,CAAC;AAC1G,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAKhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,EAAE,6BAA6B,EAAE,MAAM,4CAA4C,CAAC;AAC3F,OAAO,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AACzF,OAAO,EAAE,+BAA+B,EAAE,MAAM,iDAAiD,CAAC;AAClG,OAAO,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,4CAA4C;AAE5C;;GAEG;AACH,MAAM,OAAO,6BAA6B;IAkBxC;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,IAAI,IAAI,CAAC,YAAY;YAAE,OAAO;QAE9B,yBAAyB;QACzB,6BAA6B,CAAC,QAAQ,CACpC,oCAAoC,CAAC,eAAe,EACpD,oCAAoC,CACrC,CAAC;QACF,6BAA6B,CAAC,QAAQ,CACpC,yBAAyB,CAAC,eAAe,EACzC,yBAAyB,CAC1B,CAAC;QACF,6BAA6B,CAAC,QAAQ,CACpC,2BAA2B,CAAC,eAAe,EAC3C,2BAA2B,CAC5B,CAAC;QACF,6BAA6B,CAAC,QAAQ,CACpC,wBAAwB,CAAC,eAAe,EACxC,wBAAwB,CACzB,CAAC;QAEF,uEAAuE;QACvE,qBAAqB,CAAC,UAAU,EAAE,CAAC;QAEnC,mCAAmC;QACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QAEvC,4EAA4E;QAC5E,2BAA2B,CAAC,UAAU,EAAE,CAAC;QAEzC,uHAAuH;QACvH,6FAA6F;QAC7F,6BAA6B,CAAC,UAAU,EAAE,CAAC;QAE3C,mGAAmG;QACnG,4BAA4B,CAAC,UAAU,EAAE,CAAC;QAE1C,2CAA2C;QAC3C,+BAA+B,CAAC,UAAU,EAAE,CAAC;QAE7C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,QAAQ,CACpB,OAAe,EACf,WAA6C;QAE7C,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,+BAA+B,CAAC,EAC3D,6BAA6B,OAAO,sBAAsB,CAC3D,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,YAAY,CAAC,OAAe;QACxC,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,CACjC,WAA6C;QAE7C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9D,IAAI,KAAK,KAAK,WAAW;gBAAE,OAAO,GAAG,CAAC;QACxC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe;QACtC,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,WAAW;YAAE,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAClB,OAAe,EACf,QAAgB,EAChB,OAAa,EACb,SAAkB;QAElB,MAAM,IAAI,GAAG,IAAI,sBAAsB,CACrC,OAAO,EACP,QAAQ,EACR,SAAS,IAAI,QAAQ,CACtB,CAAC;QACF,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,+BAA+B,CAAC,EAC3D,2BAA2B,OAAO,kBAAkB,CACrD,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,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,iFAAiF;IAC1E,MAAM,CAAC,kBAAkB;QAC9B,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QACvE,OAAO,OAAO,EAAE,aAAa,IAAI,QAAQ,CAAC;IAC5C,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,OAAO;QACnB,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAClC,6BAA6B,CAAC,QAAQ,EAAE,CAAC;QACzC,0BAA0B,CAAC,QAAQ,EAAE,CAAC;QACtC,4BAA4B,CAAC,QAAQ,EAAE,CAAC;QACxC,WAAW,CAAC,iBAAiB,CAAC,SAAS,EAAE,CAAC;QAC1C,WAAW,CAAC,eAAe,EAAE,CAAC;QAC9B,YAAY,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;;AAzKc,iDAAmB,GAAG,IAAI,GAAG,EAGzC,CAAC;AACW,0CAAY,GAAG,KAAK,CAAC;AAEpC,gBAAgB;AACO,6CAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAC/D,gBAAgB;AACO,+CAAiB,GAAG,IAAI,SAAS,EAEpD,CAAC;AACL,gBAAgB;AACO,+CAAiB,GAAG,IAAI,SAAS,EAEpD,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ConfigurableUi\n */\n\nimport { UiError } from \"@itwin/appui-abstract\";\nimport { CubeNavigationAidControl } from \"../navigationaids/CubeNavigationAidControl.js\";\nimport { DrawingNavigationAidControl } from \"../navigationaids/DrawingNavigationAidControl.js\";\nimport { SheetNavigationAidControl } from \"../navigationaids/SheetNavigationAid.js\";\nimport { StandardRotationNavigationAidControl } from \"../navigationaids/StandardRotationNavigationAid.js\";\nimport { UiFramework } from \"../UiFramework.js\";\nimport type {\n  ConfigurableUiControlConstructor,\n  ConfigurableUiElement,\n} from \"./ConfigurableUiControl.js\";\nimport { ConfigurableCreateInfo } from \"./ConfigurableUiControl.js\";\nimport { MessageManager } from \"../messages/MessageManager.js\";\nimport { PopupManager } from \"../popup/PopupManager.js\";\nimport { ActivityTracker } from \"./ActivityTracker.js\";\nimport { BeUiEvent } from \"@itwin/core-bentley\";\nimport { InternalFrontstageManager } from \"../frontstage/InternalFrontstageManager.js\";\nimport { InternalToolSettingsManager } from \"../toolsettings/InternalToolSettingsManager.js\";\nimport { InternalModelessDialogManager } from \"../dialog/InternalModelessDialogManager.js\";\nimport { InternalContentDialogManager } from \"../dialog/InternalContentDialogManager.js\";\nimport { InternalKeyboardShortcutManager } from \"../keyboardshortcut/InternalKeyboardShortcut.js\";\nimport { InternalModalDialogManager } from \"../dialog/InternalModalDialogManager.js\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher.js\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** Configurable Ui Manager maintains controls, Frontstages, Content Groups, Content Layouts, Tasks and Workflows.\n * @internal\n */\nexport class InternalConfigurableUiManager {\n  private static _registeredControls = new Map<\n    string,\n    ConfigurableUiControlConstructor\n  >();\n  private static _initialized = false;\n\n  /** @internal */\n  public static readonly activityTracker = new ActivityTracker();\n  /** @internal */\n  public static readonly onUiActivityEvent = new BeUiEvent<{\n    event: Event;\n  }>();\n  /** @internal */\n  public static readonly onUiIntervalEvent = new BeUiEvent<{\n    idleTimeout?: number;\n  }>();\n\n  /** Initializes the InternalConfigurableUiManager and registers core controls.\n   * @internal\n   */\n  public static initialize() {\n    if (this._initialized) return;\n\n    // Register core controls\n    InternalConfigurableUiManager.register(\n      StandardRotationNavigationAidControl.navigationAidId,\n      StandardRotationNavigationAidControl\n    );\n    InternalConfigurableUiManager.register(\n      SheetNavigationAidControl.navigationAidId,\n      SheetNavigationAidControl\n    );\n    InternalConfigurableUiManager.register(\n      DrawingNavigationAidControl.navigationAidId,\n      DrawingNavigationAidControl\n    );\n    InternalConfigurableUiManager.register(\n      CubeNavigationAidControl.navigationAidId,\n      CubeNavigationAidControl\n    );\n\n    // Initialize SyncUiEventDispatcher so it can register event callbacks.\n    SyncUiEventDispatcher.initialize();\n\n    // Initialize the FrontstageManager\n    InternalFrontstageManager.initialize();\n\n    // Initialize the ToolSettingsManager that manages Tool Settings properties.\n    InternalToolSettingsManager.initialize();\n\n    // Initialize dialog managers that allow one or more dialogs to be open at a time. These managers adjust the z-indexing\n    // to ensure the most recently focused dialog of a specific type displays above its siblings.\n    InternalModelessDialogManager.initialize();\n\n    // ContentDialog have a z-index just above the fixed content views and below all other UI elements.\n    InternalContentDialogManager.initialize();\n\n    // Initialize the Keyboard Shortcut manager\n    InternalKeyboardShortcutManager.initialize();\n\n    this._initialized = true;\n  }\n\n  /** Registers a control implementing the [[ConfigurableUiElement]] interface.\n   * These controls can be a\n   * [[ContentControl]],\n   * [[NavigationAidControl]],\n   * [[StatusBarWidgetControl]],\n   * [[WidgetControl]] or\n   * [ToolUiProvider]($appui-react).\n   * @param classId the class id of the control to register\n   * @param constructor the constructor of the control to register\n   */\n  public static register(\n    classId: string,\n    constructor: ConfigurableUiControlConstructor\n  ): void {\n    if (this._registeredControls.get(classId) !== undefined) {\n      throw new UiError(\n        UiFramework.loggerCategory(\"InternalConfigurableUiManager\"),\n        `registerControl: classId '${classId}' already registered`\n      );\n    }\n\n    this._registeredControls.set(classId, constructor);\n  }\n\n  /** Determines if a control has been registered based on its classId.\n   * @param classId   the class id of the control to test\n   * @returns  true if the control is registered or false if not\n   */\n  public static isRegistered(classId: string): boolean {\n    const constructor = this._registeredControls.get(classId);\n    return constructor !== undefined;\n  }\n\n  /** Determines if a control has been registered.\n   * @internal\n   */\n  public static getConstructorClassId(\n    constructor: ConfigurableUiControlConstructor\n  ): string | undefined {\n    for (const [key, value] of this._registeredControls.entries()) {\n      if (value === constructor) return key;\n    }\n\n    return undefined;\n  }\n\n  /** Unregisters a control that has been registered.\n   * @param classId   the class id of the control to unregister\n   */\n  public static unregister(classId: string): void {\n    const constructor = this._registeredControls.get(classId);\n    if (constructor) this._registeredControls.delete(classId);\n  }\n\n  /** Creates a control registered by calling registerControl.\n   * @param classId   the class id of the control to create\n   * @param uniqueId  a unique id for the control\n   * @param options   options passed to the constructor of the control\n   * @param controlId controlId which may not be unique across all control instances.\n   * @returns  the created control\n   */\n  public static create(\n    classId: string,\n    uniqueId: string,\n    options?: any,\n    controlId?: string\n  ): ConfigurableUiElement | undefined {\n    const info = new ConfigurableCreateInfo(\n      classId,\n      uniqueId,\n      controlId ?? uniqueId\n    );\n    const constructor = this._registeredControls.get(info.classId);\n    if (!constructor) {\n      throw new UiError(\n        UiFramework.loggerCategory(\"InternalConfigurableUiManager\"),\n        `createControl: classId '${classId}' not registered`\n      );\n    }\n\n    const control = new constructor(info, options);\n    return control;\n  }\n\n  /** Gets the HTML wrapper element for Configurable UI */\n  public static getWrapperElement(): HTMLElement {\n    const wrapper = document.getElementById(\"uifw-configurableui-wrapper\");\n    const htmlElement = wrapper!;\n    return htmlElement;\n  }\n\n  /** Assists in the transition to context wrapper exported from Configurable UI */\n  public static getWrapperDocument(): Document {\n    const wrapper = document.getElementById(\"uifw-configurableui-wrapper\");\n    return wrapper?.ownerDocument ?? document;\n  }\n\n  /** Closes all UI popups currently open */\n  public static closeUi(): void {\n    MessageManager.closeAllMessages();\n    InternalModelessDialogManager.closeAll();\n    InternalModalDialogManager.closeAll();\n    InternalContentDialogManager.closeAll();\n    UiFramework.keyboardShortcuts.closeMenu();\n    UiFramework.closeCursorMenu();\n    PopupManager.clearPopups();\n  }\n}\n"]}

package/lib/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;AAKH;;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;IAkB1B;OACG;IACI,UAAU,IAAI,IAAI;IAYzB;OACG;IACI,wBAAwB,IAAI,MAAM;IAIzC;OACG;IACI,mBAAmB,IAAI,MAAM;IAIpC;OACG;IACI,kBAAkB,IAAI,MAAM;IAInC,OAAO,CAAC,gBAAgB,CAYtB;IAEF,OAAO,CAAC,cAAc,CAUpB;CACH"}

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

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { InternalConfigurableUiManager } from "./InternalConfigurableUiManager.js";
+/** 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) => {
+            const idleTimeout = args.idleTimeout ?? this._idleTimeout;
+            if (this._lastActiveTimestamp > 0 &&
+                this._idleStartTimestamp === 0 &&
+                Date.now() - this._lastActiveTimestamp >= idleTimeout) {
+                this._idleStartTimestamp = Date.now();
+                this._idleCount++;
+            }
+        };
+        this._trackActivity = () => {
+            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;
+        InternalConfigurableUiManager.onUiIntervalEvent.addListener(this._idleTimeCounter);
+        InternalConfigurableUiManager.onUiActivityEvent.addListener(this._trackActivity);
+    }
+    /** Stops time tracking
+     */
+    stopTiming() {
+        InternalConfigurableUiManager.onUiIntervalEvent.removeListener(this._idleTimeCounter);
+        InternalConfigurableUiManager.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/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;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAEnF;;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;QAsDtB,qBAAgB,GAEpB,CAAC,IAAI,EAAQ,EAAE;YACjB,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC;YAC1D,IACE,IAAI,CAAC,oBAAoB,GAAG,CAAC;gBAC7B,IAAI,CAAC,mBAAmB,KAAK,CAAC;gBAC9B,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,oBAAoB,IAAI,WAAW,EACrD,CAAC;gBACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACtC,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,CAAC;QACH,CAAC,CAAC;QAEM,mBAAc,GAElB,GAAS,EAAE;YACb,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvC,IAAI,IAAI,CAAC,mBAAmB,GAAG,CAAC,EAAE,CAAC;gBACjC,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;YAC/B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IA7EC;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,6BAA6B,CAAC,iBAAiB,CAAC,WAAW,CACzD,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,6BAA6B,CAAC,iBAAiB,CAAC,WAAW,CACzD,IAAI,CAAC,cAAc,CACpB,CAAC;IACJ,CAAC;IAED;OACG;IACI,UAAU;QACf,6BAA6B,CAAC,iBAAiB,CAAC,cAAc,CAC5D,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,6BAA6B,CAAC,iBAAiB,CAAC,cAAc,CAC5D,IAAI,CAAC,cAAc,CACpB,CAAC;QAEF,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;CA2BF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ConfigurableUi\n */\n\nimport type { ListenerType } from \"@itwin/core-react/internal\";\nimport { InternalConfigurableUiManager } from \"./InternalConfigurableUiManager.js\";\n\n/** Time Tracker utility class\n * @internal\n */\nexport class TimeTracker {\n  private _firstActiveTimestamp: number = 0;\n  private _idleStartTimestamp: number = 0;\n  private _lastActiveTimestamp: number = 0;\n  private _totalIdleTime: number = 0;\n  private _idleCount: number = 0;\n  private _idleTimeout: number = 5000;\n  private _totalTime: number = 0;\n  private _idleTime: number = 0;\n\n  /** Starts time tracking\n   */\n  public startTiming(): void {\n    this._totalIdleTime = 0;\n    this._idleStartTimestamp = 0;\n    this._idleCount = 0;\n    this._totalTime = 0;\n    this._idleTime = 0;\n\n    this._firstActiveTimestamp = Date.now();\n    this._lastActiveTimestamp = this._firstActiveTimestamp;\n\n    InternalConfigurableUiManager.onUiIntervalEvent.addListener(\n      this._idleTimeCounter\n    );\n    InternalConfigurableUiManager.onUiActivityEvent.addListener(\n      this._trackActivity\n    );\n  }\n\n  /** Stops time tracking\n   */\n  public stopTiming(): void {\n    InternalConfigurableUiManager.onUiIntervalEvent.removeListener(\n      this._idleTimeCounter\n    );\n    InternalConfigurableUiManager.onUiActivityEvent.removeListener(\n      this._trackActivity\n    );\n\n    this._totalTime = Date.now() - this._firstActiveTimestamp;\n    this._idleTime = this._totalIdleTime + this._idleCount * this._idleTimeout;\n  }\n\n  /** Gets engagement time in seconds\n   */\n  public getEngagementTimeSeconds(): number {\n    return (this._totalTime - this._idleTime) / 1000;\n  }\n\n  /** Gets total time in seconds\n   */\n  public getTotalTimeSeconds(): number {\n    return this._totalTime / 1000;\n  }\n\n  /** Gets idle time in seconds\n   */\n  public getIdleTimeSeconds(): number {\n    return this._idleTime / 1000;\n  }\n\n  private _idleTimeCounter: ListenerType<\n    typeof InternalConfigurableUiManager.onUiIntervalEvent\n  > = (args): void => {\n    const idleTimeout = args.idleTimeout ?? this._idleTimeout;\n    if (\n      this._lastActiveTimestamp > 0 &&\n      this._idleStartTimestamp === 0 &&\n      Date.now() - this._lastActiveTimestamp >= idleTimeout\n    ) {\n      this._idleStartTimestamp = Date.now();\n      this._idleCount++;\n    }\n  };\n\n  private _trackActivity: ListenerType<\n    typeof InternalConfigurableUiManager.onUiActivityEvent\n  > = (): void => {\n    this._lastActiveTimestamp = Date.now();\n\n    if (this._idleStartTimestamp > 0) {\n      const lastIdleTime = this._lastActiveTimestamp - this._idleStartTimestamp;\n      this._totalIdleTime += lastIdleTime;\n      this._idleStartTimestamp = 0;\n    }\n  };\n}\n"]}

package/lib/appui-react/content/ContentControl.d.ts

@@ -0,0 +1,71 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import type { Id64String } from "@itwin/core-bentley";
+import type { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
+import { UiEvent } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl.js";
+/** ControlControl Activated Event Args interface.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+export interface ContentControlActivatedEventArgs {
+    activeContentControl: ContentControl;
+    oldContentControl?: ContentControl;
+}
+/** ContentControl Activated Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class ContentControlActivatedEvent extends UiEvent<ContentControlActivatedEventArgs> {
+}
+/** Interface to be implemented when the ContentControl supports ViewSelector changes
+ * @public
+ * @deprecated in 4.16.0. Implemented by classes derived from a deprecated {@link ContentControl}.
+ */
+export interface SupportsViewSelectorChange {
+    /** Returns true if this control supports reacting to ViewSelector changes. */
+    supportsViewSelectorChange: boolean;
+    /** Process a ViewSelector change. */
+    processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void>;
+}
+/** The base class for Frontstage content controls.
+ * @public
+ * @deprecated in 4.16.0. Extends a deprecated class {@link ConfigurableUiControl}.
+ */
+export declare class ContentControl extends ConfigurableUiControl {
+    protected _reactNode: React.ReactNode;
+    private _keyAdded;
+    /** Creates an instance of ContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** Called when this ContentControl is activated */
+    onActivated(): void;
+    /** Called when this ContentControl is deactivated */
+    onDeactivated(): void;
+    /** Gets the type of ConfigurableUiControl, which is 'Content' in this case */
+    getType(): ConfigurableUiControlType;
+    /** Returns true if this control is a Viewport control. */
+    get isViewport(): boolean;
+    /** Returns the ScreenViewport if isViewport is true */
+    get viewport(): ScreenViewport | undefined;
+    protected getKeyedReactNode(): React.ReactNode;
+    protected getReactNode(): React.ReactNode;
+    /** The React node associated with this control. */
+    get reactNode(): React.ReactNode;
+    set reactNode(r: React.ReactNode);
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl(): string;
+}
+/**
+ * @beta
+ * @deprecated in 4.16.0. Use {@link UiItemsProvider} to provide a floating {@link Widget} instead.
+ * Additionally, use {@link ContentOverlay} component to display the active content indicator.
+ */
+export declare class FloatingContentControl extends ContentControl {
+    constructor(uniqueId: string, name: string, node: React.ReactNode);
+}
+//# sourceMappingURL=ContentControl.d.ts.map

package/lib/appui-react/content/ContentControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentControl.d.ts","sourceRoot":"","sources":["../../../src/appui-react/content/ContentControl.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,EACV,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,4CAA4C,CAAC;AAOpD;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,oBAAoB,EAAE,cAAc,CAAC;IACrC,iBAAiB,CAAC,EAAE,cAAc,CAAC;CACpC;AAED;;;GAGG;AAEH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,gCAAgC,CAAC;CAAG;AAE9F;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,8EAA8E;IAC9E,0BAA0B,EAAE,OAAO,CAAC;IACpC,qCAAqC;IACrC,yBAAyB,CACvB,MAAM,EAAE,gBAAgB,EACxB,gBAAgB,EAAE,UAAU,EAC5B,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,qBAAqB;IACvD,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC;IACtC,OAAO,CAAC,SAAS,CAAS;IAE1B;;;OAGG;gBACS,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAItD,mDAAmD;IAC5C,WAAW,IAAI,IAAI;IAE1B,qDAAqD;IAC9C,aAAa,IAAI,IAAI;IAE5B,8EAA8E;IACvE,OAAO,IAAI,yBAAyB;IAI3C,0DAA0D;IAC1D,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD,uDAAuD;IACvD,IAAW,QAAQ,IAAI,cAAc,GAAG,SAAS,CAEhD;IAED,SAAS,CAAC,iBAAiB,IAAI,KAAK,CAAC,SAAS;IAY9C,SAAS,CAAC,YAAY,IAAI,KAAK,CAAC,SAAS;IAIzC,mDAAmD;IACnD,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAEtC;IAED,IAAW,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAEtC;IAED,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,MAAM,CAExC;CACF;AAED;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,cAAc;gBAC5C,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,SAAS;CAIlE"}

package/lib/appui-react/content/ContentControl.js

@@ -0,0 +1,83 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import { UiEvent } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType, } from "../configurableui/ConfigurableUiControl.js";
+/** ContentControl Activated Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+// eslint-disable-next-line deprecation/deprecation
+export class ContentControlActivatedEvent extends UiEvent {
+}
+/** The base class for Frontstage content controls.
+ * @public
+ * @deprecated in 4.16.0. Extends a deprecated class {@link ConfigurableUiControl}.
+ */
+export class ContentControl extends ConfigurableUiControl {
+    /** Creates an instance of ContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info, options) {
+        super(info, options);
+        this._keyAdded = false;
+    }
+    /** Called when this ContentControl is activated */
+    onActivated() { }
+    /** Called when this ContentControl is deactivated */
+    onDeactivated() { }
+    /** Gets the type of ConfigurableUiControl, which is 'Content' in this case */
+    getType() {
+        return ConfigurableUiControlType.Content;
+    }
+    /** Returns true if this control is a Viewport control. */
+    get isViewport() {
+        return false;
+    }
+    /** Returns the ScreenViewport if isViewport is true */
+    get viewport() {
+        return undefined;
+    }
+    getKeyedReactNode() {
+        if (!this._keyAdded && React.isValidElement(this._reactNode)) {
+            if (!this._reactNode.key) {
+                const additionalProps = { key: this.uniqueId };
+                this._reactNode = React.cloneElement(this._reactNode, additionalProps);
+            }
+            this._keyAdded = true;
+        }
+        return this._reactNode;
+    }
+    getReactNode() {
+        return this.getKeyedReactNode();
+    }
+    /** The React node associated with this control. */
+    get reactNode() {
+        return this.getReactNode();
+    }
+    set reactNode(r) {
+        this._reactNode = r;
+    }
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl() {
+        return "";
+    }
+}
+/**
+ * @beta
+ * @deprecated in 4.16.0. Use {@link UiItemsProvider} to provide a floating {@link Widget} instead.
+ * Additionally, use {@link ContentOverlay} component to display the active content indicator.
+ */
+export class FloatingContentControl extends ContentControl {
+    constructor(uniqueId, name, node) {
+        super(new ConfigurableCreateInfo(name, uniqueId, name), undefined);
+        this._reactNode = node;
+    }
+}
+//# sourceMappingURL=ContentControl.js.map

package/lib/appui-react/content/ContentControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentControl.js","sourceRoot":"","sources":["../../../src/appui-react/content/ContentControl.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAO/B,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,4CAA4C,CAAC;AAgBpD;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,4BAA6B,SAAQ,OAAyC;CAAG;AAkB9F;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,qBAAqB;IAIvD;;;OAGG;IACH,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAPf,cAAS,GAAG,KAAK,CAAC;IAQ1B,CAAC;IAED,mDAAmD;IAC5C,WAAW,KAAU,CAAC;IAE7B,qDAAqD;IAC9C,aAAa,KAAU,CAAC;IAE/B,8EAA8E;IACvE,OAAO;QACZ,OAAO,yBAAyB,CAAC,OAAO,CAAC;IAC3C,CAAC;IAED,0DAA0D;IAC1D,IAAW,UAAU;QACnB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,uDAAuD;IACvD,IAAW,QAAQ;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAES,iBAAiB;QACzB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7D,IAAI,CAAE,IAAI,CAAC,UAAsC,CAAC,GAAG,EAAE,CAAC;gBACtD,MAAM,eAAe,GAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;YACzE,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAES,YAAY;QACpB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAClC,CAAC;IAED,mDAAmD;IACnD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED,IAAW,SAAS,CAAC,CAAkB;QACrC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;IACtB,CAAC;IAED,uEAAuE;IACvE,IAAW,oBAAoB;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,cAAc;IACxD,YAAY,QAAgB,EAAE,IAAY,EAAE,IAAqB;QAC/D,KAAK,CAAC,IAAI,sBAAsB,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ContentView\n */\n\nimport * as React from \"react\";\nimport type { Id64String } from \"@itwin/core-bentley\";\nimport type {\n  IModelConnection,\n  ScreenViewport,\n  ViewState,\n} from \"@itwin/core-frontend\";\nimport { UiEvent } from \"@itwin/appui-abstract\";\nimport {\n  ConfigurableCreateInfo,\n  ConfigurableUiControl,\n  ConfigurableUiControlType,\n} from \"../configurableui/ConfigurableUiControl.js\";\nimport { Widget } from \"../widgets/Widget.js\";\nimport { UiItemsProvider } from \"../ui-items-provider/UiItemsProvider.js\";\nimport { ContentOverlay } from \"./ContentOverlay.js\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** ControlControl Activated Event Args interface.\n * @public\n * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\n */\nexport interface ContentControlActivatedEventArgs {\n  activeContentControl: ContentControl;\n  oldContentControl?: ContentControl;\n}\n\n/** ContentControl Activated Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class ContentControlActivatedEvent extends UiEvent<ContentControlActivatedEventArgs> {}\n\n/** Interface to be implemented when the ContentControl supports ViewSelector changes\n * @public\n * @deprecated in 4.16.0. Implemented by classes derived from a deprecated {@link ContentControl}.\n */\nexport interface SupportsViewSelectorChange {\n  /** Returns true if this control supports reacting to ViewSelector changes. */\n  supportsViewSelectorChange: boolean;\n  /** Process a ViewSelector change. */\n  processViewSelectorChange(\n    iModel: IModelConnection,\n    viewDefinitionId: Id64String,\n    viewState: ViewState,\n    name: string\n  ): Promise<void>;\n}\n\n/** The base class for Frontstage content controls.\n * @public\n * @deprecated in 4.16.0. Extends a deprecated class {@link ConfigurableUiControl}.\n */\nexport class ContentControl extends ConfigurableUiControl {\n  protected _reactNode: React.ReactNode;\n  private _keyAdded = false;\n\n  /** Creates an instance of ContentControl.\n   * @param info         An object that the subclass must pass to this base class.\n   * @param options      Options provided via the applicationData in a [[ContentProps]].\n   */\n  constructor(info: ConfigurableCreateInfo, options: any) {\n    super(info, options);\n  }\n\n  /** Called when this ContentControl is activated */\n  public onActivated(): void {}\n\n  /** Called when this ContentControl is deactivated */\n  public onDeactivated(): void {}\n\n  /** Gets the type of ConfigurableUiControl, which is 'Content' in this case */\n  public getType(): ConfigurableUiControlType {\n    return ConfigurableUiControlType.Content;\n  }\n\n  /** Returns true if this control is a Viewport control. */\n  public get isViewport(): boolean {\n    return false;\n  }\n  /** Returns the ScreenViewport if isViewport is true */\n  public get viewport(): ScreenViewport | undefined {\n    return undefined;\n  }\n\n  protected getKeyedReactNode(): React.ReactNode {\n    if (!this._keyAdded && React.isValidElement(this._reactNode)) {\n      if (!(this._reactNode as React.ReactElement<any>).key) {\n        const additionalProps: any = { key: this.uniqueId };\n        this._reactNode = React.cloneElement(this._reactNode, additionalProps);\n      }\n      this._keyAdded = true;\n    }\n\n    return this._reactNode;\n  }\n\n  protected getReactNode(): React.ReactNode {\n    return this.getKeyedReactNode();\n  }\n\n  /** The React node associated with this control. */\n  public get reactNode(): React.ReactNode {\n    return this.getReactNode();\n  }\n\n  public set reactNode(r: React.ReactNode) {\n    this._reactNode = r;\n  }\n\n  /** Get the NavigationAidControl associated with this ContentControl */\n  public get navigationAidControl(): string {\n    return \"\";\n  }\n}\n\n/**\n * @beta\n * @deprecated in 4.16.0. Use {@link UiItemsProvider} to provide a floating {@link Widget} instead.\n * Additionally, use {@link ContentOverlay} component to display the active content indicator.\n */\nexport class FloatingContentControl extends ContentControl {\n  constructor(uniqueId: string, name: string, node: React.ReactNode) {\n    super(new ConfigurableCreateInfo(name, uniqueId, name), undefined);\n    this._reactNode = node;\n  }\n}\n"]}

package/lib/appui-react/content/ContentGroup.d.ts

@@ -0,0 +1,116 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+import type * as React from "react";
+import type { ScreenViewport } from "@itwin/core-frontend";
+import type { ConfigurableUiControlConstructor } from "../configurableui/ConfigurableUiControl.js";
+import type { ContentControl } from "./ContentControl.js";
+import type { Frontstage } from "../frontstage/Frontstage.js";
+import type { ContentLayoutProps } from "./ContentLayoutProps.js";
+import type { ConditionalValue } from "../shared/ConditionalValue.js";
+/** Properties for content displayed in a content view
+ * @public
+ */
+export interface ContentProps {
+    /** A unique id for the Content View within the group. */
+    id: string;
+    /** The class name or [[ConfigurableUiControlConstructor]] of the content control.
+     * @deprecated in 4.16.0. Use {@link ContentProps.content} instead and specify an empty string for this property. This will be made optional in 5.0.0.
+     */
+    classId: string | ConfigurableUiControlConstructor;
+    /** Optional application data passed down to the content view.
+     * @deprecated in 4.16.0. Use {@link ContentProps.content} instead.
+     */
+    applicationData?: any;
+    /** Content to be displayed in the content view. */
+    content?: React.ReactNode;
+    /** Describes if the content should display the active strip.
+     * If `undefined` the strip will be displayed only if this content is active and multiple contents are available.
+     * Floating content controls (deprecated API) and `ContentOverlay` components are considered as content nodes.
+     */
+    renderActiveStrip?: boolean | ConditionalValue<boolean | undefined>;
+}
+/** Properties for a [[ContentGroup]]
+ * @public
+ */
+export interface ContentGroupProps {
+    /** An id for the [[ContentGroup]]. This id is used to locate a ContentGroup and it also can be used by an ContentGroupProvider to save/restore content settings */
+    id: string;
+    /** Content Layout Id or complete set of [[ContentLayoutProps]]  */
+    layout: ContentLayoutProps;
+    /** A collection of [[ContentProps]], one for each content view */
+    contents: ContentProps[];
+}
+/** Abstract class that can be implemented and specified by frontstage to dynamically construct
+ * content group just prior to activating the frontstage.
+ * @public
+ */
+export declare abstract class ContentGroupProvider {
+    /** Return the contentGroup based on the `Frontstage`. */
+    abstract contentGroup(frontstage: Frontstage): Promise<ContentGroup>;
+    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
+     * be to remove applicationData entries.
+     */
+    prepareToSaveProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
+    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
+     * Typically this may be to add applicationData to content entries.
+     */
+    applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
+    /** Allow provider to save any content group data before the stage deactivated. */
+    onFrontstageDeactivated(): Promise<void>;
+}
+/** Callback to process content properties during toJSON method
+ * @public
+ */
+export type ContentCallback = (content: ContentProps) => void;
+/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
+ * @public
+ */
+export declare class ContentGroup {
+    private static _sId;
+    groupId: string;
+    propsId: string;
+    layout: ContentLayoutProps;
+    contentPropsList: ContentProps[];
+    get id(): string;
+    constructor(contentGroupProps: ContentGroupProps);
+    /** Gets the React nodes representing the content views in this content group.
+     * @deprecated in 4.16.0. Use {@link ContentGroup.contentPropsList} instead.
+     */
+    getContentNodes(): React.ReactNode[];
+    /** Refreshes the React nodes representing the Content Views in this Content Group. */
+    refreshContentNodes(): void;
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated(): void;
+    /** Called when Frontstage is ready. */
+    onFrontstageReady(): void;
+    /** Clears the map of content controls. */
+    clearContentControls(): void;
+    /** Creates [[ContentGroupProps]] for JSON purposes.
+     * @public
+     */
+    toJSON(contentCallback?: ContentCallback): ContentGroupProps;
+    /** Gets Viewports from Viewport Content Controls.
+     * @internal
+     */
+    getViewports(): Array<ScreenViewport | undefined>;
+    private _contentControls;
+    private _contentSetMap;
+    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]].
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined;
+    /** Gets a [[ContentControl]] from the Content Group with a given ID.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    getContentControlById(id: string): ContentControl | undefined;
+    /** Gets the [[ContentControl]] associated with a given React node representing a Content View.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    getControlFromElement(node: React.ReactNode): ContentControl | undefined;
+    /** Gets an array of the content controls representing the Content Views.
+     * @deprecated in 4.16.0. Uses a deprecated class {@link ContentControl}.
+     */
+    getContentControls(): ContentControl[];
+}
+//# sourceMappingURL=ContentGroup.d.ts.map

package/lib/appui-react/content/ContentGroup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentGroup.d.ts","sourceRoot":"","sources":["../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,4CAA4C,CAAC;AAMnG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IAEH,OAAO,EAAE,MAAM,GAAG,gCAAgC,CAAC;IACnD;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,mDAAmD;IACnD,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mKAAmK;IACnK,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kEAAkE;IAClE,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,8BAAsB,oBAAoB;IACxC,yDAAyD;aACzC,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAE3E;;OAEG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB;IAI9D;;OAEG;IACI,wBAAwB,CAAC,iBAAiB,EAAE,iBAAiB;IAIpE,kFAAkF;IACrE,uBAAuB;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;AAE9D;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,gBAAgB,EAAE,YAAY,EAAE,CAAC;IAExC,IAAW,EAAE,WAEZ;gBAEW,iBAAiB,EAAE,iBAAiB;IAQhD;;OAEG;IACI,eAAe,IAAI,KAAK,CAAC,SAAS,EAAE;IAsB3C,sFAAsF;IAC/E,mBAAmB;IAI1B,6CAA6C;IACtC,uBAAuB,IAAI,IAAI;IAItC,uCAAuC;IAChC,iBAAiB,IAAI,IAAI;IAEhC,0CAA0C;IACnC,oBAAoB,IAAI,IAAI;IAInC;;OAEG;IACI,MAAM,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,iBAAiB;IA6BnE;;OAEG;IACI,YAAY,IAAI,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;IAkBxD,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,cAAc,CAAqC;IAE3D;;OAEG;IACI,iBAAiB,CACtB,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,MAAM,GACb,cAAc,GAAG,SAAS;IAoD7B;;OAEG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIpE;;OAEG;IACI,qBAAqB,CAC1B,IAAI,EAAE,KAAK,CAAC,SAAS,GACpB,cAAc,GAAG,SAAS;IAa7B;;OAEG;IACI,kBAAkB,IAAI,cAAc,EAAE;CAc9C"}