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

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

@@ -1,92 +1,86 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { UiStateEntry } from "@itwin/core-react";
-import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
-import { UiFramework } from "../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
- */
-export class AppUiSettings {
-    constructor(defaults) {
-        this.providerId = "AppUiSettingsProvider";
-        this._settings = [];
-        this._applyingLocalSettings = false;
-        this.setColorTheme = (theme) => {
-            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.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.getColorTheme());
-            }
-            if (args.eventIds.has("configurableui:set-drag-interaction"))
-                await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-framework-version"))
-                await this.frameworkVersion.saveSetting(UiFramework.getUiStateStorage()); // eslint-disable-line deprecation/deprecation
-            if (args.eventIds.has("configurableui:set-show-widget-icon"))
-                await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-auto-collapse-unpinned-panels"))
-                await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set_widget_opacity"))
-                await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-animate-tool-settings"))
-                await this.animateToolSettings.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-use-tool-as-tool-settings-label"))
-                await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-toolbar-opacity"))
-                await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());
-        };
-        this._settings = [];
-        this.colorTheme = new UiStateEntry(AppUiSettings._settingNamespace, "ColorTheme", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);
-        this._settings.push(this.colorTheme);
-        this.dragInteraction = new UiStateEntry(AppUiSettings._settingNamespace, "DragInteraction", () => UiFramework.useDragInteraction, (value) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);
-        this._settings.push(this.dragInteraction);
-        this.showWidgetIcon = new UiStateEntry(AppUiSettings._settingNamespace, "ShowWidgetIcon", () => UiFramework.showWidgetIcon, (value) => UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);
-        this._settings.push(this.showWidgetIcon);
-        this.autoCollapseUnpinnedPanels = new UiStateEntry(AppUiSettings._settingNamespace, "AutoCollapseUnpinnedPanels", () => UiFramework.autoCollapseUnpinnedPanels, (value) => UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);
-        this._settings.push(this.autoCollapseUnpinnedPanels);
-        this.frameworkVersion = new UiStateEntry(AppUiSettings._settingNamespace, "FrameworkVersion", // eslint-disable-line deprecation/deprecation
-        () => UiFramework.uiVersion, // eslint-disable-line deprecation/deprecation
-        (value) => UiFramework.setUiVersion(value), defaults.frameworkVersion); // eslint-disable-line deprecation/deprecation
-        this._settings.push(this.frameworkVersion); // eslint-disable-line deprecation/deprecation
-        this.widgetOpacity = new UiStateEntry(AppUiSettings._settingNamespace, "WidgetOpacity", () => UiFramework.getWidgetOpacity(), (value) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);
-        this._settings.push(this.widgetOpacity);
-        this.animateToolSettings = new UiStateEntry(AppUiSettings._settingNamespace, "AnimateToolSettings", () => UiFramework.animateToolSettings, (value) => UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);
-        this._settings.push(this.animateToolSettings);
-        this.useToolAsToolSettingsLabel = new UiStateEntry(AppUiSettings._settingNamespace, "UseToolAsToolSettingsLabel", () => UiFramework.useToolAsToolSettingsLabel, (value) => UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);
-        this._settings.push(this.useToolAsToolSettingsLabel);
-        this.toolbarOpacity = new UiStateEntry(AppUiSettings._settingNamespace, "ToolOpacity", () => UiFramework.getToolbarOpacity(), (value) => UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);
-        this._settings.push(this.toolbarOpacity);
-        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";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { UiStateEntry } from "@itwin/core-react";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../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
+ */
+export class AppUiSettings {
+    constructor(defaults) {
+        this.providerId = "AppUiSettingsProvider";
+        this._settings = [];
+        this._applyingLocalSettings = false;
+        this.setColorTheme = (theme) => {
+            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.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.getColorTheme());
+            }
+            if (args.eventIds.has("configurableui:set-drag-interaction"))
+                await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-show-widget-icon"))
+                await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-auto-collapse-unpinned-panels"))
+                await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set_widget_opacity"))
+                await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-animate-tool-settings"))
+                await this.animateToolSettings.saveSetting(UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-use-tool-as-tool-settings-label"))
+                await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());
+            if (args.eventIds.has("configurableui:set-toolbar-opacity"))
+                await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());
+        };
+        this._settings = [];
+        this.colorTheme = new UiStateEntry(AppUiSettings._settingNamespace, "ColorTheme", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);
+        this._settings.push(this.colorTheme);
+        this.dragInteraction = new UiStateEntry(AppUiSettings._settingNamespace, "DragInteraction", () => UiFramework.useDragInteraction, (value) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);
+        this._settings.push(this.dragInteraction);
+        this.showWidgetIcon = new UiStateEntry(AppUiSettings._settingNamespace, "ShowWidgetIcon", () => UiFramework.showWidgetIcon, (value) => UiFramework.setShowWidgetIcon(value), defaults.showWidgetIcon);
+        this._settings.push(this.showWidgetIcon);
+        this.autoCollapseUnpinnedPanels = new UiStateEntry(AppUiSettings._settingNamespace, "AutoCollapseUnpinnedPanels", () => UiFramework.autoCollapseUnpinnedPanels, (value) => UiFramework.setAutoCollapseUnpinnedPanels(value), defaults.autoCollapseUnpinnedPanels);
+        this._settings.push(this.autoCollapseUnpinnedPanels);
+        this.widgetOpacity = new UiStateEntry(AppUiSettings._settingNamespace, "WidgetOpacity", () => UiFramework.getWidgetOpacity(), (value) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);
+        this._settings.push(this.widgetOpacity);
+        this.animateToolSettings = new UiStateEntry(AppUiSettings._settingNamespace, "AnimateToolSettings", () => UiFramework.animateToolSettings, (value) => UiFramework.setAnimateToolSettings(value), defaults.animateToolSettings);
+        this._settings.push(this.animateToolSettings);
+        this.useToolAsToolSettingsLabel = new UiStateEntry(AppUiSettings._settingNamespace, "UseToolAsToolSettingsLabel", () => UiFramework.useToolAsToolSettingsLabel, (value) => UiFramework.setUseToolAsToolSettingsLabel(value), defaults.useToolAsToolSettingsLabel);
+        this._settings.push(this.useToolAsToolSettingsLabel);
+        this.toolbarOpacity = new UiStateEntry(AppUiSettings._settingNamespace, "ToolOpacity", () => UiFramework.getToolbarOpacity(), (value) => UiFramework.setToolbarOpacity(value), defaults.toolbarOpacity);
+        this._settings.push(this.toolbarOpacity);
+        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";
 //# sourceMappingURL=AppUiSettings.js.map

