@itwin/appui-react 3.0.0-dev.100

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

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { UiSetting } 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.getUiSettingsStorage());
+                // 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.getUiSettingsStorage());
+            if (args.eventIds.has("configurableui:set-framework-version"))
+                await this.frameworkVersion.saveSetting(UiFramework.getUiSettingsStorage());
+            if (args.eventIds.has("configurableui:set_widget_opacity"))
+                await this.widgetOpacity.saveSetting(UiFramework.getUiSettingsStorage());
+        };
+        this._settings = [];
+        this.colorTheme = new UiSetting(AppUiSettings._settingNamespace, "ColorTheme", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);
+        this._settings.push(this.colorTheme);
+        this.dragInteraction = new UiSetting(AppUiSettings._settingNamespace, "DragInteraction", () => UiFramework.useDragInteraction, (value) => UiFramework.setUseDragInteraction(value), defaults.dragInteraction);
+        this._settings.push(this.dragInteraction);
+        this.frameworkVersion = new UiSetting(AppUiSettings._settingNamespace, "FrameworkVersion", () => UiFramework.uiVersion, (value) => UiFramework.setUiVersion(value), defaults.frameworkVersion);
+        this._settings.push(this.frameworkVersion);
+        this.widgetOpacity = new UiSetting(AppUiSettings._settingNamespace, "WidgetOpacity", () => UiFramework.getWidgetOpacity(), (value) => UiFramework.setWidgetOpacity(value), defaults.widgetOpacity);
+        this._settings.push(this.widgetOpacity);
+        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/uisettings/AppUiSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uisettings/AppUiSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAqB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAmB,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EAAsB,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AAcvF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAa;IAkBxB,YAAY,QAAuC;QAjBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA0B,EAAE,CAAC;QACtC,2BAAsB,GAAG,KAAK,CAAC;QAO/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;QAyBM,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,oBAAoB,EAAE,CAAC,CAAC;gBACtE,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,oBAAoB,EAAE,CAAC,CAAC;YAE7E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,sCAAsC,CAAC;gBAC3D,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,oBAAoB,EAAE,CAAC,CAAC;YAE9E,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,mCAAmC,CAAC;gBACxD,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAC7E,CAAC,CAAC;QAxCA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,SAAS,CAAS,aAAa,CAAC,iBAAiB,EAAE,YAAY,EAAE,WAAW,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3J,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,SAAS,CAAU,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,EAC9F,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,gBAAgB,GAAG,IAAI,SAAS,CAAqB,aAAa,CAAC,iBAAiB,EAAE,kBAAkB,EAC3G,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,EAC3B,CAAC,KAAyB,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAE3C,IAAI,CAAC,aAAa,GAAG,IAAI,SAAS,CAAS,aAAa,CAAC,iBAAiB,EAAE,eAAe,EACzF,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,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1E,CAAC;IAsBM,KAAK,CAAC,KAAK,CAAC,OAA0B;QAC3C,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,OAA0B;QACtD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;;AApEc,+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 { UiSetting, UiSettingsStorage } from \"@itwin/core-react\";\r\nimport { SyncUiEventArgs, 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  frameworkVersion: FrameworkVersionId;\r\n  widgetOpacity: 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<UiSetting<any>> = [];\r\n  private _applyingLocalSettings = false;\r\n\r\n  public colorTheme: UiSetting<string>;\r\n  public dragInteraction: UiSetting<boolean>;\r\n  public frameworkVersion: UiSetting<FrameworkVersionId>;\r\n  public widgetOpacity: UiSetting<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 UiSetting<string>(AppUiSettings._settingNamespace, \"ColorTheme\", UiFramework.getColorTheme, this.setColorTheme, defaults.colorTheme);\r\n    this._settings.push(this.colorTheme);\r\n\r\n    this.dragInteraction = new UiSetting<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.frameworkVersion = new UiSetting<FrameworkVersionId>(AppUiSettings._settingNamespace, \"FrameworkVersion\",\r\n      () => UiFramework.uiVersion,\r\n      (value: FrameworkVersionId) => UiFramework.setUiVersion(value), defaults.frameworkVersion);\r\n    this._settings.push(this.frameworkVersion);\r\n\r\n    this.widgetOpacity = new UiSetting<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    SyncUiEventDispatcher.onSyncUiEvent.addListener(this.handleSyncUiEvent);\r\n  }\r\n\r\n  private handleSyncUiEvent = async (args: SyncUiEventArgs) => {\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.getUiSettingsStorage());\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.getUiSettingsStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set-framework-version\"))\r\n      await this.frameworkVersion.saveSetting(UiFramework.getUiSettingsStorage());\r\n\r\n    if (args.eventIds.has(\"configurableui:set_widget_opacity\"))\r\n      await this.widgetOpacity.saveSetting(UiFramework.getUiSettingsStorage());\r\n  };\r\n\r\n  public async apply(storage: UiSettingsStorage): 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: UiSettingsStorage): Promise<void> {\r\n    await this.apply(storage);\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/uisettings/UserSettingsStorage.d.ts

