@itwin/appui-react 4.0.0-dev.8 → 4.0.0

package/lib/cjs/appui-react/uistate/useUiStateStorage.d.ts

@@ -1,20 +1,20 @@
-/** @packageDocumentation
- * @module UiStateStorage
- */
-import * as React from "react";
-import { UiStateStorage } from "@itwin/core-react";
-/** @public */
-export declare function useUiStateStorageHandler(): UiStateStorage;
-/** @internal */
-export declare const UiStateStorageContext: React.Context<UiStateStorage>;
-/** Properties for the [[UiStateStorageHandler]] component.
- * @public
- */
-export interface UiSettingsProviderProps {
-    children?: React.ReactNode;
-}
-/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
- * @public
- */
-export declare function UiStateStorageHandler(props: UiSettingsProviderProps): JSX.Element;
+/** @packageDocumentation
+ * @module UiStateStorage
+ */
+import * as React from "react";
+import { UiStateStorage } from "@itwin/core-react";
+/** @public */
+export declare function useUiStateStorageHandler(): UiStateStorage;
+/** @internal */
+export declare const UiStateStorageContext: React.Context<UiStateStorage>;
+/** Properties for the [[UiStateStorageHandler]] component.
+ * @public
+ */
+export interface UiSettingsProviderProps {
+    children?: React.ReactNode;
+}
+/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
+ * @public
+ */
+export declare function UiStateStorageHandler(props: UiSettingsProviderProps): JSX.Element;
 //# sourceMappingURL=useUiStateStorage.d.ts.map

package/lib/cjs/appui-react/uistate/useUiStateStorage.js

@@ -1,39 +1,39 @@
-"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 UiStateStorage
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UiStateStorageHandler = exports.UiStateStorageContext = exports.useUiStateStorageHandler = void 0;
-const React = require("react");
-const core_react_1 = require("@itwin/core-react");
-const UiFramework_1 = require("../UiFramework");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
-/** @public */
-function useUiStateStorageHandler() {
-    return React.useContext(exports.UiStateStorageContext);
-}
-exports.useUiStateStorageHandler = useUiStateStorageHandler;
-/** @internal */
-exports.UiStateStorageContext = React.createContext(new core_react_1.LocalStateStorage()); // eslint-disable-line @typescript-eslint/naming-convention
-exports.UiStateStorageContext.displayName = "uifw:UiStateStorageContext";
-/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
- * @public
- */
-function UiStateStorageHandler(props) {
-    const [stateStorage, setStateStorage] = React.useState(UiFramework_1.UiFramework.getUiStateStorage());
-    React.useEffect(() => {
-        // istanbul ignore next
-        const handleSyncUiEvent = (args) => {
-            if (SyncUiEventDispatcher_1.SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventDispatcher_1.SyncUiEventId.UiStateStorageChanged]))
-                setStateStorage(UiFramework_1.UiFramework.getUiStateStorage());
-        };
-        return SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
-    });
-    return (React.createElement(exports.UiStateStorageContext.Provider, { children: props.children, value: stateStorage }));
-}
-exports.UiStateStorageHandler = UiStateStorageHandler;
+"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 UiStateStorage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiStateStorageHandler = exports.UiStateStorageContext = exports.useUiStateStorageHandler = void 0;
+const React = require("react");
+const core_react_1 = require("@itwin/core-react");
+const UiFramework_1 = require("../UiFramework");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+/** @public */
+function useUiStateStorageHandler() {
+    return React.useContext(exports.UiStateStorageContext);
+}
+exports.useUiStateStorageHandler = useUiStateStorageHandler;
+/** @internal */
+exports.UiStateStorageContext = React.createContext(new core_react_1.LocalStateStorage());
+exports.UiStateStorageContext.displayName = "uifw:UiStateStorageContext";
+/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
+ * @public
+ */
+function UiStateStorageHandler(props) {
+    const [stateStorage, setStateStorage] = React.useState(UiFramework_1.UiFramework.getUiStateStorage());
+    React.useEffect(() => {
+        // istanbul ignore next
+        const handleSyncUiEvent = (args) => {
+            if (SyncUiEventDispatcher_1.SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventDispatcher_1.SyncUiEventId.UiStateStorageChanged]))
+                setStateStorage(UiFramework_1.UiFramework.getUiStateStorage());
+        };
+        return SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
+    });
+    return (React.createElement(exports.UiStateStorageContext.Provider, { children: props.children, value: stateStorage }));
+}
+exports.UiStateStorageHandler = UiStateStorageHandler;
 //# sourceMappingURL=useUiStateStorage.js.map