package/lib/esm/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,OAAO,EAAE,YAAY,EAAkB,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAsB,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAqBvF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAa;IAwBxB,YAAY,QAAuC;QAvBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAa/B,kBAAa,GAAG,CAAC,KAAa,EAAE,EAAE;YACxC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QAiDM,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,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,WAAW,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,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,sCAAsC,CAAC;gBAC3D,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,8CAA8C;YAE1H,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QA/EA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EACjG,GAAG,EAAE,CAAC,WAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,EAC/F,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,gBAAgB,GAAG,IAAI,YAAY,CAAqB,aAAa,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,8CAA8C;QAC9J,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,EAAE,8CAA8C;QAC3E,CAAC,KAAyB,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,8CAA8C;QAC5I,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,8CAA8C;QAE1F,IAAI,CAAC,aAAa,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EAC5F,GAAG,EAAE,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,qBAAqB,EACzG,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,aAAa,EAC3F,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IAqCM,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;;AAjHc,+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 { FrameworkVersionId, 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  /** @deprecated UI1.0 is deprecated. */\r\n  frameworkVersion: FrameworkVersionId; // eslint-disable-line deprecation/deprecation\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  /** @deprecated */\r\n  public frameworkVersion: UiStateEntry<FrameworkVersionId>; // eslint-disable-line deprecation/deprecation\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.frameworkVersion = new UiStateEntry<FrameworkVersionId>(AppUiSettings._settingNamespace, \"FrameworkVersion\", // eslint-disable-line deprecation/deprecation\r\n      () => UiFramework.uiVersion, // eslint-disable-line deprecation/deprecation\r\n      (value: FrameworkVersionId) => UiFramework.setUiVersion(value), defaults.frameworkVersion); // eslint-disable-line deprecation/deprecation\r\n    this._settings.push(this.frameworkVersion); // eslint-disable-line deprecation/deprecation\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-framework-version\"))\r\n      await this.frameworkVersion.saveSetting(UiFramework.getUiStateStorage()); // eslint-disable-line deprecation/deprecation\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,OAAO,EAAE,YAAY,EAAkB,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAmBnE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,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,WAAW,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,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACnE,8GAA8G;gBAC9G,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,WAAW,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,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,qCAAqC,CAAC;gBAC1D,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAEzE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kDAAkD,CAAC;gBACvE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAExE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,0CAA0C,CAAC;gBAC/D,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAErF,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oCAAoC,CAAC;gBACzD,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QAvEA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EACjG,GAAG,EAAE,CAAC,WAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,gBAAgB,EAC/F,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EAC5F,GAAG,EAAE,CAAC,WAAW,CAAC,gBAAgB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,qBAAqB,EACzG,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAU,aAAa,CAAC,iBAAiB,EAAE,4BAA4B,EACvH,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,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,YAAY,CAAS,aAAa,CAAC,iBAAiB,EAAE,aAAa,EAC3F,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3H,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,qBAAqB,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,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module 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/esm/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/esm/appui-react/uistate/useUiStateStorage.js

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

package/lib/esm/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,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEvF,cAAc;AACd,MAAM,UAAU,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AACjD,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAiB,IAAI,iBAAiB,EAAE,CAAC,CAAC,CAAC,2DAA2D;AAC9J,qBAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;gBAChG,eAAe,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,qBAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,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 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,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAkB,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEvF,cAAc;AACd,MAAM,UAAU,wBAAwB;IACtC,OAAO,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AACjD,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC,aAAa,CAAiB,IAAI,iBAAiB,EAAE,CAAC,CAAC,CAAC,2DAA2D;AAC9J,qBAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;gBAChG,eAAe,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,oBAAC,qBAAqB,CAAC,QAAQ,IAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,YAAY,GACnB,CACH,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module 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()); // eslint-disable-line @typescript-eslint/naming-convention\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/esm/appui-react/utils/PropsHelper.d.ts

