@itwin/appui-react 4.15.4 → 4.16.0

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

@@ -8,9 +8,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalUiShowHideManager = 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");
+const UiStateStorage_1 = require("../uistate/UiStateStorage");
 /** Class that maintain UiShowHide user settings between sessions
  * @internal
  */
@@ -23,13 +23,13 @@ class UiShowHideSettingsProvider {
     }
     async loadUserSettings(storage) {
         let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);
-        if (result.status === core_react_1.UiStateStorageStatus.Success)
+        if (result.status === UiStateStorage_1.UiStateStorageStatus.Success)
             InternalUiShowHideManager.setAutoHideUi(result.setting);
         result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);
-        if (result.status === core_react_1.UiStateStorageStatus.Success)
+        if (result.status === UiStateStorage_1.UiStateStorageStatus.Success)
             InternalUiShowHideManager.setUseProximityOpacity(result.setting);
         result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);
-        if (result.status === core_react_1.UiStateStorageStatus.Success)
+        if (result.status === UiStateStorage_1.UiStateStorageStatus.Success)
             InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);
     }
     static async storeAutoHideUi(v, storage) {
@@ -60,29 +60,31 @@ class InternalUiShowHideManager {
         return InternalUiShowHideManager._isUiVisible;
     }
     static set isUiVisible(visible) {
+        if (this._isUiVisible === visible)
+            return;
         InternalUiShowHideManager._isUiVisible = visible;
+        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible });
     }
-    /** @public */
     static setAutoHideUi(value) {
         InternalUiShowHideManager._autoHideUi = value;
     }
-    /** @internal */
     static setUseProximityOpacity(value) {
         InternalUiShowHideManager._useProximityOpacity = value;
     }
-    /** @internal */
     static setSnapWidgetOpacity(value) {
         InternalUiShowHideManager._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 InternalUiShowHideManager._autoHideUi;
     }
     static set autoHideUi(autoHide) {
+        if (this._autoHideUi === autoHide)
+            return;
         void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);
-        InternalUiShowHideManager._autoHideUi = autoHide;
+        if (!autoHide) {
+            this.isUiVisible = true;
+        }
+        this._autoHideUi = autoHide;
         SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
     }
     /** Determines whether the widget panels are shown and hidden. Defaults to false. */
@@ -92,7 +94,7 @@ class InternalUiShowHideManager {
     static set showHidePanels(showHide) {
         InternalUiShowHideManager._showHidePanels = showHide;
         UiFramework_1.UiFramework.onUiVisibilityChanged.emit({
-            visible: UiFramework_1.UiFramework.getIsUiVisible(),
+            visible: this.isUiVisible,
         });
     }
     /** Determines whether the status bar is shown and hidden. Defaults to false. */
@@ -102,7 +104,7 @@ class InternalUiShowHideManager {
     static set showHideFooter(showHide) {
         InternalUiShowHideManager._showHideFooter = showHide;
         UiFramework_1.UiFramework.onUiVisibilityChanged.emit({
-            visible: UiFramework_1.UiFramework.getIsUiVisible(),
+            visible: this.isUiVisible,
         });
     }
     /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
@@ -121,7 +123,7 @@ class InternalUiShowHideManager {
         void UiShowHideSettingsProvider.storeUseProximityOpacity(value);
         SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
         UiFramework_1.UiFramework.onUiVisibilityChanged.emit({
-            visible: UiFramework_1.UiFramework.getIsUiVisible(),
+            visible: this.isUiVisible,
         });
     }
     /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
@@ -133,7 +135,7 @@ class InternalUiShowHideManager {
         void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);
         SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
         UiFramework_1.UiFramework.onUiVisibilityChanged.emit({
-            visible: UiFramework_1.UiFramework.getIsUiVisible(),
+            visible: this.isUiVisible,
         });
     }
     /** Handler for when a Frontstage is ready */
@@ -156,38 +158,21 @@ class InternalUiShowHideManager {
     }
     /** Shows the Ui and resets the inactivity timer */
     static showUiAndResetTimer() {
-        window.clearTimeout(this._showUiTimeout);
-        this._showUiTimeout = window.setTimeout(() => {
-            InternalUiShowHideManager.showUi();
-            InternalUiShowHideManager.resetTimer();
-        });
+        this.isUiVisible = true;
+        window.clearTimeout(this._timeout);
+        if (!this._autoHideUi)
+            return;
+        this._timeout = window.setTimeout(() => {
+            this.isUiVisible = false;
+        }, this._inactivityTime);
     }
     /** Shows the Ui and cancels the inactivity timer */
     static showUiAndCancelTimer() {
-        window.clearTimeout(this._showUiTimeout);
-        this._showUiTimeout = window.setTimeout(() => {
-            InternalUiShowHideManager.showUi();
-            InternalUiShowHideManager.cancelTimer();
-        });
-    }
-    static cancelTimer() {
-        window.clearTimeout(InternalUiShowHideManager._timeout);
-    }
-    static resetTimer() {
-        InternalUiShowHideManager.cancelTimer();
-        InternalUiShowHideManager._timeout = window.setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._inactivityTime);
-    }
-    static showUi() {
-        UiFramework_1.UiFramework.setIsUiVisible(true);
-    }
-    static hideUi() {
-        UiFramework_1.UiFramework.setIsUiVisible(false);
+        this.isUiVisible = true;
+        window.clearTimeout(this._timeout);
     }
