@itwin/appui-react 4.0.0-dev.1 → 4.0.0-dev.10

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

@@ -0,0 +1,84 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+/// <reference types="react" />
+import { UiStateStorage } from "@itwin/core-react";
+import { UserSettingsProvider } from "../UiFramework";
+/** Class that maintain UiShowHide user settings between sessions
+ * @internal
+ */
+export declare class UiShowHideSettingsProvider implements UserSettingsProvider {
+    private static _settingsNamespace;
+    private static _autoHideUiKey;
+    private static _useProximityOpacityKey;
+    private static _snapWidgetOpacityKey;
+    readonly providerId = "UiShowHideSettingsProvider";
+    static initialize(): void;
+    loadUserSettings(storage: UiStateStorage): Promise<void>;
+    static storeAutoHideUi(v: boolean, storage?: UiStateStorage): Promise<void>;
+    static storeUseProximityOpacity(v: boolean, storage?: UiStateStorage): Promise<void>;
+    static storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage): Promise<void>;
+}
+/** The default inactivity time.
+ * @internal
+ */
+export declare const INACTIVITY_TIME_DEFAULT = 3500; /** Wait 3.5 seconds */
+/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.
+ * @internal
+ */
+export declare class InternalUiShowHideManager {
+    private static _isUiVisible;
+    private static _autoHideUi;
+    private static _showHidePanels;
+    private static _showHideFooter;
+    private static _inactivityTime;
+    private static _timeout;
+    private static _useProximityOpacity;
+    private static _snapWidgetOpacity;
+    /** Determines if the Ui is visible */
+    static get isUiVisible(): boolean;
+    static set isUiVisible(visible: boolean);
+    /** @internal */
+    static setAutoHideUi(value: boolean): void;
+    /** @internal */
+    static setUseProximityOpacity(value: boolean): void;
+    /** @internal */
+    static setSnapWidgetOpacity(value: boolean): void;
+    /** 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(): boolean;
+    static set autoHideUi(autoHide: boolean);
+    /** Determines whether the widget panels are shown and hidden. Defaults to false. */
+    static get showHidePanels(): boolean;
+    static set showHidePanels(showHide: boolean);
+    /** Determines whether the status bar is shown and hidden. Defaults to false. */
+    static get showHideFooter(): boolean;
+    static set showHideFooter(showHide: boolean);
+    /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
+    static get inactivityTime(): number;
+    static set inactivityTime(time: number);
+    /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
+    static get useProximityOpacity(): boolean;
+    static set useProximityOpacity(value: boolean);
+    /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
+    static get snapWidgetOpacity(): boolean;
+    static set snapWidgetOpacity(value: boolean);
+    /** Handler for when a Frontstage is ready */
+    static handleFrontstageReady(): void;
+    /** Handler for when the mouse moves over the content area */
+    static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
+    /** Handler for when the mouse enters a widget */
+    static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
+    /** Shows the Ui and resets the inactivity timer */
+    static showUiAndResetTimer(): void;
+    /** Shows the Ui and cancels the inactivity timer */
+    static showUiAndCancelTimer(): void;
+    private static cancelTimer;
+    private static resetTimer;
+    private static showUi;
+    private static hideUi;
+    /** @internal */
+    static terminate(): void;
+}
+//# sourceMappingURL=InternalUiShowHideManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalUiShowHideManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAE,cAAc,EAAwB,MAAM,mBAAmB,CAAC;AAEzE,OAAO,EAAe,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEnE;;GAEG;AACH,qBAAa,0BAA2B,YAAW,oBAAoB;IACrE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAgB;IAC7C,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAyB;IAC/D,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAuB;IAC3D,SAAgB,UAAU,gCAAgC;WAE5C,UAAU;IAIX,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;WAcjD,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc;WAIpD,wBAAwB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc;WAI7D,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc;CAGhF;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAO,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAiB;IAC5C,OAAO,CAAC,MAAM,CAAC,WAAW,CAAiB;IAC3C,OAAO,CAAC,MAAM,CAAC,eAAe,CAAkB;IAChD,OAAO,CAAC,MAAM,CAAC,eAAe,CAAkB;IAChD,OAAO,CAAC,MAAM,CAAC,eAAe,CAAmC;IACjE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiB;IACxC,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAkB;IACrD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAkB;IAEnD,sCAAsC;IACtC,WAAkB,WAAW,IAGU,OAAO,CAD7C;IACD,WAAkB,WAAW,CAAC,OAAO,EAAE,OAAO,EAE7C;IAED,gBAAgB;WACF,aAAa,CAAC,KAAK,EAAE,OAAO;IAI1C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,OAAO;IAInD,gBAAgB;WACF,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAIjD;;OAEG;IACH,WAAkB,UAAU,IAAI,OAAO,CAEtC;IAED,WAAkB,UAAU,CAAC,QAAQ,EAAE,OAAO,EAI7C;IACD,oFAAoF;IACpF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAGjD;IAED,gFAAgF;IAChF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAGjD;IAED,iGAAiG;IACjG,WAAkB,cAAc,IAAI,MAAM,CAEzC;IACD,WAAkB,cAAc,CAAC,IAAI,EAAE,MAAM,EAE5C;IAED,6GAA6G;IAC7G,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;IACD,WAAkB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAKnD;IAED,kFAAkF;IAClF,WAAkB,iBAAiB,IAAI,OAAO,CAE7C;IACD,WAAkB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAKjD;IAED,6CAA6C;WAC/B,qBAAqB;IAQnC,6DAA6D;WAC/C,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAOvF,iDAAiD;WACnC,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAOvF,mDAAmD;WACrC,mBAAmB;IAOjC,oDAAoD;WACtC,oBAAoB;IAOlC,OAAO,CAAC,MAAM,CAAC,WAAW;IAI1B,OAAO,CAAC,MAAM,CAAC,UAAU;IAKzB,OAAO,CAAC,MAAM,CAAC,MAAM;IAIrB,OAAO,CAAC,MAAM,CAAC,MAAM;IAIrB,gBAAgB;WACF,SAAS;CAWxB"}

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

