@itwin/appui-react 3.0.0-dev.100

package/lib/cjs/appui-react/utils/UiShowHideManager.js

@@ -0,0 +1,189 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiShowHideManager = exports.INACTIVITY_TIME_DEFAULT = exports.UiShowHideSettingsProvider = void 0;
+const core_react_1 = require("@itwin/core-react");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const UiFramework_1 = require("../UiFramework");
+/** Class that maintain UiShowHide user settings between sessions
+ * @internal
+ */
+class UiShowHideSettingsProvider {
+    constructor() {
+        this.providerId = "UiShowHideSettingsProvider";
+    }
+    static initialize() {
+        UiFramework_1.UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());
+    }
+    async loadUserSettings(storage) {
+        let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);
+        if (result.status === core_react_1.UiSettingsStatus.Success)
+            UiShowHideManager.setAutoHideUi(result.setting);
+        result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);
+        if (result.status === core_react_1.UiSettingsStatus.Success)
+            UiShowHideManager.setUseProximityOpacity(result.setting);
+        result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);
+        if (result.status === core_react_1.UiSettingsStatus.Success)
+            UiShowHideManager.setSnapWidgetOpacity(result.setting);
+    }
+    static async storeAutoHideUi(v, storage) {
+        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiSettingsStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);
+    }
+    static async storeUseProximityOpacity(v, storage) {
+        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiSettingsStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);
+    }
+    static async storeSnapWidgetOpacity(v, storage) {
+        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiSettingsStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);
+    }
+}
+exports.UiShowHideSettingsProvider = UiShowHideSettingsProvider;
+UiShowHideSettingsProvider._settingsNamespace = "AppUiSettings";
+UiShowHideSettingsProvider._autoHideUiKey = "AutoHideUi";
+UiShowHideSettingsProvider._useProximityOpacityKey = "UseProximityOpacity";
+UiShowHideSettingsProvider._snapWidgetOpacityKey = "SnapWidgetOpacity";
+/** The default inactivity time.
+ * @internal
+ */
+exports.INACTIVITY_TIME_DEFAULT = 3500; /** Wait 3.5 seconds */
+/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.
+ * @public
+ */
+class UiShowHideManager {
+    /** Determines if the Ui is visible */
+    static get isUiVisible() {
+        return UiShowHideManager._isUiVisible;
+    }
+    static set isUiVisible(visible) {
+        UiShowHideManager._isUiVisible = visible;
+    }
+    /** @internal */
+    static setAutoHideUi(value) {
+        UiShowHideManager._autoHideUi = value;
+    }
+    /** @internal */
+    static setUseProximityOpacity(value) {
+        UiShowHideManager._useProximityOpacity = value;
+    }
+    /** @internal */
+    static setSnapWidgetOpacity(value) {
+        UiShowHideManager._snapWidgetOpacity = value;
+    }
+    /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.
+     * When true, the Ui automatically hides after a few seconds of inactivity.
+     */
+    static get autoHideUi() {
+        return UiShowHideManager._autoHideUi;
+    }
+    static set autoHideUi(autoHide) {
+        void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);
+        UiShowHideManager._autoHideUi = autoHide;
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
+    }
+    /** Determines whether the widget panels are shown and hidden. Defaults to false. */
+    static get showHidePanels() {
+        return UiShowHideManager._showHidePanels;
+    }
+    static set showHidePanels(showHide) {
+        UiShowHideManager._showHidePanels = showHide;
+        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework_1.UiFramework.getIsUiVisible() });
+    }
+    /** Determines whether the status bar is shown and hidden. Defaults to false. */
+    static get showHideFooter() {
+        return UiShowHideManager._showHideFooter;
+    }
+    static set showHideFooter(showHide) {
+        UiShowHideManager._showHideFooter = showHide;
+        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework_1.UiFramework.getIsUiVisible() });
+    }
+    /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
+    static get inactivityTime() {
+        return UiShowHideManager._inactivityTime;
+    }
+    static set inactivityTime(time) {
+        UiShowHideManager._inactivityTime = time;
+    }
+    /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
+    static get useProximityOpacity() {
+        return UiShowHideManager._useProximityOpacity;
+    }
+    static set useProximityOpacity(value) {
+        UiShowHideManager._useProximityOpacity = value;
+        void UiShowHideSettingsProvider.storeUseProximityOpacity(value);
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
+        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework_1.UiFramework.getIsUiVisible() });
+    }
+    /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
+    static get snapWidgetOpacity() {
+        return UiShowHideManager._snapWidgetOpacity;
+    }
+    static set snapWidgetOpacity(value) {
+        UiShowHideManager._snapWidgetOpacity = value;
+        void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
+        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework_1.UiFramework.getIsUiVisible() });
+    }
+    /** Handler for when a Frontstage is ready */
+    static handleFrontstageReady() {
+        if (!UiShowHideManager._autoHideUi)
+            return;
+        UiShowHideManager.showUiAndResetTimer();
+    }
+    /** Handler for when the mouse moves over the content area */
+    static handleContentMouseMove(_event) {
+        if (!UiShowHideManager._autoHideUi)
+            return;
+        UiShowHideManager.showUiAndResetTimer();
+    }
+    /** Handler for when the mouse enters a widget */
+    static handleWidgetMouseEnter(_event) {
+        if (!UiShowHideManager._autoHideUi)
+            return;
+        UiShowHideManager.showUiAndCancelTimer();
+    }
+    /** Shows the Ui and resets the inactivity timer */
+    static showUiAndResetTimer() {
+        setTimeout(() => {
+            UiShowHideManager.showUi();
+            UiShowHideManager.resetTimer();
+        });
+    }
+    /** Shows the Ui and cancels the inactivity timer */
+    static showUiAndCancelTimer() {
+        setTimeout(() => {
+            UiShowHideManager.showUi();
+            UiShowHideManager.cancelTimer();
+        });
+    }
+    static cancelTimer() {
+        clearTimeout(UiShowHideManager._timeout);
+    }
+    static resetTimer() {
+        UiShowHideManager.cancelTimer();
+        UiShowHideManager._timeout = setTimeout(UiShowHideManager.hideUi, UiShowHideManager._inactivityTime);
+    }
+    static showUi() {
+        UiFramework_1.UiFramework.setIsUiVisible(true);
+    }
+    static hideUi() {
+        UiFramework_1.UiFramework.setIsUiVisible(false);
+    }
+    /** @internal */
+    static terminate() {
+        UiShowHideManager.cancelTimer();
+    }
+}
+exports.UiShowHideManager = UiShowHideManager;
+UiShowHideManager._isUiVisible = true;
+UiShowHideManager._autoHideUi = false;
+UiShowHideManager._showHidePanels = false;
+UiShowHideManager._showHideFooter = false;
+UiShowHideManager._inactivityTime = exports.INACTIVITY_TIME_DEFAULT;
+UiShowHideManager._useProximityOpacity = true;
+UiShowHideManager._snapWidgetOpacity = false;
+//# sourceMappingURL=UiShowHideManager.js.map