-    /** @internal */
     static terminate() {
-        this.cancelTimer();
-        window.clearTimeout(this._showUiTimeout);
-        this._showUiTimeout = undefined;
+        window.clearTimeout(this._timeout);
         this._isUiVisible = true;
         this._autoHideUi = true;
         this._showHidePanels = false;

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

@@ -1 +1 @@
-{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,kDAAyD;AACzD,2EAGyC;AAEzC,gDAA6C;AAE7C;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA0D5D,CAAC;IAxDQ,MAAM,CAAC,UAAU;QACtB,yBAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CACnC,0BAA0B,CAAC,kBAAkB,EAC7C,0BAA0B,CAAC,cAAc,CAC1C,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAC/B,0BAA0B,CAAC,kBAAkB,EAC7C,0BAA0B,CAAC,uBAAuB,CACnD,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnE,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAC/B,0BAA0B,CAAC,kBAAkB,EAC7C,0BAA0B,CAAC,qBAAqB,CACjD,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAwB;QACtE,KAAK,CAAC,OAAO,IAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAC3D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,cAAc,EACnB,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,CAAU,EACV,OAAwB;QAExB,KAAK,CAAC,OAAO,IAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAC3D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,uBAAuB,EAC5B,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CACxC,CAAU,EACV,OAAwB;QAExB,KAAK,CAAC,OAAO,IAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAC3D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,qBAAqB,EAC1B,CAAC,CACF,CAAC;IACJ,CAAC;;AA9DH,gEA+DC;AA9DgB,6CAAkB,GAAG,eAAe,AAAlB,CAAmB;AACrC,yCAAc,GAAG,YAAY,AAAf,CAAgB;AAC9B,kDAAuB,GAAG,qBAAqB,AAAxB,CAAyB;AAChD,gDAAqB,GAAG,mBAAmB,AAAtB,CAAuB;AA6D7D;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,CAAC,CAAC,uBAAuB;AAEpE;;GAEG;AACH,MAAa,yBAAyB;IAWpC,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,yBAAyB,CAAC,YAAY,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,yBAAyB,CAAC,YAAY,GAAG,OAAO,CAAC;IACnD,CAAC;IAED,cAAc;IACP,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,yBAAyB,CAAC,WAAW,GAAG,KAAK,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,yBAAyB,CAAC,WAAW,GAAG,QAAQ,CAAC;QACjD,6CAAqB,CAAC,4BAA4B,CAChD,qCAAa,CAAC,4BAA4B,CAC3C,CAAC;IACJ,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE;SACtC,CAAC,CAAC;IACL,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE;SACtC,CAAC,CAAC;IACL,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,yBAAyB,CAAC,eAAe,GAAG,IAAI,CAAC;IACnD,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,yBAAyB,CAAC,oBAAoB,CAAC;IACxD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,6CAAqB,CAAC,4BAA4B,CAChD,qCAAa,CAAC,4BAA4B,CAC3C,CAAC;QACF,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE;SACtC,CAAC,CAAC;IACL,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QACrD,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,6CAAqB,CAAC,4BAA4B,CAChD,qCAAa,CAAC,4BAA4B,CAC3C,CAAC;QACF,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE;SACtC,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,IAAI,CAAC,yBAAyB,CAAC,WAAW;YAAE,OAAO;QAEnD,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAClC,MAAkD;QAElD,IAAI,CAAC,yBAAyB,CAAC,WAAW;YAAE,OAAO;QAEnD,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAClC,MAAkD;QAElD,IAAI,CAAC,yBAAyB,CAAC,WAAW;YAAE,OAAO;QAEnD,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YAC3C,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YAC3C,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,MAAM,CAAC,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,yBAAyB,CAAC,QAAQ,GAAG,MAAM,CAAC,UAAU,CACpD,yBAAyB,CAAC,MAAM,EAChC,yBAAyB,CAAC,eAAe,CAC1C,CAAC;IACJ,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,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,+BAAuB,CAAC;QAC/C,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAClC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClC,CAAC;;AAvLH,8DAwLC;AAvLgB,sCAAY,GAAY,IAAI,CAAC;AAC7B,qCAAW,GAAY,IAAI,CAAC;AAC5B,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAW,+BAAuB,CAAC;AAGlD,8CAAoB,GAAY,KAAK,CAAC;AACtC,4CAAkB,GAAY,KAAK,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 Utilities\n */\n\nimport type { UiStateStorage } from \"@itwin/core-react\";\nimport { UiStateStorageStatus } from \"@itwin/core-react\";\nimport {\n  SyncUiEventDispatcher,\n  SyncUiEventId,\n} from \"../syncui/SyncUiEventDispatcher\";\nimport type { UserSettingsProvider } from \"../UiFramework\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** Class that maintain UiShowHide user settings between sessions\n * @internal\n */\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\n  private static _settingsNamespace = \"AppUiSettings\";\n  private static _autoHideUiKey = \"AutoHideUi\";\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\n  public readonly providerId = \"UiShowHideSettingsProvider\";\n\n  public static initialize() {\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\n  }\n\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\n    let result = await storage.getSetting(\n      UiShowHideSettingsProvider._settingsNamespace,\n      UiShowHideSettingsProvider._autoHideUiKey\n    );\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\n\n    result = await storage.getSetting(\n      UiShowHideSettingsProvider._settingsNamespace,\n      UiShowHideSettingsProvider._useProximityOpacityKey\n    );\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\n\n    result = await storage.getSetting(\n      UiShowHideSettingsProvider._settingsNamespace,\n      UiShowHideSettingsProvider._snapWidgetOpacityKey\n    );\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\n  }\n\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(\n      this._settingsNamespace,\n      this._autoHideUiKey,\n      v\n    );\n  }\n\n  public static async storeUseProximityOpacity(\n    v: boolean,\n    storage?: UiStateStorage\n  ) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(\n      this._settingsNamespace,\n      this._useProximityOpacityKey,\n      v\n    );\n  }\n\n  public static async storeSnapWidgetOpacity(\n    v: boolean,\n    storage?: UiStateStorage\n  ) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(\n      this._settingsNamespace,\n      this._snapWidgetOpacityKey,\n      v\n    );\n  }\n}\n\n/** The default inactivity time.\n * @internal\n */\nexport const INACTIVITY_TIME_DEFAULT = 3500; /** Wait 3.5 seconds */\n\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\n * @internal\n */\nexport class InternalUiShowHideManager {\n  private static _isUiVisible: boolean = true;\n  private static _autoHideUi: boolean = true;\n  private static _showHidePanels: boolean = false;\n  private static _showHideFooter: boolean = false;\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\n  private static _timeout: number;\n  private static _showUiTimeout: number | undefined;\n  private static _useProximityOpacity: boolean = false;\n  private static _snapWidgetOpacity: boolean = false;\n\n  /** Determines if the Ui is visible */\n  public static get isUiVisible() {\n    return InternalUiShowHideManager._isUiVisible;\n  }\n  public static set isUiVisible(visible: boolean) {\n    InternalUiShowHideManager._isUiVisible = visible;\n  }\n\n  /** @public */\n  public static setAutoHideUi(value: boolean) {\n    InternalUiShowHideManager._autoHideUi = value;\n  }\n\n  /** @internal */\n  public static setUseProximityOpacity(value: boolean) {\n    InternalUiShowHideManager._useProximityOpacity = value;\n  }\n\n  /** @internal */\n  public static setSnapWidgetOpacity(value: boolean) {\n    InternalUiShowHideManager._snapWidgetOpacity = value;\n  }\n\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\n   * When true, the Ui automatically hides after a few seconds of inactivity.\n   */\n  public static get autoHideUi(): boolean {\n    return InternalUiShowHideManager._autoHideUi;\n  }\n\n  public static set autoHideUi(autoHide: boolean) {\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\n    InternalUiShowHideManager._autoHideUi = autoHide;\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(\n      SyncUiEventId.ShowHideManagerSettingChange\n    );\n  }\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\n  public static get showHidePanels(): boolean {\n    return InternalUiShowHideManager._showHidePanels;\n  }\n  public static set showHidePanels(showHide: boolean) {\n    InternalUiShowHideManager._showHidePanels = showHide;\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: UiFramework.getIsUiVisible(),\n    });\n  }\n\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\n  public static get showHideFooter(): boolean {\n    return InternalUiShowHideManager._showHideFooter;\n  }\n  public static set showHideFooter(showHide: boolean) {\n    InternalUiShowHideManager._showHideFooter = showHide;\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: UiFramework.getIsUiVisible(),\n    });\n  }\n\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\n  public static get inactivityTime(): number {\n    return InternalUiShowHideManager._inactivityTime;\n  }\n  public static set inactivityTime(time: number) {\n    InternalUiShowHideManager._inactivityTime = time;\n  }\n\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\n  public static get useProximityOpacity(): boolean {\n    return InternalUiShowHideManager._useProximityOpacity;\n  }\n  public static set useProximityOpacity(value: boolean) {\n    InternalUiShowHideManager._useProximityOpacity = value;\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(\n      SyncUiEventId.ShowHideManagerSettingChange\n    );\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: UiFramework.getIsUiVisible(),\n    });\n  }\n\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\n  public static get snapWidgetOpacity(): boolean {\n    return InternalUiShowHideManager._snapWidgetOpacity;\n  }\n  public static set snapWidgetOpacity(value: boolean) {\n    InternalUiShowHideManager._snapWidgetOpacity = value;\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(\n      SyncUiEventId.ShowHideManagerSettingChange\n    );\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: UiFramework.getIsUiVisible(),\n    });\n  }\n\n  /** Handler for when a Frontstage is ready */\n  public static handleFrontstageReady() {\n    if (!InternalUiShowHideManager._autoHideUi) return;\n\n    InternalUiShowHideManager.showUiAndResetTimer();\n  }\n\n  /** Handler for when the mouse moves over the content area */\n  public static handleContentMouseMove(\n    _event?: React.MouseEvent<HTMLElement, MouseEvent>\n  ) {\n    if (!InternalUiShowHideManager._autoHideUi) return;\n\n    InternalUiShowHideManager.showUiAndResetTimer();\n  }\n\n  /** Handler for when the mouse enters a widget */\n  public static handleWidgetMouseEnter(\n    _event?: React.MouseEvent<HTMLElement, MouseEvent>\n  ) {\n    if (!InternalUiShowHideManager._autoHideUi) return;\n\n    InternalUiShowHideManager.showUiAndCancelTimer();\n  }\n\n  /** Shows the Ui and resets the inactivity timer */\n  public static showUiAndResetTimer() {\n    window.clearTimeout(this._showUiTimeout);\n    this._showUiTimeout = window.setTimeout(() => {\n      InternalUiShowHideManager.showUi();\n      InternalUiShowHideManager.resetTimer();\n    });\n  }\n\n  /** Shows the Ui and cancels the inactivity timer */\n  public static showUiAndCancelTimer() {\n    window.clearTimeout(this._showUiTimeout);\n    this._showUiTimeout = window.setTimeout(() => {\n      InternalUiShowHideManager.showUi();\n      InternalUiShowHideManager.cancelTimer();\n    });\n  }\n\n  private static cancelTimer() {\n    window.clearTimeout(InternalUiShowHideManager._timeout);\n  }\n\n  private static resetTimer() {\n    InternalUiShowHideManager.cancelTimer();\n    InternalUiShowHideManager._timeout = window.setTimeout(\n      InternalUiShowHideManager.hideUi,\n      InternalUiShowHideManager._inactivityTime\n    );\n  }\n\n  private static showUi() {\n    UiFramework.setIsUiVisible(true);\n  }\n\n  private static hideUi() {\n    UiFramework.setIsUiVisible(false);\n  }\n\n  /** @internal */\n  public static terminate() {\n    this.cancelTimer();\n    window.clearTimeout(this._showUiTimeout);\n    this._showUiTimeout = undefined;\n    this._isUiVisible = true;\n    this._autoHideUi = true;\n    this._showHidePanels = false;\n    this._showHideFooter = false;\n    this._inactivityTime = INACTIVITY_TIME_DEFAULT;\n    this._useProximityOpacity = false;\n    this._snapWidgetOpacity = false;\n  }\n}\n"]}
+{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,2EAGyC;AAEzC,gDAA6C;AAE7C,8DAAiE;AAEjE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA0D5D,CAAC;IAxDQ,MAAM,CAAC,UAAU;QACtB,yBAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CACnC,0BAA0B,CAAC,kBAAkB,EAC7C,0BAA0B,CAAC,cAAc,CAC1C,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,qCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAC/B,0BAA0B,CAAC,kBAAkB,EAC7C,0BAA0B,CAAC,uBAAuB,CACnD,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,qCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnE,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAC/B,0BAA0B,CAAC,kBAAkB,EAC7C,0BAA0B,CAAC,qBAAqB,CACjD,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,qCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAwB;QACtE,KAAK,CAAC,OAAO,IAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAC3D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,cAAc,EACnB,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAC1C,CAAU,EACV,OAAwB;QAExB,KAAK,CAAC,OAAO,IAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAC3D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,uBAAuB,EAC5B,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CACxC,CAAU,EACV,OAAwB;QAExB,KAAK,CAAC,OAAO,IAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAC3D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,qBAAqB,EAC1B,CAAC,CACF,CAAC;IACJ,CAAC;;AA9DH,gEA+DC;AA9DgB,6CAAkB,GAAG,eAAe,AAAlB,CAAmB;AACrC,yCAAc,GAAG,YAAY,AAAf,CAAgB;AAC9B,kDAAuB,GAAG,qBAAqB,AAAxB,CAAyB;AAChD,gDAAqB,GAAG,mBAAmB,AAAtB,CAAuB;AA6D7D;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,CAAC,CAAC,uBAAuB;AAEpE;;GAEG;AACH,MAAa,yBAAyB;IAUpC,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,yBAAyB,CAAC,YAAY,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,IAAI,IAAI,CAAC,YAAY,KAAK,OAAO;YAAE,OAAO;QAC1C,yBAAyB,CAAC,YAAY,GAAG,OAAO,CAAC;QACjD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,yBAAyB,CAAC,WAAW,GAAG,KAAK,CAAC;IAChD,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACzD,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;IAEM,MAAM,KAAK,UAAU;QAC1B,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,IAAI,IAAI,CAAC,WAAW,KAAK,QAAQ;YAAE,OAAO;QAE1C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;QAC5B,6CAAqB,CAAC,4BAA4B,CAChD,qCAAa,CAAC,4BAA4B,CAC3C,CAAC;IACJ,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,IAAI,CAAC,WAAW;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,IAAI,CAAC,WAAW;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,yBAAyB,CAAC,eAAe,GAAG,IAAI,CAAC;IACnD,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,yBAAyB,CAAC,oBAAoB,CAAC;IACxD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,6CAAqB,CAAC,4BAA4B,CAChD,qCAAa,CAAC,4BAA4B,CAC3C,CAAC;QACF,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,IAAI,CAAC,WAAW;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QACrD,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,6CAAqB,CAAC,4BAA4B,CAChD,qCAAa,CAAC,4BAA4B,CAC3C,CAAC;QACF,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC;YACrC,OAAO,EAAE,IAAI,CAAC,WAAW;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,IAAI,CAAC,yBAAyB,CAAC,WAAW;YAAE,OAAO;QACnD,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAClC,MAAkD;QAElD,IAAI,CAAC,yBAAyB,CAAC,WAAW;YAAE,OAAO;QACnD,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAClC,MAAkD;QAElD,IAAI,CAAC,yBAAyB,CAAC,WAAW;YAAE,OAAO;QACnD,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,OAAO;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAC3B,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC3B,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,SAAS;QACrB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,+BAAuB,CAAC;QAC/C,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;QAClC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClC,CAAC;;AA5JH,8DA6JC;AA5JgB,sCAAY,GAAY,IAAI,CAAC;AAC7B,qCAAW,GAAY,IAAI,CAAC;AAC5B,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAW,+BAAuB,CAAC;AAElD,8CAAoB,GAAY,KAAK,CAAC;AACtC,4CAAkB,GAAY,KAAK,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 Utilities\n */\n\nimport {\n  SyncUiEventDispatcher,\n  SyncUiEventId,\n} from \"../syncui/SyncUiEventDispatcher\";\nimport type { UserSettingsProvider } from \"../UiFramework\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiStateStorage } from \"../uistate/UiStateStorage\";\nimport { UiStateStorageStatus } from \"../uistate/UiStateStorage\";\n\n/** Class that maintain UiShowHide user settings between sessions\n * @internal\n */\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\n  private static _settingsNamespace = \"AppUiSettings\";\n  private static _autoHideUiKey = \"AutoHideUi\";\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\n  public readonly providerId = \"UiShowHideSettingsProvider\";\n\n  public static initialize() {\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\n  }\n\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\n    let result = await storage.getSetting(\n      UiShowHideSettingsProvider._settingsNamespace,\n      UiShowHideSettingsProvider._autoHideUiKey\n    );\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\n\n    result = await storage.getSetting(\n      UiShowHideSettingsProvider._settingsNamespace,\n      UiShowHideSettingsProvider._useProximityOpacityKey\n    );\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\n\n    result = await storage.getSetting(\n      UiShowHideSettingsProvider._settingsNamespace,\n      UiShowHideSettingsProvider._snapWidgetOpacityKey\n    );\n    if (result.status === UiStateStorageStatus.Success)\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\n  }\n\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(\n      this._settingsNamespace,\n      this._autoHideUiKey,\n      v\n    );\n  }\n\n  public static async storeUseProximityOpacity(\n    v: boolean,\n    storage?: UiStateStorage\n  ) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(\n      this._settingsNamespace,\n      this._useProximityOpacityKey,\n      v\n    );\n  }\n\n  public static async storeSnapWidgetOpacity(\n    v: boolean,\n    storage?: UiStateStorage\n  ) {\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(\n      this._settingsNamespace,\n      this._snapWidgetOpacityKey,\n      v\n    );\n  }\n}\n\n/** The default inactivity time.\n * @internal\n */\nexport const INACTIVITY_TIME_DEFAULT = 3500; /** Wait 3.5 seconds */\n\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\n * @internal\n */\nexport class InternalUiShowHideManager {\n  private static _isUiVisible: boolean = true;\n  private static _autoHideUi: boolean = true;\n  private static _showHidePanels: boolean = false;\n  private static _showHideFooter: boolean = false;\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\n  private static _timeout: number;\n  private static _useProximityOpacity: boolean = false;\n  private static _snapWidgetOpacity: boolean = false;\n\n  /** Determines if the Ui is visible */\n  public static get isUiVisible() {\n    return InternalUiShowHideManager._isUiVisible;\n  }\n  public static set isUiVisible(visible: boolean) {\n    if (this._isUiVisible === visible) return;\n    InternalUiShowHideManager._isUiVisible = visible;\n    UiFramework.onUiVisibilityChanged.emit({ visible });\n  }\n\n  public static setAutoHideUi(value: boolean) {\n    InternalUiShowHideManager._autoHideUi = value;\n  }\n\n  public static setUseProximityOpacity(value: boolean) {\n    InternalUiShowHideManager._useProximityOpacity = value;\n  }\n\n  public static setSnapWidgetOpacity(value: boolean) {\n    InternalUiShowHideManager._snapWidgetOpacity = value;\n  }\n\n  public static get autoHideUi(): boolean {\n    return InternalUiShowHideManager._autoHideUi;\n  }\n\n  public static set autoHideUi(autoHide: boolean) {\n    if (this._autoHideUi === autoHide) return;\n\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\n    if (!autoHide) {\n      this.isUiVisible = true;\n    }\n    this._autoHideUi = autoHide;\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(\n      SyncUiEventId.ShowHideManagerSettingChange\n    );\n  }\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\n  public static get showHidePanels(): boolean {\n    return InternalUiShowHideManager._showHidePanels;\n  }\n  public static set showHidePanels(showHide: boolean) {\n    InternalUiShowHideManager._showHidePanels = showHide;\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: this.isUiVisible,\n    });\n  }\n\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\n  public static get showHideFooter(): boolean {\n    return InternalUiShowHideManager._showHideFooter;\n  }\n  public static set showHideFooter(showHide: boolean) {\n    InternalUiShowHideManager._showHideFooter = showHide;\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: this.isUiVisible,\n    });\n  }\n\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\n  public static get inactivityTime(): number {\n    return InternalUiShowHideManager._inactivityTime;\n  }\n  public static set inactivityTime(time: number) {\n    InternalUiShowHideManager._inactivityTime = time;\n  }\n\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\n  public static get useProximityOpacity(): boolean {\n    return InternalUiShowHideManager._useProximityOpacity;\n  }\n  public static set useProximityOpacity(value: boolean) {\n    InternalUiShowHideManager._useProximityOpacity = value;\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(\n      SyncUiEventId.ShowHideManagerSettingChange\n    );\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: this.isUiVisible,\n    });\n  }\n\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\n  public static get snapWidgetOpacity(): boolean {\n    return InternalUiShowHideManager._snapWidgetOpacity;\n  }\n  public static set snapWidgetOpacity(value: boolean) {\n    InternalUiShowHideManager._snapWidgetOpacity = value;\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(\n      SyncUiEventId.ShowHideManagerSettingChange\n    );\n    UiFramework.onUiVisibilityChanged.emit({\n      visible: this.isUiVisible,\n    });\n  }\n\n  /** Handler for when a Frontstage is ready */\n  public static handleFrontstageReady() {\n    if (!InternalUiShowHideManager._autoHideUi) return;\n    InternalUiShowHideManager.showUiAndResetTimer();\n  }\n\n  /** Handler for when the mouse moves over the content area */\n  public static handleContentMouseMove(\n    _event?: React.MouseEvent<HTMLElement, MouseEvent>\n  ) {\n    if (!InternalUiShowHideManager._autoHideUi) return;\n    InternalUiShowHideManager.showUiAndResetTimer();\n  }\n\n  /** Handler for when the mouse enters a widget */\n  public static handleWidgetMouseEnter(\n    _event?: React.MouseEvent<HTMLElement, MouseEvent>\n  ) {\n    if (!InternalUiShowHideManager._autoHideUi) return;\n    InternalUiShowHideManager.showUiAndCancelTimer();\n  }\n\n  /** Shows the Ui and resets the inactivity timer */\n  public static showUiAndResetTimer() {\n    this.isUiVisible = true;\n\n    window.clearTimeout(this._timeout);\n    if (!this._autoHideUi) return;\n    this._timeout = window.setTimeout(() => {\n      this.isUiVisible = false;\n    }, this._inactivityTime);\n  }\n\n  /** Shows the Ui and cancels the inactivity timer */\n  public static showUiAndCancelTimer() {\n    this.isUiVisible = true;\n    window.clearTimeout(this._timeout);\n  }\n\n  public static terminate() {\n    window.clearTimeout(this._timeout);\n    this._isUiVisible = true;\n    this._autoHideUi = true;\n    this._showHidePanels = false;\n    this._showHideFooter = false;\n    this._inactivityTime = INACTIVITY_TIME_DEFAULT;\n    this._useProximityOpacity = false;\n    this._snapWidgetOpacity = false;\n  }\n}\n"]}

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