@@ -1,21 +1,21 @@
-/** @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 { 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>;
+}
 //# sourceMappingURL=PropsHelper.d.ts.map

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

@@ -1,63 +1,63 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import * as React from "react";
-import { ConditionalStringValue } from "@itwin/appui-abstract";
-import { Icon, IconHelper } from "@itwin/core-react";
-import { UiFramework } from "../UiFramework";
-/** A set of helper methods for various props
- * @public
- */
-export 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, stringKey) {
-        if (explicitValue) {
-            return explicitValue;
-        }
-        let outValue = "";
-        if (stringKey)
-            outValue = UiFramework.localization.getLocalizedString(stringKey);
-        return outValue;
-    }
-    /** Get the display string. */
-    static getStringFromSpec(spec) {
-        let label = "";
-        if (typeof spec === "string")
-            label = spec;
-        else if (spec instanceof ConditionalStringValue)
-            label = spec.value;
-        else
-            label = spec();
-        return label;
-    }
-    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    static getIcon(iconSpec) {
-        if (iconSpec instanceof ConditionalStringValue)
-            return React.createElement(Icon, { iconSpec: iconSpec.value });
-        return (iconSpec) ? React.createElement(Icon, { iconSpec: iconSpec }) : undefined;
-    }
-    /** returns true if the two objects are the same using a shallow compare of each property */
-    static isShallowEqual(newObj, prevObj) {
-        for (const key in newObj) {
-            if (newObj[key] !== prevObj[key])
-                return false;
-        }
-        return true;
-    }
-    static getAbstractPropsForReactIcon(iconSpec, internalData) {
-        // istanbul ignore else
-        if (!iconSpec || !React.isValidElement(iconSpec))
-            return {};
-        // istanbul ignore else
-        if (!internalData)
-            internalData = new Map();
-        const icon = IconHelper.getIconData(iconSpec, internalData);
-        return (icon === "" ? { icon } : { icon, internalData });
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import * as React from "react";
+import { ConditionalStringValue } from "@itwin/appui-abstract";
+import { Icon, IconHelper } from "@itwin/core-react";
+import { UiFramework } from "../UiFramework";
+/** A set of helper methods for various props
+ * @public
+ */
+export 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, stringKey) {
+        if (explicitValue) {
+            return explicitValue;
+        }
+        let outValue = "";
+        if (stringKey)
+            outValue = UiFramework.localization.getLocalizedString(stringKey);
+        return outValue;
+    }
+    /** Get the display string. */
+    static getStringFromSpec(spec) {
+        let label = "";
+        if (typeof spec === "string")
+            label = spec;
+        else if (spec instanceof ConditionalStringValue)
+            label = spec.value;
+        else
+            label = spec();
+        return label;
+    }
+    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    static getIcon(iconSpec) {
+        if (iconSpec instanceof ConditionalStringValue)
+            return React.createElement(Icon, { iconSpec: iconSpec.value });
+        return (iconSpec) ? React.createElement(Icon, { iconSpec: iconSpec }) : undefined;
+    }
+    /** returns true if the two objects are the same using a shallow compare of each property */
+    static isShallowEqual(newObj, prevObj) {
+        for (const key in newObj) {
+            if (newObj[key] !== prevObj[key])
+                return false;
+        }
+        return true;
+    }
+    static getAbstractPropsForReactIcon(iconSpec, internalData) {
+        // istanbul ignore else
+        if (!iconSpec || !React.isValidElement(iconSpec))
+            return {};
+        // istanbul ignore else
+        if (!internalData)
+            internalData = new Map();
+        const icon = IconHelper.getIconData(iconSpec, internalData);
+        return (icon === "" ? { icon } : { icon, internalData });
+    }
+}
 //# sourceMappingURL=PropsHelper.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAsC,sBAAsB,EAAgB,MAAM,uBAAuB,CAAC;AACjH,OAAO,EAAE,IAAI,EAAE,UAAU,EAAY,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CAAC,aAAyE,EAAE,SAAkB;QACvH,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS;YACX,QAAQ,GAAG,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAAC,IAAoD;QAClF,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,KAAK,GAAG,IAAI,CAAC;aACV,IAAI,IAAI,YAAY,sBAAsB;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAEnB,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IAC/J,gEAAgE;IACzD,MAAM,CAAC,OAAO,CAAC,QAA2D;QAC/E,IAAI,QAAQ,YAAY,sBAAsB;YAC5C,OAAO,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,4BAA4B,CAAC,QAAkB,EAAE,YAA+B;QAC5F,uBAAuB;QACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,YAAY;YACf,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAEvC,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IACxD,CAAC;CACF","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 * as React from \"react\";\r\nimport { AbstractWidgetProps, BackstageItem, ConditionalStringValue, StringGetter } from \"@itwin/appui-abstract\";\r\nimport { Icon, IconHelper, IconSpec } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/** A set of helper methods for various props\r\n * @public\r\n */\r\nexport class PropsHelper {\r\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\r\n  public static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue {\r\n    if (explicitValue) {\r\n      return explicitValue;\r\n    }\r\n\r\n    let outValue = \"\";\r\n    if (stringKey)\r\n      outValue = UiFramework.localization.getLocalizedString(stringKey);\r\n    return outValue;\r\n  }\r\n\r\n  /** Get the display string. */\r\n  public static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string {\r\n    let label = \"\";\r\n    if (typeof spec === \"string\")\r\n      label = spec;\r\n    else if (spec instanceof ConditionalStringValue)\r\n      label = spec.value;\r\n    else\r\n      label = spec();\r\n    return label;\r\n  }\r\n\r\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  public static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined {\r\n    if (iconSpec instanceof ConditionalStringValue)\r\n      return <Icon iconSpec={iconSpec.value} />;\r\n\r\n    return (iconSpec) ? <Icon iconSpec={iconSpec} /> : undefined;\r\n  }\r\n\r\n  /** returns true if the two objects are the same using a shallow compare of each property */\r\n  public static isShallowEqual(newObj: any, prevObj: any) {\r\n    for (const key in newObj) {\r\n      if (newObj[key] !== prevObj[key]) return false;\r\n    }\r\n    return true;\r\n  }\r\n  public static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<AbstractWidgetProps> | Partial<BackstageItem> {\r\n    // istanbul ignore else\r\n    if (!iconSpec || !React.isValidElement(iconSpec))\r\n      return {};\r\n\r\n    // istanbul ignore else\r\n    if (!internalData)\r\n      internalData = new Map<string,any>();\r\n\r\n    const icon = IconHelper.getIconData(iconSpec, internalData);\r\n\r\n    return (icon === \"\" ? {icon} : {icon, internalData });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAsC,sBAAsB,EAAgB,MAAM,uBAAuB,CAAC;AACjH,OAAO,EAAE,IAAI,EAAE,UAAU,EAAY,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CAAC,aAAyE,EAAE,SAAkB;QACvH,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS;YACX,QAAQ,GAAG,WAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAAC,IAAoD;QAClF,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,KAAK,GAAG,IAAI,CAAC;aACV,IAAI,IAAI,YAAY,sBAAsB;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAEnB,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IAC/J,gEAAgE;IACzD,MAAM,CAAC,OAAO,CAAC,QAA2D;QAC/E,IAAI,QAAQ,YAAY,sBAAsB;YAC5C,OAAO,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAC,IAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,4BAA4B,CAAC,QAAkB,EAAE,YAA+B;QAC5F,uBAAuB;QACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,YAAY;YACf,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAEvC,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IACxD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utilities\n */\n\nimport * as React from \"react\";\nimport { AbstractWidgetProps, BackstageItem, ConditionalStringValue, StringGetter } from \"@itwin/appui-abstract\";\nimport { Icon, IconHelper, IconSpec } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** A set of helper methods for various props\n * @public\n */\nexport class PropsHelper {\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\n  public static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue {\n    if (explicitValue) {\n      return explicitValue;\n    }\n\n    let outValue = \"\";\n    if (stringKey)\n      outValue = UiFramework.localization.getLocalizedString(stringKey);\n    return outValue;\n  }\n\n  /** Get the display string. */\n  public static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string {\n    let label = \"\";\n    if (typeof spec === \"string\")\n      label = spec;\n    else if (spec instanceof ConditionalStringValue)\n      label = spec.value;\n    else\n      label = spec();\n    return label;\n  }\n\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  public static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined {\n    if (iconSpec instanceof ConditionalStringValue)\n      return <Icon iconSpec={iconSpec.value} />;\n\n    return (iconSpec) ? <Icon iconSpec={iconSpec} /> : undefined;\n  }\n\n  /** returns true if the two objects are the same using a shallow compare of each property */\n  public static isShallowEqual(newObj: any, prevObj: any) {\n    for (const key in newObj) {\n      if (newObj[key] !== prevObj[key]) return false;\n    }\n    return true;\n  }\n  public static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<AbstractWidgetProps> | Partial<BackstageItem> {\n    // istanbul ignore else\n    if (!iconSpec || !React.isValidElement(iconSpec))\n      return {};\n\n    // istanbul ignore else\n    if (!internalData)\n      internalData = new Map<string,any>();\n\n    const icon = IconHelper.getIconData(iconSpec, internalData);\n\n    return (icon === \"\" ? {icon} : {icon, internalData });\n  }\n}\n"]}

