@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.13

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

@@ -1,90 +1,90 @@
-"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 Settings
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppUiSettings = void 0;
-const core_react_1 = require("@itwin/core-react");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
-const UiFramework_1 = require("../UiFramework");
-/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,
- * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor
- * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with
- * defaults specific to their application. This would be done by calling the following.
- *
- * ```ts
- * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));
- * ```
- *
- * @public
- */
-class AppUiSettings {
-    constructor(defaults) {
-        this.providerId = "AppUiSettingsProvider";
-        this._settings = [];
-        this._applyingLocalSettings = false;
-        this.setColorTheme = (theme) => {
-            UiFramework_1.UiFramework.setColorTheme(theme);
-            // always store to local storage to avoid flicker during startup if user is not yet logged-in
-            window.localStorage.setItem("uifw:defaultTheme", theme);
-        };
-        this.handleSyncUiEvent = async (args) => {
-            if (this._applyingLocalSettings)
-                return;
-            if (args.eventIds.has("configurableui:set_theme")) {
-                await this.colorTheme.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-                // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in
-                window.localStorage.setItem("uifw:defaultTheme", UiFramework_1.UiFramework.getColorTheme());
-            }
-            if (args.eventIds.has("configurableui:set-drag-interaction"))
-                await this.dragInteraction.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-show-widget-icon"))
-                await this.showWidgetIcon.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-auto-collapse-unpinned-panels"))
-                await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set_widget_opacity"))
-                await this.widgetOpacity.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-animate-tool-settings"))
-                await this.animateToolSettings.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-use-tool-as-tool-settings-label"))
-                await this.useToolAsToolSettingsLabel.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-toolbar-opacity"))
-                await this.toolbarOpacity.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
-        };
-        this._settings = [];
-        this.colorTheme = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "ColorTheme", UiFramework_1.UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);
-        this._settings.push(this.colorTheme);
-        this.dragInteraction = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "DragInteraction", () => UiFramework_1.UiFramework.useDragInteraction, (value) => UiFramework_1.UiFramework.setUseDragInteraction(value), defaults.dragInteraction);
-        this._settings.push(this.dragInteraction);
-        this.showWidgetIcon = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "ShowWidgetIcon", () => UiFramework_1.UiFramework.showWidgetIcon, (value) => UiFramework_1.UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);
-        this._settings.push(this.showWidgetIcon);
-        this.autoCollapseUnpinnedPanels = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "AutoCollapseUnpinnedPanels", () => UiFramework_1.UiFramework.autoCollapseUnpinnedPanels, (value) => UiFramework_1.UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);
-        this._settings.push(this.autoCollapseUnpinnedPanels);
-        this.widgetOpacity = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "WidgetOpacity", () => UiFramework_1.UiFramework.getWidgetOpacity(), (value) => UiFramework_1.UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);
-        this._settings.push(this.widgetOpacity);
-        this.animateToolSettings = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "AnimateToolSettings", () => UiFramework_1.UiFramework.animateToolSettings, (value) => UiFramework_1.UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);
-        this._settings.push(this.animateToolSettings);
-        this.useToolAsToolSettingsLabel = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "UseToolAsToolSettingsLabel", () => UiFramework_1.UiFramework.useToolAsToolSettingsLabel, (value) => UiFramework_1.UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);
-        this._settings.push(this.useToolAsToolSettingsLabel);
-        this.toolbarOpacity = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "ToolOpacity", () => UiFramework_1.UiFramework.getToolbarOpacity(), (value) => UiFramework_1.UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);
-        this._settings.push(this.toolbarOpacity);
-        SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);
-    }
-    async apply(storage) {
-        this._applyingLocalSettings = true;
-        for await (const setting of this._settings) {
-            await setting.getSettingAndApplyValue(storage);
-        }
-        this._applyingLocalSettings = false;
-    }
-    async loadUserSettings(storage) {
-        await this.apply(storage);
-    }
-}
-exports.AppUiSettings = AppUiSettings;
-AppUiSettings._settingNamespace = "AppUiSettings";
+"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 Settings
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppUiSettings = void 0;
+const core_react_1 = require("@itwin/core-react");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const UiFramework_1 = require("../UiFramework");
+/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,
+ * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor
+ * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with
+ * defaults specific to their application. This would be done by calling the following.
+ *
+ * ```ts
+ * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));
+ * ```
+ *
+ * @public
+ */
+class AppUiSettings {
+    constructor(defaults) {
+        this.providerId = "AppUiSettingsProvider";
+        this._settings = [];
+        this._applyingLocalSettings = false;
+        this.setColorTheme = (theme) => {
+            UiFramework_1.UiFramework.setColorTheme(theme);
+            // always store to local storage to avoid flicker during startup if user is not yet logged-in
+            window.localStorage.setItem("uifw:defaultTheme", theme);
+        };
+        this.handleSyncUiEvent = async (args) => {
+            if (this._applyingLocalSettings)
+                return;
+            if (args.eventIds.has("configurableui:set_theme")) {
+                await this.colorTheme.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+                // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in
+                window.localStorage.setItem("uifw:defaultTheme", UiFramework_1.UiFramework.getColorTheme());
+            }
+            if (args.eventIds.has("configurableui:set-drag-interaction"))
+                await this.dragInteraction.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-show-widget-icon"))
+                await this.showWidgetIcon.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-auto-collapse-unpinned-panels"))
+                await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set_widget_opacity"))
+                await this.widgetOpacity.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-animate-tool-settings"))
+                await this.animateToolSettings.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-use-tool-as-tool-settings-label"))
+                await this.useToolAsToolSettingsLabel.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-toolbar-opacity"))
+                await this.toolbarOpacity.saveSetting(UiFramework_1.UiFramework.getUiStateStorage());
+        };
+        this._settings = [];
+        this.colorTheme = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "ColorTheme", UiFramework_1.UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);
+        this._settings.push(this.colorTheme);
+        this.dragInteraction = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "DragInteraction", () => UiFramework_1.UiFramework.useDragInteraction, (value) => UiFramework_1.UiFramework.setUseDragInteraction(value), defaults.dragInteraction);
+        this._settings.push(this.dragInteraction);
+        this.showWidgetIcon = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "ShowWidgetIcon", () => UiFramework_1.UiFramework.showWidgetIcon, (value) => UiFramework_1.UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);
+        this._settings.push(this.showWidgetIcon);
+        this.autoCollapseUnpinnedPanels = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "AutoCollapseUnpinnedPanels", () => UiFramework_1.UiFramework.autoCollapseUnpinnedPanels, (value) => UiFramework_1.UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);
+        this._settings.push(this.autoCollapseUnpinnedPanels);
+        this.widgetOpacity = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "WidgetOpacity", () => UiFramework_1.UiFramework.getWidgetOpacity(), (value) => UiFramework_1.UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);
+        this._settings.push(this.widgetOpacity);
+        this.animateToolSettings = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "AnimateToolSettings", () => UiFramework_1.UiFramework.animateToolSettings, (value) => UiFramework_1.UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);
+        this._settings.push(this.animateToolSettings);
+        this.useToolAsToolSettingsLabel = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "UseToolAsToolSettingsLabel", () => UiFramework_1.UiFramework.useToolAsToolSettingsLabel, (value) => UiFramework_1.UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);
+        this._settings.push(this.useToolAsToolSettingsLabel);
+        this.toolbarOpacity = new core_react_1.UiStateEntry(AppUiSettings._settingNamespace, "ToolOpacity", () => UiFramework_1.UiFramework.getToolbarOpacity(), (value) => UiFramework_1.UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);
+        this._settings.push(this.toolbarOpacity);
+        SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);
+    }
+    async apply(storage) {
+        this._applyingLocalSettings = true;
+        for await (const setting of this._settings) {
+            await setting.getSettingAndApplyValue(storage);
+        }
+        this._applyingLocalSettings = false;
+    }
+    async loadUserSettings(storage) {
+        await this.apply(storage);
+    }
+}
+AppUiSettings._settingNamespace = "AppUiSettings";
+exports.AppUiSettings = AppUiSettings;
 //# sourceMappingURL=AppUiSettings.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,kDAAiE;AAEjE,2EAAwE;AACxE,gDAAmE;AAmBnE;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IAsBxB,YAAY,QAAuC;QArBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAW/B,kBAAa,GAAG,CAAC,KAAa,EAAE,EAAE;YACxC,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QA4CM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAC7B,OAAO;YAET,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;gBACjD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,yBAAW,CAAC,aAAa,EAAE,CAAC,CAAC;aAC/E;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAvEA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,yBAAW,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EACjG,GAAG,EAAE,CAAC,yBAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,EAC/F,GAAG,EAAE,CAAC,yBAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,yBAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EAC5F,GAAG,EAAE,CAAC,yBAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,qBAAqB,EACzG,GAAG,EAAE,CAAC,yBAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC/F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,aAAa,EAC3F,GAAG,EAAE,CAAC,yBAAW,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IAkCM,KAAK,CAAC,KAAK,CAAC,OAAuB;QACxC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QACnC,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAC1C,MAAM,OAAO,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;;AA1GH,sCA2GC;AAxGgB,+BAAiB,GAAG,eAAe,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 Settings\r\n */\r\n\r\nimport { UiStateEntry, UiStateStorage } from \"@itwin/core-react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\r\n\r\n// cSpell:ignore configurableui\r\n\r\n/** Default values that may be specified for [[AppUiSettings]].\r\n * @public\r\n */\r\nexport interface InitialAppUiSettings {\r\n  colorTheme: string;\r\n  dragInteraction: boolean;\r\n  widgetOpacity: number;\r\n  showWidgetIcon?: boolean;\r\n  /** @alpha */\r\n  autoCollapseUnpinnedPanels?: boolean;\r\n  animateToolSettings?: boolean;\r\n  useToolAsToolSettingsLabel?: boolean;\r\n  toolbarOpacity: number;\r\n}\r\n\r\n/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,\r\n * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor\r\n * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with\r\n * defaults specific to their application. This would be done by calling the following.\r\n *\r\n * ```ts\r\n * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class AppUiSettings implements UserSettingsProvider {\r\n  public readonly providerId = \"AppUiSettingsProvider\";\r\n\r\n  private static _settingNamespace = \"AppUiSettings\";\r\n  private _settings: Array<UiStateEntry<any>> = [];\r\n  private _applyingLocalSettings = false;\r\n\r\n  public colorTheme: UiStateEntry<string>;\r\n  public dragInteraction: UiStateEntry<boolean>;\r\n  public widgetOpacity: UiStateEntry<number>;\r\n  public showWidgetIcon: UiStateEntry<boolean>;\r\n  public autoCollapseUnpinnedPanels: UiStateEntry<boolean>;\r\n  public animateToolSettings: UiStateEntry<boolean>;\r\n  public useToolAsToolSettingsLabel: UiStateEntry<boolean>;\r\n  public toolbarOpacity: UiStateEntry<number>;\r\n\r\n  private setColorTheme = (theme: string) => {\r\n    UiFramework.setColorTheme(theme);\r\n    // always store to local storage to avoid flicker during startup if user is not yet logged-in\r\n    window.localStorage.setItem(\"uifw:defaultTheme\", theme);\r\n  };\r\n\r\n  constructor(defaults: Partial<InitialAppUiSettings>) {\r\n    this._settings = [];\r\n\r\n    this.colorTheme = new UiStateEntry<string>(AppUiSettings._settingNamespace, \"ColorTheme\", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);\r\n    this._settings.push(this.colorTheme);\r\n\r\n    this.dragInteraction = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"DragInteraction\",\r\n      () => UiFramework.useDragInteraction,\r\n      (value: boolean) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);\r\n    this._settings.push(this.dragInteraction);\r\n\r\n    this.showWidgetIcon = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"ShowWidgetIcon\",\r\n      () => UiFramework.showWidgetIcon,\r\n      (value: boolean) => UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);\r\n    this._settings.push(this.showWidgetIcon);\r\n\r\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AutoCollapseUnpinnedPanels\",\r\n      () => UiFramework.autoCollapseUnpinnedPanels,\r\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);\r\n    this._settings.push(this.autoCollapseUnpinnedPanels);\r\n\r\n    this.widgetOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"WidgetOpacity\",\r\n      () => UiFramework.getWidgetOpacity(), (value: number) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);\r\n    this._settings.push(this.widgetOpacity);\r\n\r\n    this.animateToolSettings = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AnimateToolSettings\",\r\n      () => UiFramework.animateToolSettings,\r\n      (value: boolean) => UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);\r\n    this._settings.push(this.animateToolSettings);\r\n\r\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"UseToolAsToolSettingsLabel\",\r\n      () => UiFramework.useToolAsToolSettingsLabel,\r\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);\r\n    this._settings.push(this.useToolAsToolSettingsLabel);\r\n\r\n    this.toolbarOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"ToolOpacity\",\r\n      () => UiFramework.getToolbarOpacity(), (value: number) => UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);\r\n    this._settings.push(this.toolbarOpacity);\r\n\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);\r\n  }\r\n\r\n  private handleSyncUiEvent = async (args: UiSyncEventArgs) => {\r\n    if (this._applyingLocalSettings)\r\n      return;\r\n\r\n    if (args.eventIds.has(\"configurableui:set_theme\")) {\r\n      await this.colorTheme.saveSetting(UiFramework.getUiStateStorage());\r\n      // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in\r\n      window.localStorage.setItem(\"uifw:defaultTheme\", UiFramework.getColorTheme());\r\n    }\r\n\r\n    if (args.eventIds.has(\"configurableui:set-drag-interaction\"))\r\n      await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-show-widget-icon\"))\r\n      await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-auto-collapse-unpinned-panels\"))\r\n      await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set_widget_opacity\"))\r\n      await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-animate-tool-settings\"))\r\n      await this.animateToolSettings.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\r\n      await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-toolbar-opacity\"))\r\n      await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());\r\n  };\r\n\r\n  public async apply(storage: UiStateStorage): Promise<void> {\r\n    this._applyingLocalSettings = true;\r\n    for await (const setting of this._settings) {\r\n      await setting.getSettingAndApplyValue(storage);\r\n    }\r\n    this._applyingLocalSettings = false;\r\n  }\r\n\r\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\r\n    await this.apply(storage);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,kDAAiE;AAEjE,2EAAwE;AACxE,gDAAmE;AAmBnE;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IAsBxB,YAAY,QAAuC;QArBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAW/B,kBAAa,GAAG,CAAC,KAAa,EAAE,EAAE;YACxC,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QA4CM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAC7B,OAAO;YAET,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;gBACjD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,yBAAW,CAAC,aAAa,EAAE,CAAC,CAAC;aAC/E;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAvEA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,yBAAW,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EACjG,GAAG,EAAE,CAAC,yBAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,EAC/F,GAAG,EAAE,CAAC,yBAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,yBAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EAC5F,GAAG,EAAE,CAAC,yBAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;QACxH,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,qBAAqB,EACzG,GAAG,EAAE,CAAC,yBAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC/F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,yBAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,yBAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,yBAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,aAAa,EAC3F,GAAG,EAAE,CAAC,yBAAW,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,yBAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IAkCM,KAAK,CAAC,KAAK,CAAC,OAAuB;QACxC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC;QACnC,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YAC1C,MAAM,OAAO,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;;AAvGc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;AAHxC,sCAAa","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Settings\n */\n\nimport { UiStateEntry, UiStateStorage } from \"@itwin/core-react\";\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\n\n// cSpell:ignore configurableui\n\n/** Default values that may be specified for [[AppUiSettings]].\n * @public\n */\nexport interface InitialAppUiSettings {\n  colorTheme: string;\n  dragInteraction: boolean;\n  widgetOpacity: number;\n  showWidgetIcon?: boolean;\n  /** @alpha */\n  autoCollapseUnpinnedPanels?: boolean;\n  animateToolSettings?: boolean;\n  useToolAsToolSettingsLabel?: boolean;\n  toolbarOpacity: number;\n}\n\n/** These are the UI settings that are stored in the Redux store. They control the color theme, the UI version,\n * how toolbar group buttons work, and the opacity of widgets in 1.0 and floating widget in 2.0 when the cursor\n * is not inside them. It is expect that an IModelApp using App UI components will create and register AppUiSettings with\n * defaults specific to their application. This would be done by calling the following.\n *\n * ```ts\n * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));\n * ```\n *\n * @public\n */\nexport class AppUiSettings implements UserSettingsProvider {\n  public readonly providerId = \"AppUiSettingsProvider\";\n\n  private static _settingNamespace = \"AppUiSettings\";\n  private _settings: Array<UiStateEntry<any>> = [];\n  private _applyingLocalSettings = false;\n\n  public colorTheme: UiStateEntry<string>;\n  public dragInteraction: UiStateEntry<boolean>;\n  public widgetOpacity: UiStateEntry<number>;\n  public showWidgetIcon: UiStateEntry<boolean>;\n  public autoCollapseUnpinnedPanels: UiStateEntry<boolean>;\n  public animateToolSettings: UiStateEntry<boolean>;\n  public useToolAsToolSettingsLabel: UiStateEntry<boolean>;\n  public toolbarOpacity: UiStateEntry<number>;\n\n  private setColorTheme = (theme: string) => {\n    UiFramework.setColorTheme(theme);\n    // always store to local storage to avoid flicker during startup if user is not yet logged-in\n    window.localStorage.setItem(\"uifw:defaultTheme\", theme);\n  };\n\n  constructor(defaults: Partial<InitialAppUiSettings>) {\n    this._settings = [];\n\n    this.colorTheme = new UiStateEntry<string>(AppUiSettings._settingNamespace, \"ColorTheme\", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);\n    this._settings.push(this.colorTheme);\n\n    this.dragInteraction = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"DragInteraction\",\n      () => UiFramework.useDragInteraction,\n      (value: boolean) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);\n    this._settings.push(this.dragInteraction);\n\n    this.showWidgetIcon = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"ShowWidgetIcon\",\n      () => UiFramework.showWidgetIcon,\n      (value: boolean) => UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);\n    this._settings.push(this.showWidgetIcon);\n\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AutoCollapseUnpinnedPanels\",\n      () => UiFramework.autoCollapseUnpinnedPanels,\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);\n    this._settings.push(this.autoCollapseUnpinnedPanels);\n\n    this.widgetOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"WidgetOpacity\",\n      () => UiFramework.getWidgetOpacity(), (value: number) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);\n    this._settings.push(this.widgetOpacity);\n\n    this.animateToolSettings = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"AnimateToolSettings\",\n      () => UiFramework.animateToolSettings,\n      (value: boolean) => UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);\n    this._settings.push(this.animateToolSettings);\n\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(AppUiSettings._settingNamespace, \"UseToolAsToolSettingsLabel\",\n      () => UiFramework.useToolAsToolSettingsLabel,\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);\n    this._settings.push(this.useToolAsToolSettingsLabel);\n\n    this.toolbarOpacity = new UiStateEntry<number>(AppUiSettings._settingNamespace, \"ToolOpacity\",\n      () => UiFramework.getToolbarOpacity(), (value: number) => UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);\n    this._settings.push(this.toolbarOpacity);\n\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);\n  }\n\n  private handleSyncUiEvent = async (args: UiSyncEventArgs) => {\n    if (this._applyingLocalSettings)\n      return;\n\n    if (args.eventIds.has(\"configurableui:set_theme\")) {\n      await this.colorTheme.saveSetting(UiFramework.getUiStateStorage());\n      // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in\n      window.localStorage.setItem(\"uifw:defaultTheme\", UiFramework.getColorTheme());\n    }\n\n    if (args.eventIds.has(\"configurableui:set-drag-interaction\"))\n      await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-show-widget-icon\"))\n      await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-auto-collapse-unpinned-panels\"))\n      await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set_widget_opacity\"))\n      await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-animate-tool-settings\"))\n      await this.animateToolSettings.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\n      await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());\n\n    if (args.eventIds.has(\"configurableui:set-toolbar-opacity\"))\n      await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());\n  };\n\n  public async apply(storage: UiStateStorage): Promise<void> {\n    this._applyingLocalSettings = true;\n    for await (const setting of this._settings) {\n      await setting.getSettingAndApplyValue(storage);\n    }\n    this._applyingLocalSettings = false;\n  }\n\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\n    await this.apply(storage);\n  }\n}\n"]}

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());
-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;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"]}
+{"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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiStateStorage\n */\n\nimport * as React from \"react\";\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { LocalStateStorage, UiStateStorage } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\n\n/** @public */\nexport function useUiStateStorageHandler(): UiStateStorage {\n  return React.useContext(UiStateStorageContext);\n}\n\n/** @internal */\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(new LocalStateStorage());\nUiStateStorageContext.displayName = \"uifw:UiStateStorageContext\";\n\n/** Properties for the [[UiStateStorageHandler]] component.\n * @public\n */\nexport interface UiSettingsProviderProps {\n  children?: React.ReactNode;\n}\n\n/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.\n * @public\n */\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\n  const [stateStorage, setStateStorage] = React.useState(UiFramework.getUiStateStorage());\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [SyncUiEventId.UiStateStorageChanged]))\n        setStateStorage(UiFramework.getUiStateStorage());\n    };\n\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n  });\n\n  return (\n    <UiStateStorageContext.Provider\n      children={props.children} // eslint-disable-line react/no-children-prop\n      value={stateStorage}\n    />\n  );\n}\n"]}

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

@@ -1,84 +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;
-}
+/** @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