@@ -0,0 +1,198 @@
+"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.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");
+/** 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.UiStateStorageStatus.Success)
+            InternalUiShowHideManager.setAutoHideUi(result.setting);
+        result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);
+        if (result.status === core_react_1.UiStateStorageStatus.Success)
+            InternalUiShowHideManager.setUseProximityOpacity(result.setting);
+        result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);
+        if (result.status === core_react_1.UiStateStorageStatus.Success)
+            InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);
+    }
+    static async storeAutoHideUi(v, storage) {
+        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);
+    }
+    static async storeUseProximityOpacity(v, storage) {
+        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);
+    }
+    static async storeSnapWidgetOpacity(v, storage) {
+        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiStateStorage()).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.
+ * @internal
+ */
+class InternalUiShowHideManager {
+    /** Determines if the Ui is visible */
+    static get isUiVisible() {
+        return InternalUiShowHideManager._isUiVisible;
+    }
+    static set isUiVisible(visible) {
+        InternalUiShowHideManager._isUiVisible = visible;
+    }
+    /** @internal */
+    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) {
+        void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);
+        InternalUiShowHideManager._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 InternalUiShowHideManager._showHidePanels;
+    }
+    static set showHidePanels(showHide) {
+        InternalUiShowHideManager._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 InternalUiShowHideManager._showHideFooter;
+    }
+    static set showHideFooter(showHide) {
+        InternalUiShowHideManager._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 InternalUiShowHideManager._inactivityTime;
+    }
+    static set inactivityTime(time) {
+        InternalUiShowHideManager._inactivityTime = time;
+    }
+    /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
+    static get useProximityOpacity() {
+        return InternalUiShowHideManager._useProximityOpacity;
+    }
+    static set useProximityOpacity(value) {
+        InternalUiShowHideManager._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 InternalUiShowHideManager._snapWidgetOpacity;
+    }
+    static set snapWidgetOpacity(value) {
+        InternalUiShowHideManager._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() {
+        // istanbul ignore next
+        if (!InternalUiShowHideManager._autoHideUi)
+            return;
+        InternalUiShowHideManager.showUiAndResetTimer();
+    }
+    /** Handler for when the mouse moves over the content area */
+    static handleContentMouseMove(_event) {
+        if (!InternalUiShowHideManager._autoHideUi)
+            return;
+        InternalUiShowHideManager.showUiAndResetTimer();
+    }
+    /** Handler for when the mouse enters a widget */
+    static handleWidgetMouseEnter(_event) {
+        if (!InternalUiShowHideManager._autoHideUi)
+            return;
+        InternalUiShowHideManager.showUiAndCancelTimer();
+    }
+    /** Shows the Ui and resets the inactivity timer */
+    static showUiAndResetTimer() {
+        setTimeout(() => {
+            InternalUiShowHideManager.showUi();
+            InternalUiShowHideManager.resetTimer();
+        });
+    }
+    /** Shows the Ui and cancels the inactivity timer */
+    static showUiAndCancelTimer() {
+        setTimeout(() => {
+            InternalUiShowHideManager.showUi();
+            InternalUiShowHideManager.cancelTimer();
+        });
+    }
+    static cancelTimer() {
+        clearTimeout(InternalUiShowHideManager._timeout);
+    }
+    static resetTimer() {
+        InternalUiShowHideManager.cancelTimer();
+        InternalUiShowHideManager._timeout = setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._inactivityTime);
+    }
+    static showUi() {
+        UiFramework_1.UiFramework.setIsUiVisible(true);
+    }
+    static hideUi() {
+        UiFramework_1.UiFramework.setIsUiVisible(false);
+    }
+    /** @internal */
+    static terminate() {
+        InternalUiShowHideManager.cancelTimer();
+        // Ensure that next use will have default values for tests.
+        InternalUiShowHideManager._isUiVisible = true;
+        InternalUiShowHideManager._autoHideUi = true;
+        InternalUiShowHideManager._showHidePanels = false;
+        InternalUiShowHideManager._showHideFooter = false;
+        InternalUiShowHideManager._inactivityTime = exports.INACTIVITY_TIME_DEFAULT;
+        InternalUiShowHideManager._useProximityOpacity = false;
+        InternalUiShowHideManager._snapWidgetOpacity = false;
+    }
+}
+exports.InternalUiShowHideManager = InternalUiShowHideManager;
+InternalUiShowHideManager._isUiVisible = true;
+InternalUiShowHideManager._autoHideUi = true;
+InternalUiShowHideManager._showHidePanels = false;
+InternalUiShowHideManager._showHideFooter = false;
+InternalUiShowHideManager._inactivityTime = exports.INACTIVITY_TIME_DEFAULT;
+InternalUiShowHideManager._useProximityOpacity = false;
+InternalUiShowHideManager._snapWidgetOpacity = false;
+//# sourceMappingURL=InternalUiShowHideManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,kDAAyE;AACzE,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,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAChI,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,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;QACrI,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,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;QACnI,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,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACjH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAU,EAAE,OAAwB;QAC/E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IAC1H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAU,EAAE,OAAwB;QAC7E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;IACxH,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,yBAAyB;IAUpC,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,gBAAgB;IACT,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,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;IACjG,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,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,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,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,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,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,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,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,uBAAuB;QACvB,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,yBAAyB,CAAC,QAAQ,GAAG,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAC/H,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,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,2DAA2D;QAC3D,yBAAyB,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9C,yBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC7C,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,+BAAuB,CAAC;QACpE,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;;AAlKH,8DAmKC;AAlKgB,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":["/*---------------------------------------------------------------------------------------------\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 { UiStateStorage, UiStateStorageStatus } 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: UiStateStorage): Promise<void> {\r\n    let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\r\n  }\r\n\r\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);\r\n  }\r\n\r\n  public static async storeUseProximityOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);\r\n  }\r\n\r\n  public static async storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).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 * @internal\r\n */\r\nexport class InternalUiShowHideManager {\r\n  private static _isUiVisible: boolean = true;\r\n  private static _autoHideUi: boolean = true;\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 = false;\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 InternalUiShowHideManager._isUiVisible;\r\n  }\r\n  public static set isUiVisible(visible: boolean) {\r\n    InternalUiShowHideManager._isUiVisible = visible;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setAutoHideUi(value: boolean) {\r\n    InternalUiShowHideManager._autoHideUi = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setUseProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setSnapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._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 InternalUiShowHideManager._autoHideUi;\r\n  }\r\n\r\n  public static set autoHideUi(autoHide: boolean) {\r\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\r\n    InternalUiShowHideManager._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 InternalUiShowHideManager._showHidePanels;\r\n  }\r\n  public static set showHidePanels(showHide: boolean) {\r\n    InternalUiShowHideManager._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 InternalUiShowHideManager._showHideFooter;\r\n  }\r\n  public static set showHideFooter(showHide: boolean) {\r\n    InternalUiShowHideManager._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 InternalUiShowHideManager._inactivityTime;\r\n  }\r\n  public static set inactivityTime(time: number) {\r\n    InternalUiShowHideManager._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 InternalUiShowHideManager._useProximityOpacity;\r\n  }\r\n  public static set useProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._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 InternalUiShowHideManager._snapWidgetOpacity;\r\n  }\r\n  public static set snapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._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    // istanbul ignore next\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.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 (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.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 (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.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      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.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      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.cancelTimer();\r\n    });\r\n  }\r\n\r\n  private static cancelTimer() {\r\n    clearTimeout(InternalUiShowHideManager._timeout);\r\n  }\r\n\r\n  private static resetTimer() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    InternalUiShowHideManager._timeout = setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._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    InternalUiShowHideManager.cancelTimer();\r\n    // Ensure that next use will have default values for tests.\r\n    InternalUiShowHideManager._isUiVisible = true;\r\n    InternalUiShowHideManager._autoHideUi = true;\r\n    InternalUiShowHideManager._showHidePanels = false;\r\n    InternalUiShowHideManager._showHideFooter = false;\r\n    InternalUiShowHideManager._inactivityTime = INACTIVITY_TIME_DEFAULT;\r\n    InternalUiShowHideManager._useProximityOpacity = false;\r\n    InternalUiShowHideManager._snapWidgetOpacity = false;\r\n  }\r\n}\r\n"]}

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