package/lib/cjs/appui-react/utils/UiShowHideManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/UiShowHideManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,kDAAiE;AACjE,2EAAuF;AACvF,gDAAmE;AAEnE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA+B5D,CAAC;IA7BQ,MAAM,CAAC,UAAU;QACtB,yBAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAmB;QAC/C,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAChI,IAAI,MAAM,CAAC,MAAM,KAAK,6BAAgB,CAAC,OAAO;YAC5C,iBAAiB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAElD,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;QACrI,IAAI,MAAM,CAAC,MAAM,KAAK,6BAAgB,CAAC,OAAO;YAC5C,iBAAiB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE3D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,MAAM,CAAC,MAAM,KAAK,6BAAgB,CAAC,OAAO;YAC5C,iBAAiB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAoB;QAClE,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,oBAAoB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACpH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAU,EAAE,OAAoB;QAC3E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,oBAAoB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IAC7H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAU,EAAE,OAAoB;QACzE,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,oBAAoB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;IAC3H,CAAC;;AAnCH,gEAoCC;AAnCgB,6CAAkB,GAAG,eAAe,CAAC;AACrC,yCAAc,GAAG,YAAY,CAAC;AAC9B,kDAAuB,GAAG,qBAAqB,CAAC;AAChD,gDAAqB,GAAG,mBAAmB,CAAC;AAkC7D;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,MAAa,iBAAiB;IAU5B,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,iBAAiB,CAAC,YAAY,CAAC;IACxC,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,iBAAiB,CAAC,YAAY,GAAG,OAAO,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,iBAAiB,CAAC,WAAW,GAAG,KAAK,CAAC;IACxC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,iBAAiB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACjD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,iBAAiB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,iBAAiB,CAAC,WAAW,CAAC;IACvC,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,iBAAiB,CAAC,WAAW,GAAG,QAAQ,CAAC;QACzC,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;IACjG,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,iBAAiB,CAAC,eAAe,CAAC;IAC3C,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,iBAAiB,CAAC,eAAe,GAAG,QAAQ,CAAC;QAC7C,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,iBAAiB,CAAC,eAAe,CAAC;IAC3C,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,iBAAiB,CAAC,eAAe,GAAG,QAAQ,CAAC;QAC7C,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,iBAAiB,CAAC,eAAe,CAAC;IAC3C,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,iBAAiB,CAAC,eAAe,GAAG,IAAI,CAAC;IAC3C,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,iBAAiB,CAAC,oBAAoB,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,iBAAiB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAC/C,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,iBAAiB,CAAC,kBAAkB,CAAC;IAC9C,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,iBAAiB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAC7C,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,IAAI,CAAC,iBAAiB,CAAC,WAAW;YAChC,OAAO;QAET,iBAAiB,CAAC,mBAAmB,EAAE,CAAC;IAC1C,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,iBAAiB,CAAC,WAAW;YAChC,OAAO;QAET,iBAAiB,CAAC,mBAAmB,EAAE,CAAC;IAC1C,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,iBAAiB,CAAC,WAAW;YAChC,OAAO;QAET,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;IAC3C,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAC3B,iBAAiB,CAAC,UAAU,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,iBAAiB,CAAC,MAAM,EAAE,CAAC;YAC3B,iBAAiB,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,YAAY,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,iBAAiB,CAAC,WAAW,EAAE,CAAC;QAChC,iBAAiB,CAAC,QAAQ,GAAG,UAAU,CAAC,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;IACvG,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,yBAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS;QACrB,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAClC,CAAC;;AAzJH,8CA0JC;AAzJgB,8BAAY,GAAY,IAAI,CAAC;AAC7B,6BAAW,GAAY,KAAK,CAAC;AAC7B,iCAAe,GAAY,KAAK,CAAC;AACjC,iCAAe,GAAY,KAAK,CAAC;AACjC,iCAAe,GAAW,+BAAuB,CAAC;AAElD,sCAAoB,GAAY,IAAI,CAAC;AACrC,oCAAkB,GAAY,KAAK,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 Utilities\r\n */\r\n\r\nimport { UiSettings, UiSettingsStatus } from \"@itwin/core-react\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\r\n\r\n/** Class that maintain UiShowHide user settings between sessions\r\n * @internal\r\n */\r\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\r\n  private static _settingsNamespace = \"AppUiSettings\";\r\n  private static _autoHideUiKey = \"AutoHideUi\";\r\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\r\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\r\n  public readonly providerId = \"UiShowHideSettingsProvider\";\r\n\r\n  public static initialize() {\r\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\r\n  }\r\n\r\n  public async loadUserSettings(storage: UiSettings): Promise<void> {\r\n    let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);\r\n    if (result.status === UiSettingsStatus.Success)\r\n      UiShowHideManager.setAutoHideUi(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);\r\n    if (result.status === UiSettingsStatus.Success)\r\n      UiShowHideManager.setUseProximityOpacity(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);\r\n    if (result.status === UiSettingsStatus.Success)\r\n      UiShowHideManager.setSnapWidgetOpacity(result.setting);\r\n  }\r\n\r\n  public static async storeAutoHideUi(v: boolean, storage?: UiSettings) {\r\n    void (storage ?? UiFramework.getUiSettingsStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);\r\n  }\r\n\r\n  public static async storeUseProximityOpacity(v: boolean, storage?: UiSettings) {\r\n    void (storage ?? UiFramework.getUiSettingsStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);\r\n  }\r\n\r\n  public static async storeSnapWidgetOpacity(v: boolean, storage?: UiSettings) {\r\n    void (storage ?? UiFramework.getUiSettingsStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);\r\n  }\r\n}\r\n\r\n/** The default inactivity time.\r\n * @internal\r\n */\r\nexport const INACTIVITY_TIME_DEFAULT = 3500;  /** Wait 3.5 seconds */\r\n\r\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\r\n * @public\r\n */\r\nexport class UiShowHideManager {\r\n  private static _isUiVisible: boolean = true;\r\n  private static _autoHideUi: boolean = false;\r\n  private static _showHidePanels: boolean = false;\r\n  private static _showHideFooter: boolean = false;\r\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\r\n  private static _timeout: NodeJS.Timeout;\r\n  private static _useProximityOpacity: boolean = true;\r\n  private static _snapWidgetOpacity: boolean = false;\r\n\r\n  /** Determines if the Ui is visible */\r\n  public static get isUiVisible() {\r\n    return UiShowHideManager._isUiVisible;\r\n  }\r\n  public static set isUiVisible(visible: boolean) {\r\n    UiShowHideManager._isUiVisible = visible;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setAutoHideUi(value: boolean) {\r\n    UiShowHideManager._autoHideUi = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setUseProximityOpacity(value: boolean) {\r\n    UiShowHideManager._useProximityOpacity = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setSnapWidgetOpacity(value: boolean) {\r\n    UiShowHideManager._snapWidgetOpacity = value;\r\n  }\r\n\r\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\r\n   * When true, the Ui automatically hides after a few seconds of inactivity.\r\n   */\r\n  public static get autoHideUi(): boolean {\r\n    return UiShowHideManager._autoHideUi;\r\n  }\r\n\r\n  public static set autoHideUi(autoHide: boolean) {\r\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\r\n    UiShowHideManager._autoHideUi = autoHide;\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n  }\r\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\r\n  public static get showHidePanels(): boolean {\r\n    return UiShowHideManager._showHidePanels;\r\n  }\r\n  public static set showHidePanels(showHide: boolean) {\r\n    UiShowHideManager._showHidePanels = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\r\n  public static get showHideFooter(): boolean {\r\n    return UiShowHideManager._showHideFooter;\r\n  }\r\n  public static set showHideFooter(showHide: boolean) {\r\n    UiShowHideManager._showHideFooter = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\r\n  public static get inactivityTime(): number {\r\n    return UiShowHideManager._inactivityTime;\r\n  }\r\n  public static set inactivityTime(time: number) {\r\n    UiShowHideManager._inactivityTime = time;\r\n  }\r\n\r\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\r\n  public static get useProximityOpacity(): boolean {\r\n    return UiShowHideManager._useProximityOpacity;\r\n  }\r\n  public static set useProximityOpacity(value: boolean) {\r\n    UiShowHideManager._useProximityOpacity = value;\r\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\r\n  public static get snapWidgetOpacity(): boolean {\r\n    return UiShowHideManager._snapWidgetOpacity;\r\n  }\r\n  public static set snapWidgetOpacity(value: boolean) {\r\n    UiShowHideManager._snapWidgetOpacity = value;\r\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Handler for when a Frontstage is ready */\r\n  public static handleFrontstageReady() {\r\n    if (!UiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    UiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse moves over the content area */\r\n  public static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!UiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    UiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse enters a widget */\r\n  public static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!UiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    UiShowHideManager.showUiAndCancelTimer();\r\n  }\r\n\r\n  /** Shows the Ui and resets the inactivity timer */\r\n  public static showUiAndResetTimer() {\r\n    setTimeout(() => {\r\n      UiShowHideManager.showUi();\r\n      UiShowHideManager.resetTimer();\r\n    });\r\n  }\r\n\r\n  /** Shows the Ui and cancels the inactivity timer */\r\n  public static showUiAndCancelTimer() {\r\n    setTimeout(() => {\r\n      UiShowHideManager.showUi();\r\n      UiShowHideManager.cancelTimer();\r\n    });\r\n  }\r\n\r\n  private static cancelTimer() {\r\n    clearTimeout(UiShowHideManager._timeout);\r\n  }\r\n\r\n  private static resetTimer() {\r\n    UiShowHideManager.cancelTimer();\r\n    UiShowHideManager._timeout = setTimeout(UiShowHideManager.hideUi, UiShowHideManager._inactivityTime);\r\n  }\r\n\r\n  private static showUi() {\r\n    UiFramework.setIsUiVisible(true);\r\n  }\r\n\r\n  private static hideUi() {\r\n    UiFramework.setIsUiVisible(false);\r\n  }\r\n\r\n  /** @internal */\r\n  public static terminate() {\r\n    UiShowHideManager.cancelTimer();\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/utils/ViewUtilities.d.ts