package/lib/esm/appui-react/utils/ToolbarButtonHelper.d.ts

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module Utilities
- */
-/** A set of Dom helper methods
- * @public
- */
-export declare class ToolbarButtonHelper {
-    static searchToolbarsByTitle(title: string, horizontal: boolean): HTMLButtonElement | null;
-    /** Search Horizontal Toolbars for button by title. */
-    static searchHorizontalToolbarsByTitle(title: string): HTMLButtonElement | null;
-    /** Search Vertical Toolbars by Title for button by title. */
-    static searchVerticalToolbarsByTitle(title: string): HTMLButtonElement | null;
-    /** Get toolbar button by title. */
-    static getToolbarButtonByTitle(title: string): HTMLButtonElement | null;
-    /** Get App button. */
-    static getAppButton(): HTMLButtonElement | null;
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+/** A set of Dom helper methods
+ * @public
+ */
+export declare class ToolbarButtonHelper {
+    static searchToolbarsByTitle(title: string, horizontal: boolean): HTMLButtonElement | null;
+    /** Search Horizontal Toolbars for button by title. */
+    static searchHorizontalToolbarsByTitle(title: string): HTMLButtonElement | null;
+    /** Search Vertical Toolbars by Title for button by title. */
+    static searchVerticalToolbarsByTitle(title: string): HTMLButtonElement | null;
+    /** Get toolbar button by title. */
+    static getToolbarButtonByTitle(title: string): HTMLButtonElement | null;
+    /** Get App button. */
+    static getAppButton(): HTMLButtonElement | null;
+}
 //# sourceMappingURL=ToolbarButtonHelper.d.ts.map