@@ -2,39 +2,13 @@
  * @module Utilities
  */
 /// <reference types="react" />
-import { UiStateStorage } from "@itwin/core-react";
-import { UserSettingsProvider } from "../UiFramework";
-/** Class that maintain UiShowHide user settings between sessions
- * @internal
- */
-export declare class UiShowHideSettingsProvider implements UserSettingsProvider {
-    private static _settingsNamespace;
-    private static _autoHideUiKey;
-    private static _useProximityOpacityKey;
-    private static _snapWidgetOpacityKey;
-    readonly providerId = "UiShowHideSettingsProvider";
-    static initialize(): void;
-    loadUserSettings(storage: UiStateStorage): Promise<void>;
-    static storeAutoHideUi(v: boolean, storage?: UiStateStorage): Promise<void>;
-    static storeUseProximityOpacity(v: boolean, storage?: UiStateStorage): Promise<void>;
-    static storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage): Promise<void>;
-}
-/** The default inactivity time.
- * @internal
- */
-export declare const INACTIVITY_TIME_DEFAULT = 3500; /** Wait 3.5 seconds */
+import { UiShowHideSettingsProvider } from "./InternalUiShowHideManager";
+export { UiShowHideSettingsProvider };
 /** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.
  * @public
+ * @deprecated in 3.7. Use `UiFramework.visibility` property.
  */
 export declare class UiShowHideManager {
-    private static _isUiVisible;
-    private static _autoHideUi;
-    private static _showHidePanels;
-    private static _showHideFooter;
-    private static _inactivityTime;
-    private static _timeout;
-    private static _useProximityOpacity;
-    private static _snapWidgetOpacity;
     /** Determines if the Ui is visible */
     static get isUiVisible(): boolean;
     static set isUiVisible(visible: boolean);
@@ -74,10 +48,6 @@ export declare class UiShowHideManager {
     static showUiAndResetTimer(): void;
     /** Shows the Ui and cancels the inactivity timer */
     static showUiAndCancelTimer(): void;
-    private static cancelTimer;
-    private static resetTimer;
-    private static showUi;
-    private static hideUi;
     /** @internal */
     static terminate(): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"UiShowHideManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/UiShowHideManager.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAE,cAAc,EAAwB,MAAM,mBAAmB,CAAC;AAEzE,OAAO,EAAe,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEnE;;GAEG;AACH,qBAAa,0BAA2B,YAAW,oBAAoB;IACrE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAgB;IAC7C,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAyB;IAC/D,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAuB;IAC3D,SAAgB,UAAU,gCAAgC;WAE5C,UAAU;IAIX,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;WAcjD,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc;WAIpD,wBAAwB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc;WAI7D,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc;CAGhF;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAO,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAiB;IAC5C,OAAO,CAAC,MAAM,CAAC,WAAW,CAAiB;IAC3C,OAAO,CAAC,MAAM,CAAC,eAAe,CAAkB;IAChD,OAAO,CAAC,MAAM,CAAC,eAAe,CAAkB;IAChD,OAAO,CAAC,MAAM,CAAC,eAAe,CAAmC;IACjE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAiB;IACxC,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAkB;IACrD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAkB;IAEnD,sCAAsC;IACtC,WAAkB,WAAW,IAGU,OAAO,CAD7C;IACD,WAAkB,WAAW,CAAC,OAAO,EAAE,OAAO,EAE7C;IAED,gBAAgB;WACF,aAAa,CAAC,KAAK,EAAE,OAAO;IAI1C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,OAAO;IAInD,gBAAgB;WACF,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAIjD;;OAEG;IACH,WAAkB,UAAU,IAAI,OAAO,CAEtC;IAED,WAAkB,UAAU,CAAC,QAAQ,EAAE,OAAO,EAI7C;IACD,oFAAoF;IACpF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAGjD;IAED,gFAAgF;IAChF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAGjD;IAED,iGAAiG;IACjG,WAAkB,cAAc,IAAI,MAAM,CAEzC;IACD,WAAkB,cAAc,CAAC,IAAI,EAAE,MAAM,EAE5C;IAED,6GAA6G;IAC7G,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;IACD,WAAkB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAKnD;IAED,kFAAkF;IAClF,WAAkB,iBAAiB,IAAI,OAAO,CAE7C;IACD,WAAkB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAKjD;IAED,6CAA6C;WAC/B,qBAAqB;IAQnC,6DAA6D;WAC/C,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAOvF,iDAAiD;WACnC,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAOvF,mDAAmD;WACrC,mBAAmB;IAOjC,oDAAoD;WACtC,oBAAoB;IAOlC,OAAO,CAAC,MAAM,CAAC,WAAW;IAI1B,OAAO,CAAC,MAAM,CAAC,UAAU;IAKzB,OAAO,CAAC,MAAM,CAAC,MAAM;IAIrB,OAAO,CAAC,MAAM,CAAC,MAAM;IAIrB,gBAAgB;WACF,SAAS;CAWxB"}
+{"version":3,"file":"UiShowHideManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/UiShowHideManager.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAyC,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEhH,OAAO,EAAE,0BAA0B,EAAE,CAAC;AAEtC;;;GAGG;AACH,qBAAa,iBAAiB;IAE5B,sCAAsC;IACtC,WAAkB,WAAW,IAGU,OAAO,CAD7C;IACD,WAAkB,WAAW,CAAC,OAAO,EAAE,OAAO,EAE7C;IAED,gBAAgB;WACF,aAAa,CAAC,KAAK,EAAE,OAAO;IAI1C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,OAAO;IAInD,gBAAgB;WACF,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAIjD;;OAEG;IACH,WAAkB,UAAU,IAAI,OAAO,CAEtC;IAED,WAAkB,UAAU,CAAC,QAAQ,EAAE,OAAO,EAE7C;IACD,oFAAoF;IACpF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAEjD;IAED,gFAAgF;IAChF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAEjD;IAED,iGAAiG;IACjG,WAAkB,cAAc,IAAI,MAAM,CAEzC;IACD,WAAkB,cAAc,CAAC,IAAI,EAAE,MAAM,EAE5C;IAED,6GAA6G;IAC7G,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;IACD,WAAkB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAEnD;IAED,kFAAkF;IAClF,WAAkB,iBAAiB,IAAI,OAAO,CAE7C;IACD,WAAkB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAEjD;IAED,6CAA6C;WAC/B,qBAAqB;IAKnC,6DAA6D;WAC/C,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAIvF,iDAAiD;WACnC,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAIvF,mDAAmD;WACrC,mBAAmB;IAIjC,oDAAoD;WACtC,oBAAoB;IAIlC,gBAAgB;WACF,SAAS;CAGxB"}

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

@@ -7,192 +7,102 @@
  * @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.UiStateStorageStatus.Success)