@@ -0,0 +1,23 @@
+/** @packageDocumentation
+ * @module UiSettings
+ */
+import { SettingsStatus } from "@bentley/product-settings-client";
+import { UiSettingsResult, UiSettingsStatus, UiSettingsStorage } from "@itwin/core-react";
+/**
+ * Implementation of [[UiSettings]] that uses settings admin from `IModelApp.settings`.
+ * @public
+ */
+export declare class UserSettingsStorage implements UiSettingsStorage {
+    getSetting(namespace: string, name: string): Promise<UiSettingsResult>;
+    saveSetting(namespace: string, name: string, setting: any): Promise<UiSettingsResult>;
+    deleteSetting(namespace: string, name: string): Promise<UiSettingsResult>;
+}
+/** @internal */
+export declare function settingsStatusToUiSettingsStatus(status: SettingsStatus): UiSettingsStatus;
+/** Alias for [[UserSettingsStorage]]
+ * @beta
+ * @deprecated use UserSettingsStorage
+ */
+export declare class IModelAppUiSettings extends UserSettingsStorage {
+}
+//# sourceMappingURL=UserSettingsStorage.d.ts.map

package/lib/esm/appui-react/uisettings/UserSettingsStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserSettingsStorage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uisettings/UserSettingsStorage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE1F;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,iBAAiB;IAC9C,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IActE,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYrF,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAWvF;AAED,gBAAgB;AAChB,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,cAAc,GAAG,gBAAgB,CAQzF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,mBAAmB;CAC3D"}

package/lib/esm/appui-react/uisettings/UserSettingsStorage.js

@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiSettings
+ */
+import { IModelApp } from "@itwin/core-frontend";
+import { SettingsStatus } from "@bentley/product-settings-client";
+import { UiSettingsStatus } from "@itwin/core-react";
+/**
+ * Implementation of [[UiSettings]] that uses settings admin from `IModelApp.settings`.
+ * @public
+ */
+export class UserSettingsStorage {
+    async getSetting(namespace, name) {
+        if (undefined === IModelApp.authorizationClient)
+            return { status: UiSettingsStatus.AuthorizationError };
+        const accessToken = await IModelApp.getAccessToken();
+        if (accessToken === "")
+            return { status: UiSettingsStatus.AuthorizationError };
+        const result = await IModelApp.settings.getUserSetting(accessToken, namespace, name, true);
+        const status = settingsStatusToUiSettingsStatus(result.status);
+        return {
+            status,
+            setting: result.setting,
+        };
+    }
+    async saveSetting(namespace, name, setting) {
+        const accessToken = await IModelApp.getAccessToken();
+        if (accessToken === "")
+            return { status: UiSettingsStatus.AuthorizationError };
+        const result = await IModelApp.settings.saveUserSetting(accessToken, setting, namespace, name, true);
+        const status = settingsStatusToUiSettingsStatus(result.status);
+        return {
+            status,
+            setting: result.setting,
+        };
+    }
+    async deleteSetting(namespace, name) {
+        const accessToken = await IModelApp.getAccessToken();
+        if (accessToken === "")
+            return { status: UiSettingsStatus.AuthorizationError };
+        const result = await IModelApp.settings.deleteUserSetting(accessToken, namespace, name, true);
+        const status = settingsStatusToUiSettingsStatus(result.status);
+        return {
+            status,
+            setting: result.setting,
+        };
+    }
+}
+/** @internal */
+export function settingsStatusToUiSettingsStatus(status) {
+    if (status === SettingsStatus.Success)
+        return UiSettingsStatus.Success;
+    else if (status === SettingsStatus.SettingNotFound)
+        return UiSettingsStatus.NotFound;
+    else if (status === SettingsStatus.AuthorizationError)
+        return UiSettingsStatus.AuthorizationError;
+    return UiSettingsStatus.UnknownError;
+}
+/** Alias for [[UserSettingsStorage]]
+ * @beta
+ * @deprecated use UserSettingsStorage
+ */
+export class IModelAppUiSettings extends UserSettingsStorage {
+}
+//# sourceMappingURL=UserSettingsStorage.js.map