@@ -7,13 +7,14 @@ import type { StringGetter, AbstractWidgetProps as UIA_AbstractWidgetProps, Comm
 import { ConditionalStringValue } from "@itwin/appui-abstract";
 /** A set of helper methods for various props
  * @public
+ * @deprecated in 4.16.0. Used internally.
  */
 export declare class PropsHelper {
     /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
     static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue;
     /** Get the display string. */
     static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string;
-    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
+    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed. */
     static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): React.ReactElement | undefined;
     /** returns true if the two objects are the same using a shallow compare of each property */
     static isShallowEqual(newObj: any, prevObj: any): boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACV,YAAY,EAEZ,mBAAmB,IAAI,uBAAuB,EAE9C,mBAAmB,IAAI,uBAAuB,EAC/C,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAG/D;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CACzB,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EACzE,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAWjD,8BAA8B;WAChB,iBAAiB,CAC7B,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GACnD,MAAM;IAQT,+JAA+J;WACjJ,OAAO,CACnB,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAC1D,KAAK,CAAC,YAAY,GAAG,SAAS;IAOjC,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;IAOtD,kEAAkE;WACpD,4BAA4B,CACxC,QAAQ,EAAE,QAAQ,EAClB,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAE9B,OAAO,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAUvE"}
+{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACV,YAAY,EAEZ,mBAAmB,IAAI,uBAAuB,EAE9C,mBAAmB,IAAI,uBAAuB,EAC/C,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAG/D;;;GAGG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CACzB,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EACzE,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAWjD,8BAA8B;WAChB,iBAAiB,CAC7B,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GACnD,MAAM;IAQT,8JAA8J;WAChJ,OAAO,CACnB,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAC1D,KAAK,CAAC,YAAY,GAAG,SAAS;IASjC,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;IAOtD,kEAAkE;WACpD,4BAA4B,CAExC,QAAQ,EAAE,QAAQ,EAClB,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAE9B,OAAO,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAUvE"}

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

@@ -15,6 +15,7 @@ const appui_abstract_1 = require("@itwin/appui-abstract");
 const core_frontend_1 = require("@itwin/core-frontend");
 /** A set of helper methods for various props
  * @public
+ * @deprecated in 4.16.0. Used internally.
  */
 class PropsHelper {
     /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
@@ -38,10 +39,12 @@ class PropsHelper {
             label = spec();
         return label;
     }
-    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
+    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed. */
     static getIcon(iconSpec) {
         if (iconSpec instanceof appui_abstract_1.ConditionalStringValue)
+            // eslint-disable-next-line deprecation/deprecation
             return React.createElement(core_react_1.Icon, { iconSpec: iconSpec.value });
+        // eslint-disable-next-line deprecation/deprecation
         return iconSpec ? React.createElement(core_react_1.Icon, { iconSpec: iconSpec }) : undefined;
     }
     /** returns true if the two objects are the same using a shallow compare of each property */
@@ -53,7 +56,9 @@ class PropsHelper {
         return true;
     }
     /** @deprecated in 4.0 These abstract props types are obsolete. */
-    static getAbstractPropsForReactIcon(iconSpec, internalData
+    static getAbstractPropsForReactIcon(
+    // eslint-disable-next-line deprecation/deprecation
+    iconSpec, internalData
     // eslint-disable-next-line deprecation/deprecation
     ) {
         if (!iconSpec || !React.isValidElement(iconSpec))

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

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAsD;AAEtD,+BAA+B;AAE/B,kDAAqD;AAQrD,0DAA+D;AAC/D,wDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CACzB,aAAyE,EACzE,SAAkB;QAElB,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,MAAM,QAAQ,GAAG,SAAS;YACxB,CAAC,CAAC,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC;YACtD,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAC7B,IAAoD;QAEpD,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,KAAK,GAAG,IAAI,CAAC;aACtC,IAAI,IAAI,YAAY,uCAAsB;YAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAC/D,KAAK,GAAG,IAAI,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IACxJ,MAAM,CAAC,OAAO,CACnB,QAA2D;QAE3D,IAAI,QAAQ,YAAY,uCAAsB;YAC5C,OAAO,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,QAAQ,CAAC,CAAC,CAAC,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,MAAM,CAAC,4BAA4B,CACxC,QAAkB,EAClB,YAA+B;IAC/B,mDAAmD;;QAEnD,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QAE5D,IAAI,CAAC,YAAY;YAAE,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC;QAEzD,mDAAmD;QACnD,MAAM,IAAI,GAAG,uBAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IACzD,CAAC;CACF;AA5DD,kCA4DC","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 Utilities\n */\n\n/* eslint-disable @typescript-eslint/ban-ts-comment */\n\nimport * as React from \"react\";\nimport type { IconSpec } from \"@itwin/core-react\";\nimport { Icon, IconHelper } from \"@itwin/core-react\";\nimport type {\n  StringGetter,\n  // @ts-ignore Removed in 4.0\n  AbstractWidgetProps as UIA_AbstractWidgetProps,\n  // @ts-ignore Removed in 4.0\n  CommonBackstageItem as UIA_CommonBackstageItem,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalStringValue } from \"@itwin/appui-abstract\";\nimport { IModelApp } from \"@itwin/core-frontend\";\n\n/** A set of helper methods for various props\n * @public\n */\nexport class PropsHelper {\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\n  public static getStringSpec(\n    explicitValue: string | StringGetter | ConditionalStringValue | undefined,\n    stringKey?: string\n  ): string | StringGetter | ConditionalStringValue {\n    if (explicitValue) {\n      return explicitValue;\n    }\n\n    const outValue = stringKey\n      ? IModelApp.localization.getLocalizedString(stringKey)\n      : \"\";\n    return outValue;\n  }\n\n  /** Get the display string. */\n  public static getStringFromSpec(\n    spec: string | StringGetter | ConditionalStringValue\n  ): string {\n    let label = \"\";\n    if (typeof spec === \"string\") label = spec;\n    else if (spec instanceof ConditionalStringValue) label = spec.value;\n    else label = spec();\n    return label;\n  }\n\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\n  public static getIcon(\n    iconSpec: string | ConditionalStringValue | React.ReactNode\n  ): React.ReactElement | undefined {\n    if (iconSpec instanceof ConditionalStringValue)\n      return <Icon iconSpec={iconSpec.value} />;\n\n    return iconSpec ? <Icon iconSpec={iconSpec} /> : undefined;\n  }\n\n  /** returns true if the two objects are the same using a shallow compare of each property */\n  public static isShallowEqual(newObj: any, prevObj: any) {\n    for (const key in newObj) {\n      if (newObj[key] !== prevObj[key]) return false;\n    }\n    return true;\n  }\n\n  /** @deprecated in 4.0 These abstract props types are obsolete. */\n  public static getAbstractPropsForReactIcon(\n    iconSpec: IconSpec,\n    internalData?: Map<string, any>\n    // eslint-disable-next-line deprecation/deprecation\n  ): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem> {\n    if (!iconSpec || !React.isValidElement(iconSpec)) return {};\n\n    if (!internalData) internalData = new Map<string, any>();\n\n    // eslint-disable-next-line deprecation/deprecation\n    const icon = IconHelper.getIconData(iconSpec, internalData);\n\n    return icon === \"\" ? { icon } : { icon, internalData };\n  }\n}\n"]}
+{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAsD;AAEtD,+BAA+B;AAE/B,kDAAqD;AAQrD,0DAA+D;AAC/D,wDAAiD;AAEjD;;;GAGG;AACH,MAAa,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CACzB,aAAyE,EACzE,SAAkB;QAElB,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,MAAM,QAAQ,GAAG,SAAS;YACxB,CAAC,CAAC,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC;YACtD,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAC7B,IAAoD;QAEpD,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,KAAK,GAAG,IAAI,CAAC;aACtC,IAAI,IAAI,YAAY,uCAAsB;YAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAC/D,KAAK,GAAG,IAAI,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8JAA8J;IACvJ,MAAM,CAAC,OAAO,CACnB,QAA2D;QAE3D,IAAI,QAAQ,YAAY,uCAAsB;YAC5C,mDAAmD;YACnD,OAAO,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,mDAAmD;QACnD,OAAO,QAAQ,CAAC,CAAC,CAAC,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,MAAM,CAAC,4BAA4B;IACxC,mDAAmD;IACnD,QAAkB,EAClB,YAA+B;IAC/B,mDAAmD;;QAEnD,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QAE5D,IAAI,CAAC,YAAY;YAAE,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC;QAEzD,mDAAmD;QACnD,MAAM,IAAI,GAAG,uBAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IACzD,CAAC;CACF;AA/DD,kCA+DC","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 Utilities\n */\n\n/* eslint-disable @typescript-eslint/ban-ts-comment */\n\nimport * as React from \"react\";\nimport type { IconSpec } from \"@itwin/core-react\";\nimport { Icon, IconHelper } from \"@itwin/core-react\";\nimport type {\n  StringGetter,\n  // @ts-ignore Removed in 4.0\n  AbstractWidgetProps as UIA_AbstractWidgetProps,\n  // @ts-ignore Removed in 4.0\n  CommonBackstageItem as UIA_CommonBackstageItem,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalStringValue } from \"@itwin/appui-abstract\";\nimport { IModelApp } from \"@itwin/core-frontend\";\n\n/** A set of helper methods for various props\n * @public\n * @deprecated in 4.16.0. Used internally.\n */\nexport class PropsHelper {\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\n  public static getStringSpec(\n    explicitValue: string | StringGetter | ConditionalStringValue | undefined,\n    stringKey?: string\n  ): string | StringGetter | ConditionalStringValue {\n    if (explicitValue) {\n      return explicitValue;\n    }\n\n    const outValue = stringKey\n      ? IModelApp.localization.getLocalizedString(stringKey)\n      : \"\";\n    return outValue;\n  }\n\n  /** Get the display string. */\n  public static getStringFromSpec(\n    spec: string | StringGetter | ConditionalStringValue\n  ): string {\n    let label = \"\";\n    if (typeof spec === \"string\") label = spec;\n    else if (spec instanceof ConditionalStringValue) label = spec.value;\n    else label = spec();\n    return label;\n  }\n\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed. */\n  public static getIcon(\n    iconSpec: string | ConditionalStringValue | React.ReactNode\n  ): React.ReactElement | undefined {\n    if (iconSpec instanceof ConditionalStringValue)\n      // eslint-disable-next-line deprecation/deprecation\n      return <Icon iconSpec={iconSpec.value} />;\n\n    // eslint-disable-next-line deprecation/deprecation\n    return iconSpec ? <Icon iconSpec={iconSpec} /> : undefined;\n  }\n\n  /** returns true if the two objects are the same using a shallow compare of each property */\n  public static isShallowEqual(newObj: any, prevObj: any) {\n    for (const key in newObj) {\n      if (newObj[key] !== prevObj[key]) return false;\n    }\n    return true;\n  }\n\n  /** @deprecated in 4.0 These abstract props types are obsolete. */\n  public static getAbstractPropsForReactIcon(\n    // eslint-disable-next-line deprecation/deprecation\n    iconSpec: IconSpec,\n    internalData?: Map<string, any>\n    // eslint-disable-next-line deprecation/deprecation\n  ): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem> {\n    if (!iconSpec || !React.isValidElement(iconSpec)) return {};\n\n    if (!internalData) internalData = new Map<string, any>();\n\n    // eslint-disable-next-line deprecation/deprecation\n    const icon = IconHelper.getIconData(iconSpec, internalData);\n\n    return icon === \"\" ? { icon } : { icon, internalData };\n  }\n}\n"]}

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

@@ -0,0 +1,9 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import type { RectangleProps as _RectangleProps } from "@itwin/core-react";
+/** Describes 2d bounds.
+ * @public
+ */
+export type RectangleProps = _RectangleProps;
+//# sourceMappingURL=RectangleProps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RectangleProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/RectangleProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE3E;;GAEG;AAEH,MAAM,MAAM,cAAc,GAAG,eAAe,CAAC"}

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

@@ -0,0 +1,10 @@
+"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 });
+//# sourceMappingURL=RectangleProps.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RectangleProps.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/RectangleProps.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","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 Utilities\n */\n\nimport type { RectangleProps as _RectangleProps } from \"@itwin/core-react\";\n\n/** Describes 2d bounds.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport type RectangleProps = _RectangleProps;\n"]}

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

@@ -0,0 +1,9 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import type { SizeProps as _SizeProps } from "@itwin/core-react";
+/** Describes 2d dimensions.
+ * @public
+ */
+export type SizeProps = _SizeProps;
+//# sourceMappingURL=SizeProps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SizeProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/SizeProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,IAAI,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEjE;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC"}

package/lib/cjs/appui-react/{widget-panels/Tab.scss → utils/SizeProps.js}

@@ -1,14 +1,10 @@
+"use strict";
 /*---------------------------------------------------------------------------------------------
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-.nz-widget-tab {
-  &.uifw-badge-new {
-    &.nz-active {
-      &:before {
-        width: calc(100% - 1em) !important;
-        left: 0.5em !important;
-      }
-    }
-  }
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SizeProps.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SizeProps.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/SizeProps.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","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 Utilities\n */\n\nimport type { SizeProps as _SizeProps } from \"@itwin/core-react\";\n\n/** Describes 2d dimensions.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport type SizeProps = _SizeProps;\n"]}

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