-            UiShowHideManager.setAutoHideUi(result.setting);
-        result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);
-        if (result.status === core_react_1.UiStateStorageStatus.Success)
-            UiShowHideManager.setUseProximityOpacity(result.setting);
-        result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);
-        if (result.status === core_react_1.UiStateStorageStatus.Success)
-            UiShowHideManager.setSnapWidgetOpacity(result.setting);
-    }
-    static async storeAutoHideUi(v, storage) {
-        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);
-    }
-    static async storeUseProximityOpacity(v, storage) {
-        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);
-    }
-    static async storeSnapWidgetOpacity(v, storage) {
-        void (storage !== null && storage !== void 0 ? storage : UiFramework_1.UiFramework.getUiStateStorage()).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 */
+exports.UiShowHideManager = exports.UiShowHideSettingsProvider = void 0;
+const InternalUiShowHideManager_1 = require("./InternalUiShowHideManager");
+Object.defineProperty(exports, "UiShowHideSettingsProvider", { enumerable: true, get: function () { return InternalUiShowHideManager_1.UiShowHideSettingsProvider; } });
 /** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.
  * @public
+ * @deprecated in 3.7. Use `UiFramework.visibility` property.
  */
 class UiShowHideManager {
     /** Determines if the Ui is visible */
     static get isUiVisible() {
-        return UiShowHideManager._isUiVisible;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.isUiVisible;
     }
     static set isUiVisible(visible) {
-        UiShowHideManager._isUiVisible = visible;
+        InternalUiShowHideManager_1.InternalUiShowHideManager.isUiVisible = visible;
     }
     /** @internal */
     static setAutoHideUi(value) {
-        UiShowHideManager._autoHideUi = value;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.setAutoHideUi(value);
     }
     /** @internal */
     static setUseProximityOpacity(value) {
-        UiShowHideManager._useProximityOpacity = value;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.setUseProximityOpacity(value);
     }
     /** @internal */
     static setSnapWidgetOpacity(value) {
-        UiShowHideManager._snapWidgetOpacity = value;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.setSnapWidgetOpacity(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;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.autoHideUi;
     }
     static set autoHideUi(autoHide) {
-        void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);
-        UiShowHideManager._autoHideUi = autoHide;
-        SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.ShowHideManagerSettingChange);
+        InternalUiShowHideManager_1.InternalUiShowHideManager.autoHideUi = autoHide;
     }
     /** Determines whether the widget panels are shown and hidden. Defaults to false. */
     static get showHidePanels() {
-        return UiShowHideManager._showHidePanels;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.showHidePanels;
     }
     static set showHidePanels(showHide) {
-        UiShowHideManager._showHidePanels = showHide;
-        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework_1.UiFramework.getIsUiVisible() });
+        InternalUiShowHideManager_1.InternalUiShowHideManager.showHidePanels = showHide;
     }
     /** Determines whether the status bar is shown and hidden. Defaults to false. */
     static get showHideFooter() {
-        return UiShowHideManager._showHideFooter;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.showHideFooter;
     }
     static set showHideFooter(showHide) {
-        UiShowHideManager._showHideFooter = showHide;
-        UiFramework_1.UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework_1.UiFramework.getIsUiVisible() });
+        InternalUiShowHideManager_1.InternalUiShowHideManager.showHideFooter = showHide;
     }
     /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
     static get inactivityTime() {
-        return UiShowHideManager._inactivityTime;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.inactivityTime;
     }
     static set inactivityTime(time) {
-        UiShowHideManager._inactivityTime = time;
+        InternalUiShowHideManager_1.InternalUiShowHideManager.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;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.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() });
+        InternalUiShowHideManager_1.InternalUiShowHideManager.useProximityOpacity = value;
     }
     /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
     static get snapWidgetOpacity() {
-        return UiShowHideManager._snapWidgetOpacity;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.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() });
+        InternalUiShowHideManager_1.InternalUiShowHideManager.snapWidgetOpacity = value;
     }
     /** Handler for when a Frontstage is ready */
     static handleFrontstageReady() {
         // istanbul ignore next
-        if (!UiShowHideManager._autoHideUi)
-            return;
-        UiShowHideManager.showUiAndResetTimer();
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.handleFrontstageReady();
     }
     /** Handler for when the mouse moves over the content area */
     static handleContentMouseMove(_event) {
-        if (!UiShowHideManager._autoHideUi)
-            return;
-        UiShowHideManager.showUiAndResetTimer();
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.handleContentMouseMove(_event);
     }
     /** Handler for when the mouse enters a widget */
     static handleWidgetMouseEnter(_event) {
-        if (!UiShowHideManager._autoHideUi)
-            return;
-        UiShowHideManager.showUiAndCancelTimer();
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.handleWidgetMouseEnter(_event);
     }
     /** Shows the Ui and resets the inactivity timer */
     static showUiAndResetTimer() {
-        setTimeout(() => {
-            UiShowHideManager.showUi();
-            UiShowHideManager.resetTimer();
-        });
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.showUiAndResetTimer();
     }
     /** 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);
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.showUiAndCancelTimer();
     }
     /** @internal */
     static terminate() {
-        UiShowHideManager.cancelTimer();
-        // Ensure that next use will have default values for tests.
-        UiShowHideManager._isUiVisible = true;
-        UiShowHideManager._autoHideUi = true;
-        UiShowHideManager._showHidePanels = false;
-        UiShowHideManager._showHideFooter = false;
-        UiShowHideManager._inactivityTime = exports.INACTIVITY_TIME_DEFAULT;
-        UiShowHideManager._useProximityOpacity = false;
-        UiShowHideManager._snapWidgetOpacity = false;
+        return InternalUiShowHideManager_1.InternalUiShowHideManager.terminate();
     }
 }
 exports.UiShowHideManager = UiShowHideManager;
-UiShowHideManager._isUiVisible = true;
-UiShowHideManager._autoHideUi = true;
-UiShowHideManager._showHidePanels = false;
-UiShowHideManager._showHideFooter = false;
-UiShowHideManager._inactivityTime = exports.INACTIVITY_TIME_DEFAULT;
-UiShowHideManager._useProximityOpacity = false;
-UiShowHideManager._snapWidgetOpacity = false;
 //# sourceMappingURL=UiShowHideManager.js.map