package/lib/esm/appui-react/uisettings/UserSettingsStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserSettingsStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uisettings/UserSettingsStorage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAoB,gBAAgB,EAAqB,MAAM,mBAAmB,CAAC;AAE1F;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IACvB,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,IAAY;QACrD,IAAI,SAAS,KAAK,SAAS,CAAC,mBAAmB;YAC7C,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;QACzD,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,CAAC;QACrD,IAAI,WAAW,KAAK,EAAE;YACpB,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3F,MAAM,MAAM,GAAG,gCAAgC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO;YACL,MAAM;YACN,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,IAAY,EAAE,OAAY;QACpE,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,CAAC;QACrD,IAAI,WAAW,KAAK,EAAE;YACpB,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACrG,MAAM,MAAM,GAAG,gCAAgC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO;YACL,MAAM;YACN,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,IAAY;QACxD,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,cAAc,EAAE,CAAC;QACrD,IAAI,WAAW,KAAK,EAAE;YACpB,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9F,MAAM,MAAM,GAAG,gCAAgC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO;YACL,MAAM;YACN,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,UAAU,gCAAgC,CAAC,MAAsB;IACrE,IAAI,MAAM,KAAK,cAAc,CAAC,OAAO;QACnC,OAAO,gBAAgB,CAAC,OAAO,CAAC;SAC7B,IAAI,MAAM,KAAK,cAAc,CAAC,eAAe;QAChD,OAAO,gBAAgB,CAAC,QAAQ,CAAC;SAC9B,IAAI,MAAM,KAAK,cAAc,CAAC,kBAAkB;QACnD,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC7C,OAAO,gBAAgB,CAAC,YAAY,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,mBAAmB;CAC3D","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 UiSettings\r\n */\r\n\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { SettingsStatus } from \"@bentley/product-settings-client\";\r\nimport { UiSettingsResult, UiSettingsStatus, UiSettingsStorage } from \"@itwin/core-react\";\r\n\r\n/**\r\n * Implementation of [[UiSettings]] that uses settings admin from `IModelApp.settings`.\r\n * @public\r\n */\r\nexport class UserSettingsStorage implements UiSettingsStorage {\r\n  public async getSetting(namespace: string, name: string): Promise<UiSettingsResult> {\r\n    if (undefined === IModelApp.authorizationClient)\r\n      return { status: UiSettingsStatus.AuthorizationError };\r\n    const accessToken = await IModelApp.getAccessToken();\r\n    if (accessToken === \"\")\r\n      return { status: UiSettingsStatus.AuthorizationError };\r\n    const result = await IModelApp.settings.getUserSetting(accessToken, namespace, name, true);\r\n    const status = settingsStatusToUiSettingsStatus(result.status);\r\n    return {\r\n      status,\r\n      setting: result.setting,\r\n    };\r\n  }\r\n\r\n  public async saveSetting(namespace: string, name: string, setting: any): Promise<UiSettingsResult> {\r\n    const accessToken = await IModelApp.getAccessToken();\r\n    if (accessToken === \"\")\r\n      return { status: UiSettingsStatus.AuthorizationError };\r\n    const result = await IModelApp.settings.saveUserSetting(accessToken, setting, namespace, name, true);\r\n    const status = settingsStatusToUiSettingsStatus(result.status);\r\n    return {\r\n      status,\r\n      setting: result.setting,\r\n    };\r\n  }\r\n\r\n  public async deleteSetting(namespace: string, name: string): Promise<UiSettingsResult> {\r\n    const accessToken = await IModelApp.getAccessToken();\r\n    if (accessToken === \"\")\r\n      return { status: UiSettingsStatus.AuthorizationError };\r\n    const result = await IModelApp.settings.deleteUserSetting(accessToken, namespace, name, true);\r\n    const status = settingsStatusToUiSettingsStatus(result.status);\r\n    return {\r\n      status,\r\n      setting: result.setting,\r\n    };\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport function settingsStatusToUiSettingsStatus(status: SettingsStatus): UiSettingsStatus {\r\n  if (status === SettingsStatus.Success)\r\n    return UiSettingsStatus.Success;\r\n  else if (status === SettingsStatus.SettingNotFound)\r\n    return UiSettingsStatus.NotFound;\r\n  else if (status === SettingsStatus.AuthorizationError)\r\n    return UiSettingsStatus.AuthorizationError;\r\n  return UiSettingsStatus.UnknownError;\r\n}\r\n\r\n/** Alias for [[UserSettingsStorage]]\r\n * @beta\r\n * @deprecated use UserSettingsStorage\r\n */\r\nexport class IModelAppUiSettings extends UserSettingsStorage {\r\n}\r\n"]}