@@ -0,0 +1,67 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { ScreenViewport } from "@itwin/core-frontend";
+/**
+ * Various View utility methods
+ * @public
+ */
+export declare class ViewUtilities {
+    /**
+     * Extracts the BisBaseClass from a full class name.
+     * @param classFullName full class name
+     * @returns BisBaseClass name
+     */
+    static getBisBaseClass(classFullName: string): string;
+    /**
+     * Determines if given class is a spatial view.
+     * @param classname Name of class to check
+     */
+    static isSpatial(classname: string): boolean;
+    /**
+     * Determines if given class is a spatial view.
+     * @param classname Name of class to check
+     */
+    static isOrthographic(classname: string): boolean;
+    /**
+     * Determines if given class is a drawing view.
+     * @param classname Name of class to check
+     */
+    static isDrawing(classname: string): boolean;
+    /**
+     * Determines if given class is a sheet view.
+     * @param classname Name of class to check
+     */
+    static isSheet(classname: string): boolean;
+    /**
+     * Determines if viewport displays a Sheet view.
+     * @param viewport ScreenViewport to check
+     */
+    static isSheetView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a Drawing view.
+     * @param viewport ScreenViewport to check
+     */
+    static isDrawingView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a Orthographic view.
+     * @param viewport ScreenViewport to check
+     */
+    static isOrthographicView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a Spatial view.
+     * @param viewport ScreenViewport to check
+     */
+    static isSpatialView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a 3d view.
+     * @param viewport ScreenViewport to check
+     */
+    static is3dView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport supports use of a camera.
+     * @param viewport ScreenViewport to check
+     */
+    static viewSupportsCamera(viewport: ScreenViewport): boolean;
+}
+//# sourceMappingURL=ViewUtilities.d.ts.map