@@ -1,8 +1,6 @@
 /** @packageDocumentation
  * @module Frontstage
  */
-import type { UiStateStorageResult } from "@itwin/core-react";
-import { UiStateStorageStatus } from "@itwin/core-react";
 import * as React from "react";
 import type { FrontstageDef } from "../frontstage/FrontstageDef";
 import type { NineZoneDispatch, NineZoneLabels } from "../layout/base/NineZone";
@@ -11,6 +9,8 @@ import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
 import { StagePanelSection } from "../stagepanels/StagePanelSection";
 import type { WidgetDef } from "../widgets/WidgetDef";
 import "./Frontstage.scss";
+import type { UiStateStorageResult } from "../uistate/UiStateStorage";
+import { UiStateStorageStatus } from "../uistate/UiStateStorage";
 /** @internal */
 export declare function useLayoutStore(frontstageDef: FrontstageDef | undefined): import("../layout/base/LayoutStore").LayoutStore;
 /** Update in-memory NineZoneState of newly activated frontstage with up to date size.
@@ -43,13 +43,13 @@ export declare function getPanelSectionId(location: StagePanelLocation, section:
 export declare function getPanelSectionWidgets(frontstageDef: FrontstageDef, location: StagePanelLocation, section: StagePanelSection): ReadonlyArray<WidgetDef>;
 /** @internal */
 export declare function isFrontstageStateSettingResult(settingsResult: UiStateStorageResult): settingsResult is {
-    status: UiStateStorageStatus.Success;
+    status: typeof UiStateStorageStatus.Success;
     setting: WidgetPanelsFrontstageState;
 };
 /** @internal */
 export declare function initializePanel(frontstageDef: FrontstageDef, location: StagePanelLocation): void;
 /** @internal */