package/lib/esm/appui-react/uisettings/useUiSettings.d.ts

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

package/lib/esm/appui-react/uisettings/useUiSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUiSettings.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uisettings/useUiSettings.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAwB,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE5E,cAAc;AACd,wBAAgB,2BAA2B,IAAI,iBAAiB,CAE/D;AAED,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,kCAAqE,CAAC;AAGpG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,eAAe,EAAE,iBAAiB,CAAC;CACpC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,eAOhE"}

package/lib/esm/appui-react/uisettings/useUiSettings.js

@@ -0,0 +1,23 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiSettings
+ */
+import * as React from "react";
+import { LocalSettingsStorage } from "@itwin/core-react";
+/** @public */
+export function useUiSettingsStorageContext() {
+    return React.useContext(UiSettingsContext);
+}
+/** @internal */
+export const UiSettingsContext = React.createContext(new LocalSettingsStorage()); // eslint-disable-line @typescript-eslint/naming-convention
+UiSettingsContext.displayName = "uifw:UiSettingsContext";
+/** Allows to provide a custom [[UiSettings]] implementation to persist UI settings.
+ * @public
+ */
+export function UiSettingsProvider(props) {
+    return (React.createElement(UiSettingsContext.Provider, { children: props.children, value: props.settingsStorage }));
+}
+//# sourceMappingURL=useUiSettings.js.map

package/lib/esm/appui-react/uisettings/useUiSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uisettings/useUiSettings.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAqB,MAAM,mBAAmB,CAAC;AAE5E,cAAc;AACd,MAAM,UAAU,2BAA2B;IACzC,OAAO,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAC7C,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAoB,IAAI,oBAAoB,EAAE,CAAC,CAAC,CAAC,2DAA2D;AAChK,iBAAiB,CAAC,WAAW,GAAG,wBAAwB,CAAC;AAUzD;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAA8B;IAC/D,OAAO,CACL,oBAAC,iBAAiB,CAAC,QAAQ,IACzB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,KAAK,CAAC,eAAe,GAC5B,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 UiSettings\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { LocalSettingsStorage, UiSettingsStorage } from \"@itwin/core-react\";\r\n\r\n/** @public */\r\nexport function useUiSettingsStorageContext(): UiSettingsStorage {\r\n  return React.useContext(UiSettingsContext);\r\n}\r\n\r\n/** @internal */\r\nexport const UiSettingsContext = React.createContext<UiSettingsStorage>(new LocalSettingsStorage()); // eslint-disable-line @typescript-eslint/naming-convention\r\nUiSettingsContext.displayName = \"uifw:UiSettingsContext\";\r\n\r\n/** Properties for the [[UiSettingsProvider]] component.\r\n * @public\r\n */\r\nexport interface UiSettingsProviderProps {\r\n  children?: React.ReactNode;\r\n  settingsStorage: UiSettingsStorage;\r\n}\r\n\r\n/** Allows to provide a custom [[UiSettings]] implementation to persist UI settings.\r\n * @public\r\n */\r\nexport function UiSettingsProvider(props: UiSettingsProviderProps) {\r\n  return (\r\n    <UiSettingsContext.Provider\r\n      children={props.children} // eslint-disable-line react/no-children-prop\r\n      value={props.settingsStorage}\r\n    />\r\n  );\r\n}\r\n"]}

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

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import * as React from "react";
+import { ConditionalStringValue, StringGetter } from "@itwin/appui-abstract";
+/** A set of helper methods for various props
+ * @public
+ */
+export declare class PropsHelper {
+    /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
+    static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue;
+    /** Get the display string. */
+    static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string;
+    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
+    static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined;
+    /** returns true if the two objects are the same using a shallow compare of each property */
+    static isShallowEqual(newObj: any, prevObj: any): boolean;
+}
+//# sourceMappingURL=PropsHelper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAI7E;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;CAMvD"}

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