package/lib/cjs/appui-react/utils/ViewUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/ViewUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAA2C,cAAc,EAAoC,MAAM,sBAAsB,CAAC;AAEjI;;;GAGG;AACH,qBAAa,aAAa;IAExB;;;;OAIG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IAKnD;;;OAGG;WACW,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAInD;;;OAGG;WACW,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIxD;;;OAGG;WACW,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAInD;;;OAGG;WACW,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIjD;;;OAGG;WACW,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAI5D;;;OAGG;WACW,aAAa,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAI9D;;;OAGG;WACW,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAInE;;;OAGG;WACW,aAAa,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAI9D;;;OAGG;WACW,QAAQ,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;IAIzD;;;OAGG;WACW,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO;CAGpE"}

package/lib/cjs/appui-react/utils/ViewUtilities.js

@@ -0,0 +1,99 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViewUtilities = void 0;
+// cSpell:ignore classname
+const core_frontend_1 = require("@itwin/core-frontend");
+/**
+ * Various View utility methods
+ * @public
+ */
+class ViewUtilities {
+    /**
+     * Extracts the BisBaseClass from a full class name.
+     * @param classFullName full class name
+     * @returns BisBaseClass name
+     */
+    static getBisBaseClass(classFullName) {
+        const bisBaseClass = classFullName.substring(classFullName.indexOf(":") + 1);
+        return bisBaseClass;
+    }
+    /**
+     * Determines if given class is a spatial view.
+     * @param classname Name of class to check
+     */
+    static isSpatial(classname) {
+        return classname === core_frontend_1.SpatialViewState.className || classname === core_frontend_1.OrthographicViewState.className;
+    }
+    /**
+     * Determines if given class is a spatial view.
+     * @param classname Name of class to check
+     */
+    static isOrthographic(classname) {
+        return classname === core_frontend_1.OrthographicViewState.className;
+    }
+    /**
+     * Determines if given class is a drawing view.
+     * @param classname Name of class to check
+     */
+    static isDrawing(classname) {
+        return classname === core_frontend_1.DrawingViewState.className;
+    }
+    /**
+     * Determines if given class is a sheet view.
+     * @param classname Name of class to check
+     */
+    static isSheet(classname) {
+        return classname === core_frontend_1.SheetViewState.className;
+    }
+    /**
+     * Determines if viewport displays a Sheet view.
+     * @param viewport ScreenViewport to check
+     */
+    static isSheetView(viewport) {
+        return ViewUtilities.isSheet(ViewUtilities.getBisBaseClass(viewport.view.classFullName));
+    }
+    /**
+     * Determines if viewport displays a Drawing view.
+     * @param viewport ScreenViewport to check
+     */
+    static isDrawingView(viewport) {
+        return ViewUtilities.isDrawing(ViewUtilities.getBisBaseClass(viewport.view.classFullName));
+    }
+    /**
+     * Determines if viewport displays a Orthographic view.
+     * @param viewport ScreenViewport to check
+     */
+    static isOrthographicView(viewport) {
+        return ViewUtilities.isOrthographic(ViewUtilities.getBisBaseClass(viewport.view.classFullName));
+    }
+    /**
+     * Determines if viewport displays a Spatial view.
+     * @param viewport ScreenViewport to check
+     */
+    static isSpatialView(viewport) {
+        return ViewUtilities.isSpatial(ViewUtilities.getBisBaseClass(viewport.view.classFullName));
+    }
+    /**
+     * Determines if viewport displays a 3d view.
+     * @param viewport ScreenViewport to check
+     */
+    static is3dView(viewport) {
+        return viewport.view.is3d();
+    }
+    /**
+     * Determines if viewport supports use of a camera.
+     * @param viewport ScreenViewport to check
+     */
+    static viewSupportsCamera(viewport) {
+        return core_frontend_1.SpatialViewState.className === ViewUtilities.getBisBaseClass(viewport.view.classFullName);
+    }
+}
+exports.ViewUtilities = ViewUtilities;
+//# sourceMappingURL=ViewUtilities.js.map