-export declare const stateVersion = 17;
+export declare const stateVersion = 18;
 /** @internal */
 export declare function initializeNineZoneState(frontstageDef: FrontstageDef): void;
 /** Converts from saved NineZoneState to NineZoneState.

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

@@ -1 +1 @@
-{"version":3,"file":"Frontstage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Frontstage.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAQ,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAMjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGhF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAKrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAItD,OAAO,mBAAmB,CAAC;AAgE3B,gBAAgB;AAChB,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,oDAiBtE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,QAYjE;AAYD,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,oBAwB/D;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,6BAerC;AAMD,UAAU,gCAAgC;IACxC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAC1C,aAAa,GACd,EAAE,gCAAgC,qBAiElC;AAED,gBAAgB;AAChB,wBAAgB,SAAS,IAAI,cAAc,CAc1C;AA0DD;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,QAS3B;AA4BD;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QAuBnE;AAsDD,KAAK,cAAc,GAAG,GAAG,SAAS,CAChC,MAAM,OAAO,kBAAkB,CAChC,GAAG,MAAM,OAAO,iBAAiB,EAAE,CAAC;AAErC,gBAAgB;AAChB,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,cAAc,CAIhB;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,aAAa,CAAC,SAAS,CAAC,CAI1B;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAC5C,cAAc,EAAE,oBAAoB,GACnC,cAAc,IAAI;IACnB,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACrC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAGA;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,QAoD7B;AAED,gBAAgB;AAChB,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QAkBnE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,aAAa,QAuFtB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,CASrE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,aAAa,CAAC;IACxB,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,mHAAmH;IACnH,OAAO,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QA4CnE;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE,gBAAgB;AAChB,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,2BAA2B,CAAC,IAAI,CAAC,UAGhD;AAED,gBAAgB;AAChB,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,0BAA0B,CAAC,EAAE,OAAO,QA8DrC;AAWD,gBAAgB;AAChB,wBAAgB,eAAe,CAAC,aAAa,EAAE,aAAa,QAa3D"}
+{"version":3,"file":"Frontstage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/widget-panels/Frontstage.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAOH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAMjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGhF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAKrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAItD,OAAO,mBAAmB,CAAC;AAqB3B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AA4CjE,gBAAgB;AAChB,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,oDAiBtE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,QAYjE;AAYD,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,aAAa,oBAwB/D;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,6BAerC;AAMD,UAAU,gCAAgC;IACxC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAC1C,aAAa,GACd,EAAE,gCAAgC,qBAiElC;AAED,gBAAgB;AAChB,wBAAgB,SAAS,IAAI,cAAc,CAc1C;AAyDD;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,QAS3B;AA4BD;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QAuBnE;AAsDD,KAAK,cAAc,GAAG,GAAG,SAAS,CAChC,MAAM,OAAO,kBAAkB,CAChC,GAAG,MAAM,OAAO,iBAAiB,EAAE,CAAC;AAErC,gBAAgB;AAChB,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,cAAc,CAIhB;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,GACzB,aAAa,CAAC,SAAS,CAAC,CAI1B;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAC5C,cAAc,EAAE,oBAAoB,GACnC,cAAc,IAAI;IACnB,MAAM,EAAE,OAAO,oBAAoB,CAAC,OAAO,CAAC;IAC5C,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAGA;AAED,gBAAgB;AAChB,wBAAgB,eAAe,CAC7B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,QAoD7B;AAED,gBAAgB;AAChB,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QAkBnE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,aAAa,QAuFtB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,aAAa,GAAG,aAAa,CAQrE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,aAAa,CAAC;IACxB,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACxB,mHAAmH;IACnH,OAAO,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,aAAa,QA4CnE;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,4BAA4B,CAAC;AAEvE,gBAAgB;AAChB,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,2BAA2B,CAAC,IAAI,CAAC,UAGhD;AAED,gBAAgB;AAChB,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,aAAa,EAC5B,0BAA0B,CAAC,EAAE,OAAO,QA8DrC;AAWD,gBAAgB;AAChB,wBAAgB,eAAe,CAAC,aAAa,EAAE,aAAa,QAa3D"}

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

@@ -56,6 +56,7 @@ const PopoutWidgets_1 = require("../preview/reparent-popout-widgets/PopoutWidget
 const useReduxFrameworkState_1 = require("../uistate/useReduxFrameworkState");
 const ConfigurableUiContent_1 = require("../configurableui/ConfigurableUiContent");
 const useSaveFrontstageSettings_1 = require("./useSaveFrontstageSettings");
+const UiStateStorage_1 = require("../uistate/UiStateStorage");
 function WidgetPanelsFrontstageComponent() {
     const activeModalFrontstageInfo = (0, ModalFrontstageComposer_1.useActiveModalFrontstageInfo)();
     const uiIsVisible = (0, useUiVisibility_1.useUiVisibility)();
@@ -216,7 +217,6 @@ function toTabArgs(widget) {
         allowedPanelTargets: widget.allowedPanelTargets?.map((location) => (0, StagePanelDef_1.toPanelSide)(location)),
         hideWithUiWhenFloating: !!widget.hideWithUiWhenFloating,
         canPopout: widget.canPopout,
-        iconSpec: widget.iconSpec,
         isFloatingWidgetResizable: widget.isFloatingStateWindowResizable,
         label,
         preferredFloatingWidgetSize: widget.defaultFloatingSize,
@@ -375,7 +375,7 @@ function getPanelSectionWidgets(frontstageDef, location, section) {
 exports.getPanelSectionWidgets = getPanelSectionWidgets;
 /** @internal */
 function isFrontstageStateSettingResult(settingsResult) {
-    if (settingsResult.status === core_react_1.UiStateStorageStatus.Success)
+    if (settingsResult.status === UiStateStorage_1.UiStateStorageStatus.Success)
         return true;
     return false;
 }
@@ -427,7 +427,7 @@ function initializePanel(frontstageDef, location) {
 }
 exports.initializePanel = initializePanel;
 /** @internal */
-exports.stateVersion = 17; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
+exports.stateVersion = 18; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
 /** @internal */
 function initializeNineZoneState(frontstageDef) {
     frontstageDef.batch(() => {
@@ -523,7 +523,6 @@ function packNineZoneState(state) {
     packed = (0, immer_1.default)(packed, (draft) => {
         for (const [, tab] of Object.entries(draft.tabs)) {
             tab.label = "";
-            delete tab.iconSpec;
         }
     });
     return packed;