@@ -0,0 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+* 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 } 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;
+    }
+}
+//# sourceMappingURL=PropsHelper.js.map

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

@@ -0,0 +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,EAAE,sBAAsB,EAAgB,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,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;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 { ConditionalStringValue, StringGetter } from \"@itwin/appui-abstract\";\r\nimport { Icon } 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}\r\n"]}

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

@@ -0,0 +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;
+}
+//# sourceMappingURL=ToolbarButtonHelper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarButtonHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/ToolbarButtonHelper.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;GAEG;AACH,qBAAa,mBAAmB;WAEhB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,iBAAiB,GAAG,IAAI;IAgBjG,sDAAsD;WACxC,+BAA+B,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI;IAItF,6DAA6D;WAC/C,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI;IAIpF,mCAAmC;WACrB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI;IAe9E,sBAAsB;WACR,YAAY,IAAI,iBAAiB,GAAG,IAAI;CAQvD"}

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

@@ -0,0 +1,57 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** A set of Dom helper methods
+ * @public
+ */
+export class ToolbarButtonHelper {
+    static searchToolbarsByTitle(title, horizontal) {
+        // first look for simple tool buttons
+        const nodeList = document.documentElement.querySelectorAll(`div.nz-toolbar-items.nz-${horizontal ? "horizontal" : "vertical"}.nz-items .nz-toolbar-item-item`);
+        // istanbul ignore else
+        if (nodeList && nodeList.length > 0) {
+            for (const node of nodeList) {
+                const button = node;
+                if (button.title === title) {
+                    return button;
+                }
+            }
+        }
+        return null;
+    }
+    /** Search Horizontal Toolbars for button by title. */
+    static searchHorizontalToolbarsByTitle(title) {
+        return ToolbarButtonHelper.searchToolbarsByTitle(title, true);
+    }
+    /** Search Vertical Toolbars by Title for button by title. */
+    static searchVerticalToolbarsByTitle(title) {
+        return ToolbarButtonHelper.searchToolbarsByTitle(title, false);
+    }
+    /** Get toolbar button by title. */
+    static getToolbarButtonByTitle(title) {
+        let button = ToolbarButtonHelper.searchHorizontalToolbarsByTitle(title);
+        // istanbul ignore if
+        if (button)
+            return button;
+        button = ToolbarButtonHelper.searchVerticalToolbarsByTitle(title);
+        // istanbul ignore else
+        if (button)
+            return button;
+        // istanbul ignore next
+        return null;
+    }
+    /** Get App button. */
+    static getAppButton() {
+        const node = document.documentElement.querySelector("div.nz-app-button > button");
+        // istanbul ignore else
+        if (node)
+            return node;
+        // istanbul ignore next
+        return null;
+    }
+}
+//# sourceMappingURL=ToolbarButtonHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarButtonHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/ToolbarButtonHelper.ts"],"names":[],"mappings":"AACA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAEvB,MAAM,CAAC,qBAAqB,CAAC,KAAa,EAAE,UAAmB;QACpE,qCAAqC;QACrC,MAAM,QAAQ,GAAG,QAAQ,CAAC,eAAe,CAAC,gBAAgB,CAAC,2BAA2B,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,iCAAiC,CAAC,CAAC;QAC/J,uBAAuB;QACvB,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;gBAC3B,MAAM,MAAM,GAAG,IAAyB,CAAC;gBACzC,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,EAAE;oBAC1B,OAAO,MAAM,CAAC;iBACf;aACF;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,+BAA+B,CAAC,KAAa;QACzD,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,6BAA6B,CAAC,KAAa;QACvD,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,mCAAmC;IAC5B,MAAM,CAAC,uBAAuB,CAAC,KAAa;QACjD,IAAI,MAAM,GAAG,mBAAmB,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;QACxE,qBAAqB;QACrB,IAAI,MAAM;YACR,OAAO,MAAM,CAAC;QAEhB,MAAM,GAAG,mBAAmB,CAAC,6BAA6B,CAAC,KAAK,CAAC,CAAC;QAClE,uBAAuB;QACvB,IAAI,MAAM;YACR,OAAO,MAAM,CAAC;QAEhB,uBAAuB;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;IACf,MAAM,CAAC,YAAY;QACxB,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,CAAC,aAAa,CAAC,4BAA4B,CAAC,CAAC;QAClF,uBAAuB;QACvB,IAAI,IAAI;YACN,OAAO,IAAyB,CAAC;QACnC,uBAAuB;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["\r\n/*---------------------------------------------------------------------------------------------\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\n/** A set of Dom helper methods\r\n * @public\r\n */\r\nexport class ToolbarButtonHelper {\r\n\r\n  public static searchToolbarsByTitle(title: string, horizontal: boolean): HTMLButtonElement | null {\r\n    // first look for simple tool buttons\r\n    const nodeList = document.documentElement.querySelectorAll(`div.nz-toolbar-items.nz-${horizontal ? \"horizontal\" : \"vertical\"}.nz-items .nz-toolbar-item-item`);\r\n    // istanbul ignore else\r\n    if (nodeList && nodeList.length > 0) {\r\n      for (const node of nodeList) {\r\n        const button = node as HTMLButtonElement;\r\n        if (button.title === title) {\r\n          return button;\r\n        }\r\n      }\r\n    }\r\n\r\n    return null;\r\n  }\r\n\r\n  /** Search Horizontal Toolbars for button by title. */\r\n  public static searchHorizontalToolbarsByTitle(title: string): HTMLButtonElement | null {\r\n    return ToolbarButtonHelper.searchToolbarsByTitle(title, true);\r\n  }\r\n\r\n  /** Search Vertical Toolbars by Title for button by title. */\r\n  public static searchVerticalToolbarsByTitle(title: string): HTMLButtonElement | null {\r\n    return ToolbarButtonHelper.searchToolbarsByTitle(title, false);\r\n  }\r\n\r\n  /** Get toolbar button by title. */\r\n  public static getToolbarButtonByTitle(title: string): HTMLButtonElement | null {\r\n    let button = ToolbarButtonHelper.searchHorizontalToolbarsByTitle(title);\r\n    // istanbul ignore if\r\n    if (button)\r\n      return button;\r\n\r\n    button = ToolbarButtonHelper.searchVerticalToolbarsByTitle(title);\r\n    // istanbul ignore else\r\n    if (button)\r\n      return button;\r\n\r\n    // istanbul ignore next\r\n    return null;\r\n  }\r\n\r\n  /** Get App button. */\r\n  public static getAppButton(): HTMLButtonElement | null {\r\n    const node = document.documentElement.querySelector(\"div.nz-app-button > button\");\r\n    // istanbul ignore else\r\n    if (node)\r\n      return node as HTMLButtonElement;\r\n    // istanbul ignore next\r\n    return null;\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,84 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+/// <reference types="react" />
+import { UiSettings } 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: UiSettings): Promise<void>;
+    static storeAutoHideUi(v: boolean, storage?: UiSettings): Promise<void>;
+    static storeUseProximityOpacity(v: boolean, storage?: UiSettings): Promise<void>;
+    static storeSnapWidgetOpacity(v: boolean, storage?: UiSettings): 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.
+ * @public
+ */
+export declare class UiShowHideManager {
+    private static _isUiVisible;
+    private static _autoHideUi;
+    private static _showHidePanels;
+    private static _showHideFooter;
+    private static _inactivityTime;
+    private static _timeout;
+    private static _useProximityOpacity;
+    private static _snapWidgetOpacity;
+    /** Determines if the Ui is visible */
+    static get isUiVisible(): boolean;
+    static set isUiVisible(visible: boolean);
+    /** @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=UiShowHideManager.d.ts.map

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

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