package/lib/cjs/appui-react/utils/ViewUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ViewUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/ViewUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0BAA0B;AAE1B,wDAAiI;AAEjI;;;GAGG;AACH,MAAa,aAAa;IAExB;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,MAAM,YAAY,GAAG,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7E,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAS,CAAC,SAAiB;QACvC,OAAO,SAAS,KAAK,gCAAgB,CAAC,SAAS,IAAI,SAAS,KAAK,qCAAqB,CAAC,SAAS,CAAC;IACnG,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,SAAiB;QAC5C,OAAO,SAAS,KAAK,qCAAqB,CAAC,SAAS,CAAC;IACvD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAS,CAAC,SAAiB;QACvC,OAAO,SAAS,KAAK,gCAAgB,CAAC,SAAS,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,OAAO,CAAC,SAAiB;QACrC,OAAO,SAAS,KAAK,8BAAc,CAAC,SAAS,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAwB;QAChD,OAAO,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,aAAa,CAAC,QAAwB;QAClD,OAAO,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,QAAwB;QACvD,OAAO,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAClG,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,aAAa,CAAC,QAAwB;QAClD,OAAO,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,QAAwB;QAC7C,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,QAAwB;QACvD,OAAO,gCAAgB,CAAC,SAAS,KAAK,aAAa,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACnG,CAAC;CACF;AA3FD,sCA2FC","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 Utilities\r\n */\r\n\r\n// cSpell:ignore classname\r\n\r\nimport { DrawingViewState, OrthographicViewState, ScreenViewport, SheetViewState, SpatialViewState } from \"@itwin/core-frontend\";\r\n\r\n/**\r\n * Various View utility methods\r\n * @public\r\n */\r\nexport class ViewUtilities {\r\n\r\n  /**\r\n   * Extracts the BisBaseClass from a full class name.\r\n   * @param classFullName full class name\r\n   * @returns BisBaseClass name\r\n   */\r\n  public static getBisBaseClass(classFullName: string) {\r\n    const bisBaseClass = classFullName.substring(classFullName.indexOf(\":\") + 1);\r\n    return bisBaseClass;\r\n  }\r\n\r\n  /**\r\n   * Determines if given class is a spatial view.\r\n   * @param classname Name of class to check\r\n   */\r\n  public static isSpatial(classname: string): boolean {\r\n    return classname === SpatialViewState.className || classname === OrthographicViewState.className;\r\n  }\r\n\r\n  /**\r\n   * Determines if given class is a spatial view.\r\n   * @param classname Name of class to check\r\n   */\r\n  public static isOrthographic(classname: string): boolean {\r\n    return classname === OrthographicViewState.className;\r\n  }\r\n\r\n  /**\r\n   * Determines if given class is a drawing view.\r\n   * @param classname Name of class to check\r\n   */\r\n  public static isDrawing(classname: string): boolean {\r\n    return classname === DrawingViewState.className;\r\n  }\r\n\r\n  /**\r\n   * Determines if given class is a sheet view.\r\n   * @param classname Name of class to check\r\n   */\r\n  public static isSheet(classname: string): boolean {\r\n    return classname === SheetViewState.className;\r\n  }\r\n\r\n  /**\r\n   * Determines if viewport displays a Sheet view.\r\n   * @param viewport ScreenViewport to check\r\n   */\r\n  public static isSheetView(viewport: ScreenViewport): boolean {\r\n    return ViewUtilities.isSheet(ViewUtilities.getBisBaseClass(viewport.view.classFullName));\r\n  }\r\n\r\n  /**\r\n   * Determines if viewport displays a Drawing view.\r\n   * @param viewport ScreenViewport to check\r\n   */\r\n  public static isDrawingView(viewport: ScreenViewport): boolean {\r\n    return ViewUtilities.isDrawing(ViewUtilities.getBisBaseClass(viewport.view.classFullName));\r\n  }\r\n\r\n  /**\r\n   * Determines if viewport displays a Orthographic view.\r\n   * @param viewport ScreenViewport to check\r\n   */\r\n  public static isOrthographicView(viewport: ScreenViewport): boolean {\r\n    return ViewUtilities.isOrthographic(ViewUtilities.getBisBaseClass(viewport.view.classFullName));\r\n  }\r\n\r\n  /**\r\n   * Determines if viewport displays a Spatial view.\r\n   * @param viewport ScreenViewport to check\r\n   */\r\n  public static isSpatialView(viewport: ScreenViewport): boolean {\r\n    return ViewUtilities.isSpatial(ViewUtilities.getBisBaseClass(viewport.view.classFullName));\r\n  }\r\n\r\n  /**\r\n   * Determines if viewport displays a 3d view.\r\n   * @param viewport ScreenViewport to check\r\n   */\r\n  public static is3dView(viewport: ScreenViewport): boolean {\r\n    return viewport.view.is3d();\r\n  }\r\n\r\n  /**\r\n   * Determines if viewport supports use of a camera.\r\n   * @param viewport ScreenViewport to check\r\n   */\r\n  public static viewSupportsCamera(viewport: ScreenViewport): boolean {\r\n    return SpatialViewState.className === ViewUtilities.getBisBaseClass(viewport.view.classFullName);\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/widget-panels/Content.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { WidgetDef } from "../widgets/WidgetDef";
+/** @internal */
+export declare function WidgetContent(): JSX.Element;
+/** @internal */
+export declare function useWidgetDef(): WidgetDef | undefined;
+//# sourceMappingURL=Content.d.ts.map