package/lib/cjs/appui-react/uistate/useUiStateStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAE/B,kDAAsE;AACtE,gDAA6C;AAC7C,2EAAuF;AAEvF,cAAc;AACd,SAAgB,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,6BAAqB,CAAC,CAAC;AACjD,CAAC;AAFD,4DAEC;AAED,gBAAgB;AACH,QAAA,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAiB,IAAI,8BAAiB,EAAE,CAAC,CAAC,CAAC,2DAA2D;AAC9J,6BAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,SAAgB,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,qCAAa,CAAC,qBAAqB,CAAC,CAAC;gBAChG,eAAe,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,6BAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,CAAC;AAnBD,sDAmBC","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 UiStateStorage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { LocalStateStorage, UiStateStorage } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\n/** @public */\r\nexport function useUiStateStorageHandler(): UiStateStorage {\r\n  return React.useContext(UiStateStorageContext);\r\n}\r\n\r\n/** @internal */\r\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(new LocalStateStorage()); // eslint-disable-line @typescript-eslint/naming-convention\r\nUiStateStorageContext.displayName = \"uifw:UiStateStorageContext\";\r\n\r\n/** Properties for the [[UiStateStorageHandler]] component.\r\n * @public\r\n */\r\nexport interface UiSettingsProviderProps {\r\n  children?: React.ReactNode;\r\n}\r\n\r\n/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.\r\n * @public\r\n */\r\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\r\n  const [stateStorage, setStateStorage] = React.useState(UiFramework.getUiStateStorage());\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore next\r\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\r\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventId.UiStateStorageChanged]))\r\n        setStateStorage(UiFramework.getUiStateStorage());\r\n    };\r\n\r\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\r\n  });\r\n\r\n  return (\r\n    <UiStateStorageContext.Provider\r\n      children={props.children} // eslint-disable-line react/no-children-prop\r\n      value={stateStorage}\r\n    />\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAE/B,kDAAsE;AACtE,gDAA6C;AAC7C,2EAAuF;AAEvF,cAAc;AACd,SAAgB,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,6BAAqB,CAAC,CAAC;AACjD,CAAC;AAFD,4DAEC;AAED,gBAAgB;AACH,QAAA,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAiB,IAAI,8BAAiB,EAAE,CAAC,CAAC;AAClG,6BAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,SAAgB,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,qCAAa,CAAC,qBAAqB,CAAC,CAAC;gBAChG,eAAe,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,6BAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,CAAC;AAnBD,sDAmBC","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 UiStateStorage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { LocalStateStorage, UiStateStorage } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\n/** @public */\r\nexport function useUiStateStorageHandler(): UiStateStorage {\r\n  return React.useContext(UiStateStorageContext);\r\n}\r\n\r\n/** @internal */\r\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(new LocalStateStorage());\r\nUiStateStorageContext.displayName = \"uifw:UiStateStorageContext\";\r\n\r\n/** Properties for the [[UiStateStorageHandler]] component.\r\n * @public\r\n */\r\nexport interface UiSettingsProviderProps {\r\n  children?: React.ReactNode;\r\n}\r\n\r\n/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.\r\n * @public\r\n */\r\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\r\n  const [stateStorage, setStateStorage] = React.useState(UiFramework.getUiStateStorage());\r\n\r\n  React.useEffect(() => {\r\n    // istanbul ignore next\r\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\r\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventId.UiStateStorageChanged]))\r\n        setStateStorage(UiFramework.getUiStateStorage());\r\n    };\r\n\r\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\r\n  });\r\n\r\n  return (\r\n    <UiStateStorageContext.Provider\r\n      children={props.children} // eslint-disable-line react/no-children-prop\r\n      value={stateStorage}\r\n    />\r\n  );\r\n}\r\n"]}

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);
+    /** @public */
+    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,cAAc;WACA,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);
+    }
+}
+UiShowHideSettingsProvider._settingsNamespace = "AppUiSettings";
+UiShowHideSettingsProvider._autoHideUiKey = "AutoHideUi";
+UiShowHideSettingsProvider._useProximityOpacityKey = "UseProximityOpacity";
+UiShowHideSettingsProvider._snapWidgetOpacityKey = "SnapWidgetOpacity";
+exports.UiShowHideSettingsProvider = UiShowHideSettingsProvider;
+/** 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;
+    }
+    /** @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) {
+        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;
+    }
+}
+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;
+//# 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;;AAlCc,6CAAkB,GAAG,eAAe,AAAlB,CAAmB;AACrC,yCAAc,GAAG,YAAY,AAAf,CAAgB;AAC9B,kDAAuB,GAAG,qBAAqB,AAAxB,CAAyB;AAChD,gDAAqB,GAAG,mBAAmB,AAAtB,CAAuB;AAJhD,gEAA0B;AAsCvC;;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,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,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;;AAjKc,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;AARxC,8DAAyB","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  /** @public */\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/PropsHelper.d.ts

@@ -1,21 +1,22 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import * as React from "react";
-import { AbstractWidgetProps, BackstageItem, ConditionalStringValue, StringGetter } from "@itwin/appui-abstract";
-import { IconSpec } from "@itwin/core-react";
-/** A set of helper methods for various props
- * @public
- */
-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.  */
-    static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined;
-    /** returns true if the two objects are the same using a shallow compare of each property */
-    static isShallowEqual(newObj: any, prevObj: any): boolean;
-    static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<AbstractWidgetProps> | Partial<BackstageItem>;
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+import * as React from "react";
+import { IconSpec } from "@itwin/core-react";
+import { ConditionalStringValue, StringGetter, AbstractWidgetProps as UIA_AbstractWidgetProps, CommonBackstageItem as UIA_CommonBackstageItem } from "@itwin/appui-abstract";
+/** A set of helper methods for various props
+ * @public
+ */
+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.  */
+    static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined;
+    /** returns true if the two objects are the same using a shallow compare of each property */
+    static isShallowEqual(newObj: any, prevObj: any): boolean;
+    /** @deprecated in 4.0 These abstract props types are obsolete. */
+    static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem>;
+}
 //# sourceMappingURL=PropsHelper.d.ts.map

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;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACjH,OAAO,EAAoB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG/D;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;WAMxC,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;CAavJ"}
+{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAoB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAE7K;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;IAOtD,kEAAkE;WACpD,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAarK"}