package/lib/cjs/appui-react/widget-panels/Content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Content.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Content.tsx"],"names":[],"mappings":";AAWA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIjD,gBAAgB;AAChB,wBAAgB,aAAa,gBAS5B;AAED,gBAAgB;AAChB,wBAAgB,YAAY,IAAI,SAAS,GAAG,SAAS,CA4BpD"}

package/lib/cjs/appui-react/widget-panels/Content.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useWidgetDef = exports.WidgetContent = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Widget
+ */
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const Frontstage_1 = require("../frontstage/Frontstage");
+const FrontstageManager_1 = require("../frontstage/FrontstageManager");
+/** @internal */
+function WidgetContent() {
+    var _a, _b;
+    const widget = useWidgetDef();
+    // istanbul ignore next
+    const itemId = (_b = (_a = widget === null || widget === void 0 ? void 0 : widget.id) !== null && _a !== void 0 ? _a : widget === null || widget === void 0 ? void 0 : widget.label) !== null && _b !== void 0 ? _b : "unknown";
+    return (React.createElement(appui_layout_react_1.ScrollableWidgetContent, { itemId: itemId }, widget === null || widget === void 0 ? void 0 : widget.reactNode));
+}
+exports.WidgetContent = WidgetContent;
+/** @internal */
+function useWidgetDef() {
+    const tabId = React.useContext(appui_layout_react_1.TabIdContext);
+    const frontstage = (0, Frontstage_1.useActiveFrontstageDef)();
+    const [widgetDef, setWidgetDef] = React.useState(() => frontstage === null || frontstage === void 0 ? void 0 : frontstage.findWidgetDef(tabId));
+    React.useEffect(() => {
+        const listener = (args) => {
+            // istanbul ignore next
+            if (args.frontstageDef !== frontstage || !frontstage || frontstage.isStageClosing || frontstage.isApplicationClosing)
+                return;
+            setWidgetDef(frontstage.findWidgetDef(tabId));
+        };
+        FrontstageManager_1.FrontstageManager.onFrontstageNineZoneStateChangedEvent.addListener(listener);
+        return () => {
+            FrontstageManager_1.FrontstageManager.onFrontstageNineZoneStateChangedEvent.removeListener(listener);
+        };
+    }, [frontstage, tabId]);
+    React.useEffect(() => {
+        // istanbul ignore next
+        const handlerActivated = () => {
+            setWidgetDef(frontstage === null || frontstage === void 0 ? void 0 : frontstage.findWidgetDef(tabId));
+        };
+        return appui_abstract_1.UiItemsManager.onUiProviderRegisteredEvent.addListener(handlerActivated);
+    }, [frontstage, tabId]);
+    return widgetDef;
+}
+exports.useWidgetDef = useWidgetDef;
+//# sourceMappingURL=Content.js.map

package/lib/cjs/appui-react/widget-panels/Content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Content.js","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Content.tsx"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,+BAA+B;AAC/B,0DAAuD;AACvD,kEAAkF;AAClF,yDAAkE;AAElE,uEAAoE;AAGpE,gBAAgB;AAChB,SAAgB,aAAa;;IAC3B,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,uBAAuB;IACvB,MAAM,MAAM,GAAG,MAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,mCAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,SAAS,CAAC;IACxD,OAAO,CACL,oBAAC,4CAAuB,IAAC,MAAM,EAAE,MAAM,IACpC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CACM,CAC3B,CAAC;AACJ,CAAC;AATD,sCASC;AAED,gBAAgB;AAChB,SAAgB,YAAY;IAC1B,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,iCAAY,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG,IAAA,mCAAsB,GAAE,CAAC;IAC5C,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAEzF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,QAAQ,GAAG,CAAC,IAA6C,EAAE,EAAE;YACjE,uBAAuB;YACvB,IAAI,IAAI,CAAC,aAAa,KAAK,UAAU,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,cAAc,IAAI,UAAU,CAAC,oBAAoB;gBAClH,OAAO;YACT,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC;QACF,qCAAiB,CAAC,qCAAqC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9E,OAAO,GAAG,EAAE;YACV,qCAAiB,CAAC,qCAAqC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACnF,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;IAExB,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,gBAAgB,GAAG,GAAG,EAAE;YAC5B,YAAY,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,OAAO,+BAAc,CAAC,2BAA2B,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAClF,CAAC,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;IAExB,OAAO,SAAS,CAAC;AACnB,CAAC;AA5BD,oCA4BC","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 Widget\r\n */\r\nimport * as React from \"react\";\r\nimport { UiItemsManager } from \"@itwin/appui-abstract\";\r\nimport { ScrollableWidgetContent, TabIdContext } from \"@itwin/appui-layout-react\";\r\nimport { useActiveFrontstageDef } from \"../frontstage/Frontstage\";\r\nimport { WidgetDef } from \"../widgets/WidgetDef\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { FrontstageNineZoneStateChangedEventArgs } from \"../frontstage/FrontstageDef\";\r\n\r\n/** @internal */\r\nexport function WidgetContent() {\r\n  const widget = useWidgetDef();\r\n  // istanbul ignore next\r\n  const itemId = widget?.id ?? widget?.label ?? \"unknown\";\r\n  return (\r\n    <ScrollableWidgetContent itemId={itemId}>\r\n      {widget?.reactNode}\r\n    </ScrollableWidgetContent>\r\n  );\r\n}\r\n\r\n/** @internal */\r\nexport function useWidgetDef(): WidgetDef | undefined {\r\n  const tabId = React.useContext(TabIdContext);\r\n  const frontstage = useActiveFrontstageDef();\r\n  const [widgetDef, setWidgetDef] = React.useState(() => frontstage?.findWidgetDef(tabId));\r\n\r\n  React.useEffect(() => {\r\n    const listener = (args: FrontstageNineZoneStateChangedEventArgs) => {\r\n      // istanbul ignore next\r\n      if (args.frontstageDef !== frontstage || !frontstage || frontstage.isStageClosing || frontstage.isApplicationClosing)\r\n        return;\r\n      setWidgetDef(frontstage.findWidgetDef(tabId));\r\n    };\r\n    FrontstageManager.onFrontstageNineZoneStateChangedEvent.addListener(listener);\r\n    return () => {\r\n      FrontstageManager.onFrontstageNineZoneStateChangedEvent.removeListener(listener);\r\n    };\r\n  }, [frontstage, tabId]);\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore next\r\n    const handlerActivated = () => {\r\n      setWidgetDef(frontstage?.findWidgetDef(tabId));\r\n    };\r\n\r\n    return UiItemsManager.onUiProviderRegisteredEvent.addListener(handlerActivated);\r\n  }, [frontstage, tabId]);\r\n\r\n  return widgetDef;\r\n}\r\n"]}