@itwin/appui-react 4.6.4 → 4.7.1

package/lib/esm/appui-react/ui-items-provider/UiItemsProvider.d.ts

@@ -13,13 +13,39 @@ import type { Widget } from "../widgets/Widget";
 export interface UiItemsProvider {
     /** Id of provider. */
     readonly id: string;
-    /** Provides toolbar items. */
+    /** Provides toolbar items.
+     * @note Use [[ToolbarItem.layouts]] to map item to location previously specified by `provideToolbarItems` arguments.
+     * @alpha
+     */
+    readonly getToolbarItems?: () => ReadonlyArray<ToolbarItem>;
+    /** Provides status bar items.
+     * @alpha
+     */
+    readonly getStatusBarItems?: () => ReadonlyArray<StatusBarItem>;
+    /** Provides backstage items.
+     * @alpha
+     */
+    readonly getBackstageItems?: () => ReadonlyArray<BackstageItem>;
+    /** Provides widgets.
+     * @note Use [[Widget.layouts]] to map item to location previously specified by `provideWidgets` arguments.
+     * @alpha
+     */
+    readonly getWidgets?: () => ReadonlyArray<Widget>;
+    /** Provides toolbar items.
+     * @note Use [[UiItemsProvider.getToolbarItems]] instead. To map item to location previously specified by arguments use [[ToolbarItem.layouts]].
+     */
     readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;
-    /** Provides status bar items. */
+    /** Provides status bar items.
+     * @note Use [[UiItemsProvider.getStatusBarItems]] instead.
+     */
     readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;
-    /** Provides backstage items. */
+    /** Provides backstage items.
+     * @note Use [[UiItemsProvider.getBackstageItems]] instead.
+     */
     readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;
-    /** Provides widgets. */
+    /** Provides widgets.
+     * @note Use [[UiItemsProvider.getWidgets]] instead. To map item to location previously specified by arguments use [[Widget.layouts]].
+     */
     readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => ReadonlyArray<Widget>;
     /** Function called when the provider is unregistered. Allows provider to do a cleanup. */
     readonly onUnregister?: () => void;

package/lib/esm/appui-react/ui-items-provider/UiItemsProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACb,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sBAAsB;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,8BAA8B;IAC9B,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAC7B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,YAAY,EAC1B,kBAAkB,EAAE,kBAAkB,KACnC,aAAa,CAAC,WAAW,CAAC,CAAC;IAChC,iCAAiC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAC/B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,KACf,aAAa,CAAC,aAAa,CAAC,CAAC;IAClC,gCAAgC;IAChC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IACpE,wBAAwB;IACxB,QAAQ,CAAC,cAAc,CAAC,EAAE,CACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,CAAC,EAAE,iBAAiB,KACxB,aAAa,CAAC,MAAM,CAAC,CAAC;IAC3B,0FAA0F;IAC1F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CACpC"}
+{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACb,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sBAAsB;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;IAC5D;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IAChE;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IAChE;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAC7B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,YAAY,EAC1B,kBAAkB,EAAE,kBAAkB,KACnC,aAAa,CAAC,WAAW,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAC/B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,KACf,aAAa,CAAC,aAAa,CAAC,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IACpE;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,CACxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,CAAC,EAAE,iBAAiB,KACxB,aAAa,CAAC,MAAM,CAAC,CAAC;IAC3B,0FAA0F;IAC1F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CACpC"}

package/lib/esm/appui-react/ui-items-provider/UiItemsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG","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 UiProvider\n */\n\nimport type { BackstageItem } from \"../backstage/BackstageItem\";\nimport type { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\nimport type { StagePanelSection } from \"../stagepanels/StagePanelSection\";\nimport type { StatusBarItem } from \"../statusbar/StatusBarItem\";\nimport type {\n  ToolbarItem,\n  ToolbarOrientation,\n  ToolbarUsage,\n} from \"../toolbar/ToolbarItem\";\nimport type { Widget } from \"../widgets/Widget\";\n\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\n * @public\n */\nexport interface UiItemsProvider {\n  /** Id of provider. */\n  readonly id: string;\n\n  /** Provides toolbar items. */\n  readonly provideToolbarItems?: (\n    stageId: string,\n    stageUsage: string,\n    toolbarUsage: ToolbarUsage,\n    toolbarOrientation: ToolbarOrientation\n  ) => ReadonlyArray<ToolbarItem>;\n  /** Provides status bar items. */\n  readonly provideStatusBarItems?: (\n    stageId: string,\n    stageUsage: string\n  ) => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items. */\n  readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets. */\n  readonly provideWidgets?: (\n    stageId: string,\n    stageUsage: string,\n    location: StagePanelLocation,\n    section?: StagePanelSection\n  ) => ReadonlyArray<Widget>;\n  /** Function called when the provider is unregistered. Allows provider to do a cleanup. */\n  readonly onUnregister?: () => void;\n}\n"]}
+{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG","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 UiProvider\n */\n\nimport type { BackstageItem } from \"../backstage/BackstageItem\";\nimport type { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\nimport type { StagePanelSection } from \"../stagepanels/StagePanelSection\";\nimport type { StatusBarItem } from \"../statusbar/StatusBarItem\";\nimport type {\n  ToolbarItem,\n  ToolbarOrientation,\n  ToolbarUsage,\n} from \"../toolbar/ToolbarItem\";\nimport type { Widget } from \"../widgets/Widget\";\n\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\n * @public\n */\nexport interface UiItemsProvider {\n  /** Id of provider. */\n  readonly id: string;\n\n  /** Provides toolbar items.\n   * @note Use [[ToolbarItem.layouts]] to map item to location previously specified by `provideToolbarItems` arguments.\n   * @alpha\n   */\n  readonly getToolbarItems?: () => ReadonlyArray<ToolbarItem>;\n  /** Provides status bar items.\n   * @alpha\n   */\n  readonly getStatusBarItems?: () => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items.\n   * @alpha\n   */\n  readonly getBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets.\n   * @note Use [[Widget.layouts]] to map item to location previously specified by `provideWidgets` arguments.\n   * @alpha\n   */\n  readonly getWidgets?: () => ReadonlyArray<Widget>;\n\n  /** Provides toolbar items.\n   * @note Use [[UiItemsProvider.getToolbarItems]] instead. To map item to location previously specified by arguments use [[ToolbarItem.layouts]].\n   */\n  readonly provideToolbarItems?: (\n    stageId: string,\n    stageUsage: string,\n    toolbarUsage: ToolbarUsage,\n    toolbarOrientation: ToolbarOrientation\n  ) => ReadonlyArray<ToolbarItem>;\n  /** Provides status bar items.\n   * @note Use [[UiItemsProvider.getStatusBarItems]] instead.\n   */\n  readonly provideStatusBarItems?: (\n    stageId: string,\n    stageUsage: string\n  ) => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items.\n   * @note Use [[UiItemsProvider.getBackstageItems]] instead.\n   */\n  readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets.\n   * @note Use [[UiItemsProvider.getWidgets]] instead. To map item to location previously specified by arguments use [[Widget.layouts]].\n   */\n  readonly provideWidgets?: (\n    stageId: string,\n    stageUsage: string,\n    location: StagePanelLocation,\n    section?: StagePanelSection\n  ) => ReadonlyArray<Widget>;\n  /** Function called when the provider is unregistered. Allows provider to do a cleanup. */\n  readonly onUnregister?: () => void;\n}\n"]}

package/lib/esm/appui-react/uiadmin/FrameworkUiAdmin.d.ts

@@ -3,8 +3,9 @@
  */
 import * as React from "react";
 import type { XAndY } from "@itwin/core-geometry";
-import type { AbstractMenuItemProps, AbstractToolbarProps, DialogLayoutDataProvider, DialogProps, IMatch, OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc, Primitives, PropertyDescription, PropertyRecord } from "@itwin/appui-abstract";
+import type { AbstractMenuItemProps, AbstractToolbarProps, DialogLayoutDataProvider, DialogProps, OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc, Primitives, PropertyDescription, PropertyRecord } from "@itwin/appui-abstract";
 import { RelativePosition, UiAdmin } from "@itwin/appui-abstract";
+import type { IMatch } from "../utils/matchesWords";
 /** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
  * @public
  */
@@ -27,7 +28,15 @@ export interface KeyinEntry {
     /** true if entry was loaded from key-in history */
     isHistory?: boolean;
 }
-/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
+/** Subclass of `UiAdmin` in `@itwin/core-frontend` to be used to initialize `IModelApp`.
+ *
+ * This implementation uses themed react components that blends in AppUI look and feel.
+ *
+ * ```ts
+ * await IModelApp.startup({
+ *   uiAdmin: new FrameworkUiAdmin()
+ * });
+ * ```
  * @public
  */
 export declare class FrameworkUiAdmin extends UiAdmin {

package/lib/esm/appui-react/uiadmin/FrameworkUiAdmin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkUiAdmin.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uiadmin/FrameworkUiAdmin.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,EACxB,WAAW,EACX,MAAM,EACN,YAAY,EACZ,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQlE;;GAEG;AACH,oBAAY,sBAAsB;IAChC,iDAAiD;IACjD,YAAY,IAAA;IACZ,6CAA6C;IAC7C,SAAS,IAAA;IACT,mEAAmE;IACnE,IAAI,IAAA;CACL;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,OAAO;IAC3C,OAAO,CAAC,yBAAyB,CACK;IAEtC,IAAW,wBAAwB,IAAI,sBAAsB,CAE5D;IACD,IAAW,wBAAwB,CAAC,UAAU,EAAE,sBAAsB,EAErE;IAED,gBAAgB;IACA,aAAa;IAE7B,wFAAwF;IACxF,IAAoB,cAAc,IAAI,KAAK,CAE1C;IAED,yCAAyC;IACzC,IAAoB,aAAa,IAAI,OAAO,CAE3C;IAED,yBAAyB;IACT,cAAc,IAAI,IAAI;IAItC;;;;;OAKG;IACa,eAAe,CAC7B,KAAK,EAAE,qBAAqB,EAAE,EAC9B,QAAQ,EAAE,KAAK,EACf,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAuBV,0CAA0C;IAC1C,OAAO,CAAC,kBAAkB;IASnB,SAAS,IAAI,UAAU,EAAE;IA8BhC;;;OAGG;IACa,gBAAgB,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAqBpE,gCAAgC;IAChB,gBAAgB,IAAI,OAAO;IAM3C;;;;;;;;;OASG;IACa,WAAW,CACzB,YAAY,EAAE,oBAAoB,EAClC,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,cAAc,EAAE,kBAAkB,EAClC,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAiBV,yBAAyB;IACT,WAAW,IAAI,OAAO;IAItC;;;;;;OAMG;IACa,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,qBAAqB,EAAE,EACvC,QAAQ,EAAE,KAAK,EACf,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAWV;;;OAGG;IACa,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAInD;;;;;;;;OAQG;IACa,cAAc,CAC5B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,KAAK,EACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAaV,4BAA4B;IACZ,cAAc,IAAI,OAAO;IAIzC;;;;;;;OAOG;IACa,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAYV;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAYV;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAYV;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAAY,EAAE,UAAU,CAAC,KAAK,EAC9B,mBAAmB,EAAE,mBAAmB,EACxC,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAaV,8BAA8B;IACd,eAAe,IAAI,OAAO;IAI1C;;;;;;;;OAQG;IACa,eAAe,CAC7B,cAAc,EAAE,WAAW,EAC3B,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAiBV,8BAA8B;IACd,eAAe,IAAI,OAAO;IAI1C;;;;;;;;;;;OAWG;IACa,QAAQ,CACtB,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,EAC1C,YAAY,EAAE,oBAAoB,GAAG,SAAS,EAC9C,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,cAAc,EAAE,kBAAkB,EAClC,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAoBV;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAO,EAAE,KAAK,CAAC,SAAS,EACxB,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,EAC1C,YAAY,EAAE,oBAAoB,GAAG,SAAS,EAC9C,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,cAAc,EAAE,kBAAkB,EAClC,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAqBV,sBAAsB;IACN,QAAQ,IAAI,OAAO;IAInC;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAY,EAAE,wBAAwB,EACtC,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAgBV,yCAAyC;IACzB,sBAAsB,IAAI,OAAO;IAIjD;;;;;;;OAOG;IACa,UAAU,CACxB,cAAc,EAAE,wBAAwB,EACxC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,MAAM,EACV,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IA4BV,yCAAyC;IACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAwBvD"}
+{"version":3,"file":"FrameworkUiAdmin.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uiadmin/FrameworkUiAdmin.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,EACxB,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIlE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAKpD;;GAEG;AACH,oBAAY,sBAAsB;IAChC,iDAAiD;IACjD,YAAY,IAAA;IACZ,6CAA6C;IAC7C,SAAS,IAAA;IACT,mEAAmE;IACnE,IAAI,IAAA;CACL;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,gBAAiB,SAAQ,OAAO;IAC3C,OAAO,CAAC,yBAAyB,CACK;IAEtC,IAAW,wBAAwB,IAAI,sBAAsB,CAE5D;IACD,IAAW,wBAAwB,CAAC,UAAU,EAAE,sBAAsB,EAErE;IAED,gBAAgB;IACA,aAAa;IAE7B,wFAAwF;IACxF,IAAoB,cAAc,IAAI,KAAK,CAE1C;IAED,yCAAyC;IACzC,IAAoB,aAAa,IAAI,OAAO,CAE3C;IAED,yBAAyB;IACT,cAAc,IAAI,IAAI;IAItC;;;;;OAKG;IACa,eAAe,CAC7B,KAAK,EAAE,qBAAqB,EAAE,EAC9B,QAAQ,EAAE,KAAK,EACf,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAuBV,0CAA0C;IAC1C,OAAO,CAAC,kBAAkB;IASnB,SAAS,IAAI,UAAU,EAAE;IA8BhC;;;OAGG;IACa,gBAAgB,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAqBpE,gCAAgC;IAChB,gBAAgB,IAAI,OAAO;IAM3C;;;;;;;;;OASG;IACa,WAAW,CACzB,YAAY,EAAE,oBAAoB,EAClC,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,cAAc,EAAE,kBAAkB,EAClC,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAiBV,yBAAyB;IACT,WAAW,IAAI,OAAO;IAItC;;;;;;OAMG;IACa,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,qBAAqB,EAAE,EACvC,QAAQ,EAAE,KAAK,EACf,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAWV;;;OAGG;IACa,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAInD;;;;;;;;OAQG;IACa,cAAc,CAC5B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,KAAK,EACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAaV,4BAA4B;IACZ,cAAc,IAAI,OAAO;IAIzC;;;;;;;OAOG;IACa,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAYV;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAYV;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,kBAAkB,EAC5B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAYV;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAAY,EAAE,UAAU,CAAC,KAAK,EAC9B,mBAAmB,EAAE,mBAAmB,EACxC,QAAQ,EAAE,KAAK,EACf,QAAQ,EAAE,iBAAiB,EAC3B,QAAQ,EAAE,YAAY,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,OAAO;IAaV,8BAA8B;IACd,eAAe,IAAI,OAAO;IAI1C;;;;;;;;OAQG;IACa,eAAe,CAC7B,cAAc,EAAE,WAAW,EAC3B,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAiBV,8BAA8B;IACd,eAAe,IAAI,OAAO;IAI1C;;;;;;;;;;;OAWG;IACa,QAAQ,CACtB,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,EAC1C,YAAY,EAAE,oBAAoB,GAAG,SAAS,EAC9C,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,cAAc,EAAE,kBAAkB,EAClC,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAoBV;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAO,EAAE,KAAK,CAAC,SAAS,EACxB,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,EAC1C,YAAY,EAAE,oBAAoB,GAAG,SAAS,EAC9C,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,cAAc,EAAE,kBAAkB,EAClC,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAqBV,sBAAsB;IACN,QAAQ,IAAI,OAAO;IAInC;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAY,EAAE,wBAAwB,EACtC,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,YAAY,EACtB,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IAgBV,yCAAyC;IACzB,sBAAsB,IAAI,OAAO;IAIjD;;;;;;;OAOG;IACa,UAAU,CACxB,cAAc,EAAE,wBAAwB,EACxC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,MAAM,EACV,aAAa,CAAC,EAAE,WAAW,GAC1B,OAAO;IA4BV,yCAAyC;IACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAwBvD"}

package/lib/esm/appui-react/uiadmin/FrameworkUiAdmin.js

@@ -25,7 +25,15 @@ export var KeyinFieldLocalization;
     /** Include localized and non-localized strings for each key-in. */
     KeyinFieldLocalization[KeyinFieldLocalization["Both"] = 2] = "Both";
 })(KeyinFieldLocalization || (KeyinFieldLocalization = {}));
-/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
+/** Subclass of `UiAdmin` in `@itwin/core-frontend` to be used to initialize `IModelApp`.
+ *
+ * This implementation uses themed react components that blends in AppUI look and feel.
+ *
+ * ```ts
+ * await IModelApp.startup({
+ *   uiAdmin: new FrameworkUiAdmin()
+ * });
+ * ```
  * @public
  */
 export class FrameworkUiAdmin extends UiAdmin {

package/lib/esm/appui-react/uiadmin/FrameworkUiAdmin.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkUiAdmin.js","sourceRoot":"","sources":["../../../../src/appui-react/uiadmin/FrameworkUiAdmin.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAejD,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,iDAAiD;IACjD,mFAAY,CAAA;IACZ,6CAA6C;IAC7C,6EAAS,CAAA;IACT,mEAAmE;IACnE,mEAAI,CAAA;AACN,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC;AAcD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAA7C;;QACU,8BAAyB,GAC/B,sBAAsB,CAAC,YAAY,CAAC;IAqkBxC,CAAC;IAnkBC,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IACD,IAAW,wBAAwB,CAAC,UAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACA,aAAa,KAAI,CAAC;IAElC,wFAAwF;IACxF,IAAoB,cAAc;QAChC,OAAO,iBAAiB,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED,yCAAyC;IACzC,IAAoB,aAAa;QAC/B,OAAO,WAAW,CAAC,iBAAiB,CAAC,aAAa,CAAC;IACrD,CAAC;IAED,yBAAyB;IACT,cAAc;QAC5B,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACa,eAAe,CAC7B,KAA8B,EAC9B,QAAe,EACf,WAAyB;QAEzB,IAAI,QAAQ,GAAG,QAAQ,CAAC;QACxB,IAAI,aAAiC,CAAC;QACtC,IAAI,WAAW,EAAE;YACf,MAAM,YAAY,GAAG,WAAW,CAAC,qBAAqB,EAAE,CAAC;YACzD,QAAQ,GAAG;gBACT,CAAC,EAAE,YAAY,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;gBACjC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;aACjC,CAAC;YACF,aAAa,GAAG,WAAW,CAAC,YAAY,CAAC,MAAM,CAC7C,WAAW,CAAC,aAAa,CAAC,WAAW,CACtC,CAAC;SACH;QAED,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC;QAClB,QAAQ,GAAG,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC;QAE9D,MAAM,UAAU,GAAmB,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;QACtE,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0CAA0C;IAClC,kBAAkB,CACxB,QAAe,EACf,WAAyB;QAEzB,MAAM,QAAQ,GAAG,QAAQ,CAAC;QAC1B,MAAM,EAAE,GAAG,WAAW,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QACnE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAC1B,CAAC;IAEM,SAAS;QACd,MAAM,UAAU,GAAiB,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,QAAQ,IAAI,CAAC,wBAAwB,EAAE;gBACrC,KAAK,sBAAsB,CAAC,SAAS;oBACnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBACvC,MAAM;gBACR,KAAK,sBAAsB,CAAC,IAAI;oBAC9B,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBACvC,uBAAuB;oBACvB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,YAAY;wBAAE,MAAM;gBAC9C,uBAAuB;gBACvB,QAAQ,CAAC,qCAAqC;gBAC9C,KAAK,sBAAsB,CAAC,YAAY;oBACtC,uBAAuB;oBACvB,IACE,sBAAsB,CAAC,YAAY;wBACjC,IAAI,CAAC,wBAAwB;wBAC/B,CAAC,sBAAsB,CAAC,IAAI,KAAK,IAAI,CAAC,wBAAwB;4BAC5D,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC;wBAEnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;oBAChD,MAAM;aACT;SACF;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACa,gBAAgB,CAAC,WAAyB;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,uBAAuB;QACvB,MAAM,EAAE,GAAG,WAAW;YACpB,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAE7C,uBAAuB;QACvB,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,OAAO,YAAY,CAAC,gBAAgB,CAClC,IAAI,CAAC,SAAS,EAAE,EAChB,EAAE,EACF,SAAS,EACT,SAAS,CACV,CAAC;IACJ,CAAC;IAED,gCAAgC;IAChB,gBAAgB;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,OAAO,YAAY,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC;IAED;;;;;;;;;OASG;IACa,WAAW,CACzB,YAAkC,EAClC,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,WAAW,CAC7B,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,yBAAyB;IACT,WAAW;QACzB,OAAO,YAAY,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACa,cAAc,CAC5B,EAAU,EACV,cAAuC,EACvC,QAAe,EACf,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,cAAc,CACxC,EAAE,EACF,EAAE,EACF,QAAQ,EACR,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;OAGG;IACa,cAAc,CAAC,EAAU;QACvC,OAAO,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACa,cAAc,CAC5B,YAAoB,EACpB,UAAkB,EAClB,QAAe,EACf,IAAwB,EACxB,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,cAAc,CACxC,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,4BAA4B;IACZ,cAAc;QAC5B,OAAO,oBAAoB,CAAC,cAAc,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACa,eAAe,CAC7B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,eAAe,CACzC,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,gBAAgB,CAC1C,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,gBAAgB,CAC1C,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAA8B,EAC9B,mBAAwC,EACxC,QAAe,EACf,QAA2B,EAC3B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,YAAY,CAAC,eAAe,CACjC,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,8BAA8B;IACd,eAAe;QAC7B,OAAO,YAAY,CAAC,eAAe,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,cAA2B,EAC3B,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE1E,qBAAqB;QACrB,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,eAAe,CACjC,cAAc,EACd,EAAE,EACF,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,8BAA8B;IACd,eAAe;QAC7B,OAAO,YAAY,CAAC,eAAe,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;OAWG;IACa,QAAQ,CACtB,OAAoB,EACpB,KAA0C,EAC1C,YAA8C,EAC9C,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE1E,qBAAqB;QACrB,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,QAAQ,CAC1B,OAAO,EACP,KAAK,EACL,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAwB,EACxB,KAA0C,EAC1C,YAA8C,EAC9C,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAC1E,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QAE5C,qBAAqB;QACrB,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,QAAQ,CAC1B,YAAY,EACZ,KAAK,EACL,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,sBAAsB;IACN,QAAQ;QACtB,OAAO,YAAY,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAsC,EACtC,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE1E,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,gBAAgB,CAClC,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzB,sBAAsB;QACpC,OAAO,YAAY,CAAC,iBAAiB,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACa,UAAU,CACxB,cAAwC,EACxC,KAAa,EACb,OAAgB,EAChB,EAAU,EACV,aAA2B;QAE3B,IAAI,OAAO,EAAE;YACX,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAC5B,oBAAC,oBAAoB,IACnB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,EAAE,KACF,aAAa,GACjB,EACF,EAAE,CACH,CAAC;YACF,OAAO,IAAI,CAAC;SACb;aAAM;YACL,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAC/B,oBAAC,oBAAoB,IACnB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,EAAE,KACF,aAAa,GACjB,EACF,EAAE,CACH,CAAC;YACF,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED,yCAAyC;IACzB,WAAW,CAAC,QAAgB;QAC1C,uBAAuB;QACvB,IACE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAC5C,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ,CAC/B,EACD;YACA,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;SACb;QAED,uBAAuB;QACvB,IACE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CACzC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ,CAC/B,EACD;YACA,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;SACb;QAED,uBAAuB;QACvB,OAAO,KAAK,CAAC;IACf,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 Admin\n */\n\nimport * as React from \"react\";\nimport type { XAndY } from \"@itwin/core-geometry\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport type {\n  AbstractMenuItemProps,\n  AbstractToolbarProps,\n  DialogLayoutDataProvider,\n  DialogProps,\n  IMatch,\n  OnCancelFunc,\n  OnItemExecutedFunc,\n  OnNumberCommitFunc,\n  OnValueCommitFunc,\n  Primitives,\n  PropertyDescription,\n  PropertyRecord,\n} from \"@itwin/appui-abstract\";\nimport { RelativePosition, UiAdmin } from \"@itwin/appui-abstract\";\nimport { AccuDrawPopupManager } from \"../accudraw/AccuDrawPopupManager\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport { PopupManager } from \"../popup/PopupManager\";\nimport type { CursorMenuData } from \"../redux/SessionState\";\nimport { UiFramework } from \"../UiFramework\";\nimport { UiDataProvidedDialog } from \"../dialog/UiDataProvidedDialog\";\n\n/** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.\n * @public\n */\nexport enum KeyinFieldLocalization {\n  /** Include only non-localized key-in strings. */\n  NonLocalized,\n  /** Include only localized key-in strings. */\n  Localized,\n  /** Include localized and non-localized strings for each key-in. */\n  Both,\n}\n\n/** Defines a keyin entry to show/filter in UI\n * @public\n */\nexport interface KeyinEntry {\n  /** string that matched a filter string */\n  value: string;\n  /** define array of start and end positions of filter matches. */\n  matches?: IMatch[];\n  /** true if entry was loaded from key-in history */\n  isHistory?: boolean;\n}\n\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\n * @public\n */\nexport class FrameworkUiAdmin extends UiAdmin {\n  private _localizedKeyinPreference: KeyinFieldLocalization =\n    KeyinFieldLocalization.NonLocalized;\n\n  public get localizedKeyinPreference(): KeyinFieldLocalization {\n    return this._localizedKeyinPreference;\n  }\n  public set localizedKeyinPreference(preference: KeyinFieldLocalization) {\n    this._localizedKeyinPreference = preference;\n  }\n\n  /** @internal */\n  public override onInitialized() {}\n\n  /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY. */\n  public override get cursorPosition(): XAndY {\n    return CursorInformation.cursorPosition;\n  }\n\n  /** Determines if focus is set to Home */\n  public override get isFocusOnHome(): boolean {\n    return UiFramework.keyboardShortcuts.isFocusOnHome;\n  }\n\n  /** Sets focus to Home */\n  public override setFocusToHome(): void {\n    UiFramework.keyboardShortcuts.setFocusToHome();\n  }\n\n  /** Show a context menu at a particular location.\n   * @param items Properties of the menu items to display.\n   * @param location Location of the context menu, relative to the origin of htmlElement or the overall window.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public override showContextMenu(\n    items: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    let position = location;\n    let childWindowId: string | undefined;\n    if (htmlElement) {\n      const anchorOffset = htmlElement.getBoundingClientRect();\n      position = {\n        x: anchorOffset.left + location.x,\n        y: anchorOffset.top + location.y,\n      };\n      childWindowId = UiFramework.childWindows.findId(\n        htmlElement.ownerDocument.defaultView\n      );\n    }\n\n    const offset = -8;\n    position = { x: position.x + offset, y: position.y + offset };\n\n    const cursorMenu: CursorMenuData = { position, items, childWindowId };\n    UiFramework.openCursorMenu(cursorMenu);\n\n    return true;\n  }\n\n  /** Resolve location and parent element */\n  private resolveHtmlElement(\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): { position: XAndY; el: HTMLElement } {\n    const position = location;\n    const el = htmlElement ?? UiFramework.controls.getWrapperElement();\n    return { position, el };\n  }\n\n  public getKeyins(): KeyinEntry[] {\n    const toolKeyins: KeyinEntry[] = [];\n    const tools = IModelApp.tools.getToolList();\n    for (const tool of tools) {\n      switch (this.localizedKeyinPreference) {\n        case KeyinFieldLocalization.Localized:\n          toolKeyins.push({ value: tool.keyin });\n          break;\n        case KeyinFieldLocalization.Both:\n          toolKeyins.push({ value: tool.keyin });\n          // istanbul ignore else\n          if (tool.keyin === tool.englishKeyin) break;\n        // istanbul ignore next\n        default: // eslint-disable-line no-fallthrough\n        case KeyinFieldLocalization.NonLocalized:\n          // istanbul ignore next\n          if (\n            KeyinFieldLocalization.NonLocalized ===\n              this.localizedKeyinPreference ||\n            (KeyinFieldLocalization.Both === this.localizedKeyinPreference &&\n              tool.englishKeyin !== tool.keyin)\n          )\n            toolKeyins.push({ value: tool.englishKeyin });\n          break;\n      }\n    }\n\n    return toolKeyins;\n  }\n\n  /** Show the Key-in Palette to display key-in from all registered Tools.\n   * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.\n   * @return true if the Command Palette was displayed, false if it could not be displayed.\n   */\n  public override showKeyinPalette(htmlElement?: HTMLElement): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    // istanbul ignore next\n    const el = htmlElement\n      ? htmlElement\n      : UiFramework.controls.getWrapperElement();\n\n    // istanbul ignore next\n    const hidePopup = () => {\n      IModelApp.uiAdmin.hideKeyinPalette();\n    };\n\n    return PopupManager.showKeyinPalette(\n      this.getKeyins(),\n      el,\n      hidePopup,\n      hidePopup\n    );\n  }\n\n  /** Hides the Key-in Palette. */\n  public override hideKeyinPalette(): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    return PopupManager.hideKeyinPalette();\n  }\n\n  /** Show a Toolbar at a particular location.\n   * @param toolbarProps Properties of the Toolbar to display.\n   * @param location Location of the Toolbar, relative to the origin of htmlElement or the overall window.\n   * @param offset Offset of the Toolbar from the location.\n   * @param onItemExecuted Function invoked after a Toolbar item is executed\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\n   * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\n   */\n  public override showToolbar(\n    toolbarProps: AbstractToolbarProps,\n    location: XAndY,\n    offset: XAndY,\n    onItemExecuted: OnItemExecutedFunc,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showToolbar(\n      toolbarProps,\n      el,\n      position,\n      offset,\n      onItemExecuted,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Hides the toolbar. */\n  public override hideToolbar(): boolean {\n    return PopupManager.hideToolbar();\n  }\n\n  /** Show a menu button at a particular location. A menu button opens a context menu.\n   * @param id Id of the menu button. Multiple menu buttons may be displayed.\n   * @param menuItemsProps Properties of the menu items to display.\n   * @param location Location of the context menu, relative to the origin of htmlElement or the window.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public override showMenuButton(\n    id: string,\n    menuItemsProps: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showMenuButton(\n      id,\n      el,\n      position,\n      menuItemsProps\n    );\n  }\n\n  /** Hides a menu button.\n   * @param id Id of the menu button. Multiple menu buttons may be displayed.\n   * @return true if the menu was hidden, false if the menu could not be hidden.\n   */\n  public override hideMenuButton(id: string): boolean {\n    return AccuDrawPopupManager.hideMenuButton(id);\n  }\n\n  /** Show a calculator at a particular location.\n   * @param initialValue Value initially displayed in the calculator.\n   * @param resultIcon Icon displayed to the left of the value.\n   * @param location Location of the calculator, relative to the origin of htmlElement or the window.\n   * @param onOk Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public override showCalculator(\n    initialValue: number,\n    resultIcon: string,\n    location: XAndY,\n    onOk: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showCalculator(\n      el,\n      position,\n      initialValue,\n      resultIcon,\n      onOk,\n      onCancel\n    );\n  }\n\n  /** Hides the calculator. */\n  public override hideCalculator(): boolean {\n    return AccuDrawPopupManager.hideCalculator();\n  }\n\n  /** Show an input editor for an angle value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showAngleEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showAngleEditor(\n      el,\n      position,\n      initialValue,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Show an input editor for a length value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showLengthEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showLengthEditor(\n      el,\n      position,\n      initialValue,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Show an input editor for a height value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showHeightEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showHeightEditor(\n      el,\n      position,\n      initialValue,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Show an input editor for a primitive value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param propertyDescription Description of the primitive value property\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showInputEditor(\n    initialValue: Primitives.Value,\n    propertyDescription: PropertyDescription,\n    location: XAndY,\n    onCommit: OnValueCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return PopupManager.showInputEditor(\n      el,\n      position,\n      initialValue,\n      propertyDescription,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Hides the input editor. */\n  public override hideInputEditor(): boolean {\n    return PopupManager.hideInputEditor();\n  }\n\n  /** Show an HTML element at a particular location.\n   * @param displayElement The HTMLElement to display\n   * @param location Location of the display element, relative to the origin of htmlElement or the window\n   * @param offset Offset of the display element from the location\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\n   * @return true if the display element was displayed, false if the display element could not be displayed.\n   */\n  public override showHTMLElement(\n    displayElement: HTMLElement,\n    location: XAndY,\n    offset: XAndY,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n\n    // istanbul ignore if\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showHTMLElement(\n      displayElement,\n      el,\n      position,\n      offset,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Hides the HTML Element. */\n  public override hideHTMLElement(): boolean {\n    return PopupManager.hideHTMLElement();\n  }\n\n  /** Show a Card containing content, a title and a toolbar at a particular location.\n   * @param content The HTMLElement of the content to display\n   * @param title Title to display at the top of the card.\n   * @param toolbarProps Properties of the Toolbar to display.\n   * @param location Location of the Card, relative to the origin of htmlElement or the window.\n   * @param offset Offset of the Card from the location.\n   * @param onItemExecuted Function invoked after a Toolbar item is executed\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n   * @return true if the Card was displayed, false if the Card could not be displayed.\n   */\n  public override showCard(\n    content: HTMLElement,\n    title: string | PropertyRecord | undefined,\n    toolbarProps: AbstractToolbarProps | undefined,\n    location: XAndY,\n    offset: XAndY,\n    onItemExecuted: OnItemExecutedFunc,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n\n    // istanbul ignore if\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showCard(\n      content,\n      title,\n      toolbarProps,\n      el,\n      position,\n      offset,\n      onItemExecuted,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Show a Card containing React-based content, a title and a toolbar at a particular location.\n   * @param content The React node of the content to display\n   * @param title Title to display at the top of the card.\n   * @param toolbarProps Properties of the Toolbar to display.\n   * @param location Location of the Card, relative to the origin of htmlElement or the window.\n   * @param offset Offset of the Card from the location.\n   * @param onItemExecuted Function invoked after a Toolbar item is executed\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n   * @return true if the Card was displayed, false if the Card could not be displayed.\n   */\n  public showReactCard(\n    content: React.ReactNode,\n    title: string | PropertyRecord | undefined,\n    toolbarProps: AbstractToolbarProps | undefined,\n    location: XAndY,\n    offset: XAndY,\n    onItemExecuted: OnItemExecutedFunc,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n    const reactContent = { reactNode: content };\n\n    // istanbul ignore if\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showCard(\n      reactContent,\n      title,\n      toolbarProps,\n      el,\n      position,\n      offset,\n      onItemExecuted,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Hides the Card. */\n  public override hideCard(): boolean {\n    return PopupManager.hideCard();\n  }\n\n  /** Opens a Tool Settings Ui popup at a particular location.\n   * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.\n   * @param location Location of the tool settings, relative to the origin of anchorElement or the window\n   * @param offset Offset of the tool settings from the location\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n   */\n  public override openToolSettingsPopup(\n    dataProvider: DialogLayoutDataProvider,\n    location: XAndY,\n    offset: XAndY,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.openToolSettings(\n      dataProvider,\n      el,\n      position,\n      offset,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public override closeToolSettingsPopup(): boolean {\n    return PopupManager.closeToolSettings();\n  }\n\n  /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\n   * @param uiDataProvider The UiDataProvider for the tool settings\n   * @param title Specify title for dialog.\n   * @param isModal Specify if the dialog is opened as a modal or modeless.\n   * @param id Id of the dialog that is used to close it.\n   * @param optionalProps Optional props for Dialog construction.\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n   */\n  public override openDialog(\n    uiDataProvider: DialogLayoutDataProvider,\n    title: string,\n    isModal: boolean,\n    id: string,\n    optionalProps?: DialogProps\n  ): boolean {\n    if (isModal) {\n      UiFramework.dialogs.modal.open(\n        <UiDataProvidedDialog\n          uiDataProvider={uiDataProvider}\n          title={title}\n          isModal={isModal}\n          id={id}\n          {...optionalProps}\n        />,\n        id\n      );\n      return true;\n    } else {\n      UiFramework.dialogs.modeless.open(\n        <UiDataProvidedDialog\n          uiDataProvider={uiDataProvider}\n          title={title}\n          isModal={isModal}\n          id={id}\n          {...optionalProps}\n        />,\n        id\n      );\n      return true;\n    }\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public override closeDialog(dialogId: string): boolean {\n    // istanbul ignore else\n    if (\n      UiFramework.dialogs.modeless.dialogs.findIndex(\n        (info) => info.id === dialogId\n      )\n    ) {\n      UiFramework.dialogs.modeless.close(dialogId);\n      return true;\n    }\n\n    // istanbul ignore else\n    if (\n      UiFramework.dialogs.modal.dialogs.findIndex(\n        (info) => info.id === dialogId\n      )\n    ) {\n      UiFramework.dialogs.modal.close();\n      return true;\n    }\n\n    // istanbul ignore next\n    return false;\n  }\n}\n"]}
+{"version":3,"file":"FrameworkUiAdmin.js","sourceRoot":"","sources":["../../../../src/appui-react/uiadmin/FrameworkUiAdmin.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAcjD,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,iDAAiD;IACjD,mFAAY,CAAA;IACZ,6CAA6C;IAC7C,6EAAS,CAAA;IACT,mEAAmE;IACnE,mEAAI,CAAA;AACN,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC;AAcD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAA7C;;QACU,8BAAyB,GAC/B,sBAAsB,CAAC,YAAY,CAAC;IAqkBxC,CAAC;IAnkBC,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IACD,IAAW,wBAAwB,CAAC,UAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACA,aAAa,KAAI,CAAC;IAElC,wFAAwF;IACxF,IAAoB,cAAc;QAChC,OAAO,iBAAiB,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED,yCAAyC;IACzC,IAAoB,aAAa;QAC/B,OAAO,WAAW,CAAC,iBAAiB,CAAC,aAAa,CAAC;IACrD,CAAC;IAED,yBAAyB;IACT,cAAc;QAC5B,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACa,eAAe,CAC7B,KAA8B,EAC9B,QAAe,EACf,WAAyB;QAEzB,IAAI,QAAQ,GAAG,QAAQ,CAAC;QACxB,IAAI,aAAiC,CAAC;QACtC,IAAI,WAAW,EAAE;YACf,MAAM,YAAY,GAAG,WAAW,CAAC,qBAAqB,EAAE,CAAC;YACzD,QAAQ,GAAG;gBACT,CAAC,EAAE,YAAY,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;gBACjC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;aACjC,CAAC;YACF,aAAa,GAAG,WAAW,CAAC,YAAY,CAAC,MAAM,CAC7C,WAAW,CAAC,aAAa,CAAC,WAAW,CACtC,CAAC;SACH;QAED,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC;QAClB,QAAQ,GAAG,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC;QAE9D,MAAM,UAAU,GAAmB,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;QACtE,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0CAA0C;IAClC,kBAAkB,CACxB,QAAe,EACf,WAAyB;QAEzB,MAAM,QAAQ,GAAG,QAAQ,CAAC;QAC1B,MAAM,EAAE,GAAG,WAAW,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QACnE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAC1B,CAAC;IAEM,SAAS;QACd,MAAM,UAAU,GAAiB,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,QAAQ,IAAI,CAAC,wBAAwB,EAAE;gBACrC,KAAK,sBAAsB,CAAC,SAAS;oBACnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBACvC,MAAM;gBACR,KAAK,sBAAsB,CAAC,IAAI;oBAC9B,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBACvC,uBAAuB;oBACvB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,YAAY;wBAAE,MAAM;gBAC9C,uBAAuB;gBACvB,QAAQ,CAAC,qCAAqC;gBAC9C,KAAK,sBAAsB,CAAC,YAAY;oBACtC,uBAAuB;oBACvB,IACE,sBAAsB,CAAC,YAAY;wBACjC,IAAI,CAAC,wBAAwB;wBAC/B,CAAC,sBAAsB,CAAC,IAAI,KAAK,IAAI,CAAC,wBAAwB;4BAC5D,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC;wBAEnC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;oBAChD,MAAM;aACT;SACF;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACa,gBAAgB,CAAC,WAAyB;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,uBAAuB;QACvB,MAAM,EAAE,GAAG,WAAW;YACpB,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAE7C,uBAAuB;QACvB,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,SAAS,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACvC,CAAC,CAAC;QAEF,OAAO,YAAY,CAAC,gBAAgB,CAClC,IAAI,CAAC,SAAS,EAAE,EAChB,EAAE,EACF,SAAS,EACT,SAAS,CACV,CAAC;IACJ,CAAC;IAED,gCAAgC;IAChB,gBAAgB;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,OAAO,YAAY,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC;IAED;;;;;;;;;OASG;IACa,WAAW,CACzB,YAAkC,EAClC,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,WAAW,CAC7B,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,yBAAyB;IACT,WAAW;QACzB,OAAO,YAAY,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACa,cAAc,CAC5B,EAAU,EACV,cAAuC,EACvC,QAAe,EACf,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,cAAc,CACxC,EAAE,EACF,EAAE,EACF,QAAQ,EACR,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;OAGG;IACa,cAAc,CAAC,EAAU;QACvC,OAAO,oBAAoB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;OAQG;IACa,cAAc,CAC5B,YAAoB,EACpB,UAAkB,EAClB,QAAe,EACf,IAAwB,EACxB,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,cAAc,CACxC,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,4BAA4B;IACZ,cAAc;QAC5B,OAAO,oBAAoB,CAAC,cAAc,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACa,eAAe,CAC7B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,eAAe,CACzC,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,gBAAgB,CAC1C,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,oBAAoB,CAAC,gBAAgB,CAC1C,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAA8B,EAC9B,mBAAwC,EACxC,QAAe,EACf,QAA2B,EAC3B,QAAsB,EACtB,WAAyB;QAEzB,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAExE,OAAO,YAAY,CAAC,eAAe,CACjC,EAAE,EACF,QAAQ,EACR,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,8BAA8B;IACd,eAAe;QAC7B,OAAO,YAAY,CAAC,eAAe,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,cAA2B,EAC3B,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE1E,qBAAqB;QACrB,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,eAAe,CACjC,cAAc,EACd,EAAE,EACF,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,8BAA8B;IACd,eAAe;QAC7B,OAAO,YAAY,CAAC,eAAe,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;OAWG;IACa,QAAQ,CACtB,OAAoB,EACpB,KAA0C,EAC1C,YAA8C,EAC9C,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE1E,qBAAqB;QACrB,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,QAAQ,CAC1B,OAAO,EACP,KAAK,EACL,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAwB,EACxB,KAA0C,EAC1C,YAA8C,EAC9C,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAC1E,MAAM,YAAY,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QAE5C,qBAAqB;QACrB,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,QAAQ,CAC1B,YAAY,EACZ,KAAK,EACL,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,sBAAsB;IACN,QAAQ;QACtB,OAAO,YAAY,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAsC,EACtC,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAE1E,IAAI,gBAAgB,KAAK,SAAS;YAChC,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,OAAO,YAAY,CAAC,gBAAgB,CAClC,YAAY,EACZ,EAAE,EACF,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzB,sBAAsB;QACpC,OAAO,YAAY,CAAC,iBAAiB,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACa,UAAU,CACxB,cAAwC,EACxC,KAAa,EACb,OAAgB,EAChB,EAAU,EACV,aAA2B;QAE3B,IAAI,OAAO,EAAE;YACX,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAC5B,oBAAC,oBAAoB,IACnB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,EAAE,KACF,aAAa,GACjB,EACF,EAAE,CACH,CAAC;YACF,OAAO,IAAI,CAAC;SACb;aAAM;YACL,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAC/B,oBAAC,oBAAoB,IACnB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,EAAE,EAAE,EAAE,KACF,aAAa,GACjB,EACF,EAAE,CACH,CAAC;YACF,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED,yCAAyC;IACzB,WAAW,CAAC,QAAgB;QAC1C,uBAAuB;QACvB,IACE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAC5C,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ,CAC/B,EACD;YACA,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;SACb;QAED,uBAAuB;QACvB,IACE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CACzC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ,CAC/B,EACD;YACA,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;SACb;QAED,uBAAuB;QACvB,OAAO,KAAK,CAAC;IACf,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 Admin\n */\n\nimport * as React from \"react\";\nimport type { XAndY } from \"@itwin/core-geometry\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport type {\n  AbstractMenuItemProps,\n  AbstractToolbarProps,\n  DialogLayoutDataProvider,\n  DialogProps,\n  OnCancelFunc,\n  OnItemExecutedFunc,\n  OnNumberCommitFunc,\n  OnValueCommitFunc,\n  Primitives,\n  PropertyDescription,\n  PropertyRecord,\n} from \"@itwin/appui-abstract\";\nimport { RelativePosition, UiAdmin } from \"@itwin/appui-abstract\";\nimport { AccuDrawPopupManager } from \"../accudraw/AccuDrawPopupManager\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport { PopupManager } from \"../popup/PopupManager\";\nimport type { IMatch } from \"../utils/matchesWords\";\nimport type { CursorMenuData } from \"../redux/SessionState\";\nimport { UiFramework } from \"../UiFramework\";\nimport { UiDataProvidedDialog } from \"../dialog/UiDataProvidedDialog\";\n\n/** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.\n * @public\n */\nexport enum KeyinFieldLocalization {\n  /** Include only non-localized key-in strings. */\n  NonLocalized,\n  /** Include only localized key-in strings. */\n  Localized,\n  /** Include localized and non-localized strings for each key-in. */\n  Both,\n}\n\n/** Defines a keyin entry to show/filter in UI\n * @public\n */\nexport interface KeyinEntry {\n  /** string that matched a filter string */\n  value: string;\n  /** define array of start and end positions of filter matches. */\n  matches?: IMatch[];\n  /** true if entry was loaded from key-in history */\n  isHistory?: boolean;\n}\n\n/** Subclass of `UiAdmin` in `@itwin/core-frontend` to be used to initialize `IModelApp`.\n *\n * This implementation uses themed react components that blends in AppUI look and feel.\n *\n * ```ts\n * await IModelApp.startup({\n *   uiAdmin: new FrameworkUiAdmin()\n * });\n * ```\n * @public\n */\nexport class FrameworkUiAdmin extends UiAdmin {\n  private _localizedKeyinPreference: KeyinFieldLocalization =\n    KeyinFieldLocalization.NonLocalized;\n\n  public get localizedKeyinPreference(): KeyinFieldLocalization {\n    return this._localizedKeyinPreference;\n  }\n  public set localizedKeyinPreference(preference: KeyinFieldLocalization) {\n    this._localizedKeyinPreference = preference;\n  }\n\n  /** @internal */\n  public override onInitialized() {}\n\n  /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY. */\n  public override get cursorPosition(): XAndY {\n    return CursorInformation.cursorPosition;\n  }\n\n  /** Determines if focus is set to Home */\n  public override get isFocusOnHome(): boolean {\n    return UiFramework.keyboardShortcuts.isFocusOnHome;\n  }\n\n  /** Sets focus to Home */\n  public override setFocusToHome(): void {\n    UiFramework.keyboardShortcuts.setFocusToHome();\n  }\n\n  /** Show a context menu at a particular location.\n   * @param items Properties of the menu items to display.\n   * @param location Location of the context menu, relative to the origin of htmlElement or the overall window.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public override showContextMenu(\n    items: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    let position = location;\n    let childWindowId: string | undefined;\n    if (htmlElement) {\n      const anchorOffset = htmlElement.getBoundingClientRect();\n      position = {\n        x: anchorOffset.left + location.x,\n        y: anchorOffset.top + location.y,\n      };\n      childWindowId = UiFramework.childWindows.findId(\n        htmlElement.ownerDocument.defaultView\n      );\n    }\n\n    const offset = -8;\n    position = { x: position.x + offset, y: position.y + offset };\n\n    const cursorMenu: CursorMenuData = { position, items, childWindowId };\n    UiFramework.openCursorMenu(cursorMenu);\n\n    return true;\n  }\n\n  /** Resolve location and parent element */\n  private resolveHtmlElement(\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): { position: XAndY; el: HTMLElement } {\n    const position = location;\n    const el = htmlElement ?? UiFramework.controls.getWrapperElement();\n    return { position, el };\n  }\n\n  public getKeyins(): KeyinEntry[] {\n    const toolKeyins: KeyinEntry[] = [];\n    const tools = IModelApp.tools.getToolList();\n    for (const tool of tools) {\n      switch (this.localizedKeyinPreference) {\n        case KeyinFieldLocalization.Localized:\n          toolKeyins.push({ value: tool.keyin });\n          break;\n        case KeyinFieldLocalization.Both:\n          toolKeyins.push({ value: tool.keyin });\n          // istanbul ignore else\n          if (tool.keyin === tool.englishKeyin) break;\n        // istanbul ignore next\n        default: // eslint-disable-line no-fallthrough\n        case KeyinFieldLocalization.NonLocalized:\n          // istanbul ignore next\n          if (\n            KeyinFieldLocalization.NonLocalized ===\n              this.localizedKeyinPreference ||\n            (KeyinFieldLocalization.Both === this.localizedKeyinPreference &&\n              tool.englishKeyin !== tool.keyin)\n          )\n            toolKeyins.push({ value: tool.englishKeyin });\n          break;\n      }\n    }\n\n    return toolKeyins;\n  }\n\n  /** Show the Key-in Palette to display key-in from all registered Tools.\n   * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.\n   * @return true if the Command Palette was displayed, false if it could not be displayed.\n   */\n  public override showKeyinPalette(htmlElement?: HTMLElement): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    // istanbul ignore next\n    const el = htmlElement\n      ? htmlElement\n      : UiFramework.controls.getWrapperElement();\n\n    // istanbul ignore next\n    const hidePopup = () => {\n      IModelApp.uiAdmin.hideKeyinPalette();\n    };\n\n    return PopupManager.showKeyinPalette(\n      this.getKeyins(),\n      el,\n      hidePopup,\n      hidePopup\n    );\n  }\n\n  /** Hides the Key-in Palette. */\n  public override hideKeyinPalette(): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    return PopupManager.hideKeyinPalette();\n  }\n\n  /** Show a Toolbar at a particular location.\n   * @param toolbarProps Properties of the Toolbar to display.\n   * @param location Location of the Toolbar, relative to the origin of htmlElement or the overall window.\n   * @param offset Offset of the Toolbar from the location.\n   * @param onItemExecuted Function invoked after a Toolbar item is executed\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\n   * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\n   */\n  public override showToolbar(\n    toolbarProps: AbstractToolbarProps,\n    location: XAndY,\n    offset: XAndY,\n    onItemExecuted: OnItemExecutedFunc,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showToolbar(\n      toolbarProps,\n      el,\n      position,\n      offset,\n      onItemExecuted,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Hides the toolbar. */\n  public override hideToolbar(): boolean {\n    return PopupManager.hideToolbar();\n  }\n\n  /** Show a menu button at a particular location. A menu button opens a context menu.\n   * @param id Id of the menu button. Multiple menu buttons may be displayed.\n   * @param menuItemsProps Properties of the menu items to display.\n   * @param location Location of the context menu, relative to the origin of htmlElement or the window.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public override showMenuButton(\n    id: string,\n    menuItemsProps: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showMenuButton(\n      id,\n      el,\n      position,\n      menuItemsProps\n    );\n  }\n\n  /** Hides a menu button.\n   * @param id Id of the menu button. Multiple menu buttons may be displayed.\n   * @return true if the menu was hidden, false if the menu could not be hidden.\n   */\n  public override hideMenuButton(id: string): boolean {\n    return AccuDrawPopupManager.hideMenuButton(id);\n  }\n\n  /** Show a calculator at a particular location.\n   * @param initialValue Value initially displayed in the calculator.\n   * @param resultIcon Icon displayed to the left of the value.\n   * @param location Location of the calculator, relative to the origin of htmlElement or the window.\n   * @param onOk Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the menu was displayed, false if the menu could not be displayed.\n   */\n  public override showCalculator(\n    initialValue: number,\n    resultIcon: string,\n    location: XAndY,\n    onOk: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showCalculator(\n      el,\n      position,\n      initialValue,\n      resultIcon,\n      onOk,\n      onCancel\n    );\n  }\n\n  /** Hides the calculator. */\n  public override hideCalculator(): boolean {\n    return AccuDrawPopupManager.hideCalculator();\n  }\n\n  /** Show an input editor for an angle value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showAngleEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showAngleEditor(\n      el,\n      position,\n      initialValue,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Show an input editor for a length value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showLengthEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showLengthEditor(\n      el,\n      position,\n      initialValue,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Show an input editor for a height value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showHeightEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return AccuDrawPopupManager.showHeightEditor(\n      el,\n      position,\n      initialValue,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Show an input editor for a primitive value at a particular location.\n   * @param initialValue Value initially displayed in the editor.\n   * @param propertyDescription Description of the primitive value property\n   * @param location Location of the editor, relative to the origin of htmlElement or the window.\n   * @param onCommit Function called when the OK button or the Enter key is pressed.\n   * @param onCancel Function called when the Cancel button or the Escape key  is pressed.\n   * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n   * @return true if the editor was displayed, false if the editor could not be displayed.\n   */\n  public override showInputEditor(\n    initialValue: Primitives.Value,\n    propertyDescription: PropertyDescription,\n    location: XAndY,\n    onCommit: OnValueCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, htmlElement);\n\n    return PopupManager.showInputEditor(\n      el,\n      position,\n      initialValue,\n      propertyDescription,\n      onCommit,\n      onCancel\n    );\n  }\n\n  /** Hides the input editor. */\n  public override hideInputEditor(): boolean {\n    return PopupManager.hideInputEditor();\n  }\n\n  /** Show an HTML element at a particular location.\n   * @param displayElement The HTMLElement to display\n   * @param location Location of the display element, relative to the origin of htmlElement or the window\n   * @param offset Offset of the display element from the location\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\n   * @return true if the display element was displayed, false if the display element could not be displayed.\n   */\n  public override showHTMLElement(\n    displayElement: HTMLElement,\n    location: XAndY,\n    offset: XAndY,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n\n    // istanbul ignore if\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showHTMLElement(\n      displayElement,\n      el,\n      position,\n      offset,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Hides the HTML Element. */\n  public override hideHTMLElement(): boolean {\n    return PopupManager.hideHTMLElement();\n  }\n\n  /** Show a Card containing content, a title and a toolbar at a particular location.\n   * @param content The HTMLElement of the content to display\n   * @param title Title to display at the top of the card.\n   * @param toolbarProps Properties of the Toolbar to display.\n   * @param location Location of the Card, relative to the origin of htmlElement or the window.\n   * @param offset Offset of the Card from the location.\n   * @param onItemExecuted Function invoked after a Toolbar item is executed\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n   * @return true if the Card was displayed, false if the Card could not be displayed.\n   */\n  public override showCard(\n    content: HTMLElement,\n    title: string | PropertyRecord | undefined,\n    toolbarProps: AbstractToolbarProps | undefined,\n    location: XAndY,\n    offset: XAndY,\n    onItemExecuted: OnItemExecutedFunc,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n\n    // istanbul ignore if\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showCard(\n      content,\n      title,\n      toolbarProps,\n      el,\n      position,\n      offset,\n      onItemExecuted,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Show a Card containing React-based content, a title and a toolbar at a particular location.\n   * @param content The React node of the content to display\n   * @param title Title to display at the top of the card.\n   * @param toolbarProps Properties of the Toolbar to display.\n   * @param location Location of the Card, relative to the origin of htmlElement or the window.\n   * @param offset Offset of the Card from the location.\n   * @param onItemExecuted Function invoked after a Toolbar item is executed\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n   * @return true if the Card was displayed, false if the Card could not be displayed.\n   */\n  public showReactCard(\n    content: React.ReactNode,\n    title: string | PropertyRecord | undefined,\n    toolbarProps: AbstractToolbarProps | undefined,\n    location: XAndY,\n    offset: XAndY,\n    onItemExecuted: OnItemExecutedFunc,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n    const reactContent = { reactNode: content };\n\n    // istanbul ignore if\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showCard(\n      reactContent,\n      title,\n      toolbarProps,\n      el,\n      position,\n      offset,\n      onItemExecuted,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Hides the Card. */\n  public override hideCard(): boolean {\n    return PopupManager.hideCard();\n  }\n\n  /** Opens a Tool Settings Ui popup at a particular location.\n   * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.\n   * @param location Location of the tool settings, relative to the origin of anchorElement or the window\n   * @param offset Offset of the tool settings from the location\n   * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\n   * @param relativePosition Position relative to the given location. Defaults to TopRight.\n   * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n   */\n  public override openToolSettingsPopup(\n    dataProvider: DialogLayoutDataProvider,\n    location: XAndY,\n    offset: XAndY,\n    onCancel: OnCancelFunc,\n    relativePosition?: RelativePosition,\n    anchorElement?: HTMLElement\n  ): boolean {\n    const { position, el } = this.resolveHtmlElement(location, anchorElement);\n\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.openToolSettings(\n      dataProvider,\n      el,\n      position,\n      offset,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public override closeToolSettingsPopup(): boolean {\n    return PopupManager.closeToolSettings();\n  }\n\n  /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\n   * @param uiDataProvider The UiDataProvider for the tool settings\n   * @param title Specify title for dialog.\n   * @param isModal Specify if the dialog is opened as a modal or modeless.\n   * @param id Id of the dialog that is used to close it.\n   * @param optionalProps Optional props for Dialog construction.\n   * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n   */\n  public override openDialog(\n    uiDataProvider: DialogLayoutDataProvider,\n    title: string,\n    isModal: boolean,\n    id: string,\n    optionalProps?: DialogProps\n  ): boolean {\n    if (isModal) {\n      UiFramework.dialogs.modal.open(\n        <UiDataProvidedDialog\n          uiDataProvider={uiDataProvider}\n          title={title}\n          isModal={isModal}\n          id={id}\n          {...optionalProps}\n        />,\n        id\n      );\n      return true;\n    } else {\n      UiFramework.dialogs.modeless.open(\n        <UiDataProvidedDialog\n          uiDataProvider={uiDataProvider}\n          title={title}\n          isModal={isModal}\n          id={id}\n          {...optionalProps}\n        />,\n        id\n      );\n      return true;\n    }\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public override closeDialog(dialogId: string): boolean {\n    // istanbul ignore else\n    if (\n      UiFramework.dialogs.modeless.dialogs.findIndex(\n        (info) => info.id === dialogId\n      )\n    ) {\n      UiFramework.dialogs.modeless.close(dialogId);\n      return true;\n    }\n\n    // istanbul ignore else\n    if (\n      UiFramework.dialogs.modal.dialogs.findIndex(\n        (info) => info.id === dialogId\n      )\n    ) {\n      UiFramework.dialogs.modal.close();\n      return true;\n    }\n\n    // istanbul ignore next\n    return false;\n  }\n}\n"]}

package/lib/esm/appui-react/uistate/AppUiSettings.d.ts

@@ -4,11 +4,12 @@
 import type { UiStateStorage } from "@itwin/core-react";
 import { UiStateEntry } from "@itwin/core-react";
 import type { UserSettingsProvider } from "../UiFramework";
+import type { ThemeId } from "../theme/ThemeManager";
 /** Default values that may be specified for [[AppUiSettings]].
  * @public
  */
 export interface InitialAppUiSettings {
-    colorTheme: string;
+    colorTheme: ThemeId;
     dragInteraction: boolean;
     widgetOpacity: number;
     showWidgetIcon?: boolean;
@@ -18,8 +19,8 @@ export interface InitialAppUiSettings {
     useToolAsToolSettingsLabel?: boolean;
     toolbarOpacity: number;
 }
-/** 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
+/** These are the UI settings that are stored in the Redux store. They control the color theme,
+ * how toolbar group buttons work, and the opacity of floating widget 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.
  *
@@ -34,7 +35,7 @@ export declare class AppUiSettings implements UserSettingsProvider {
     private static _settingNamespace;
     private _settings;
     private _applyingLocalSettings;
-    colorTheme: UiStateEntry<string>;
+    colorTheme: UiStateEntry<ThemeId>;
     dragInteraction: UiStateEntry<boolean>;
     widgetOpacity: UiStateEntry<number>;
     showWidgetIcon: UiStateEntry<boolean>;

package/lib/esm/appui-react/uistate/AppUiSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppUiSettings.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAM3D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa;IACb,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,YAAW,oBAAoB;IACxD,SAAgB,UAAU,2BAA2B;IAErD,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmB;IACnD,OAAO,CAAC,SAAS,CAAgC;IACjD,OAAO,CAAC,sBAAsB,CAAS;IAEhC,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACjC,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,cAAc,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE5C,OAAO,CAAC,aAAa,CAInB;gBAEU,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC;IA8EnD,OAAO,CAAC,iBAAiB,CAsCvB;IAEW,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7C,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAGtE"}
+{"version":3,"file":"AppUiSettings.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAG3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIrD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa;IACb,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,YAAW,oBAAoB;IACxD,SAAgB,UAAU,2BAA2B;IAErD,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmB;IACnD,OAAO,CAAC,SAAS,CAAgC;IACjD,OAAO,CAAC,sBAAsB,CAAS;IAEhC,UAAU,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClC,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACvC,aAAa,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,cAAc,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,0BAA0B,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,cAAc,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE5C,OAAO,CAAC,aAAa,CAInB;gBAEU,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC;IA8EnD,OAAO,CAAC,iBAAiB,CAsCvB;IAEW,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7C,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAGtE"}

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

@@ -8,8 +8,8 @@
 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
+/** These are the UI settings that are stored in the Redux store. They control the color theme,
+ * how toolbar group buttons work, and the opacity of floating widget 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.
  *

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;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAoB7C;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IAsBxB,YAAY,QAAuC;QArBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAW/B,kBAAa,GAAG,CAAC,KAAa,EAAE,EAAE;YACxC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QAgFM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAAE,OAAO;YAExC,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,CACzB,mBAAmB,EACnB,WAAW,CAAC,aAAa,EAAE,CAC5B,CAAC;aACH;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,CAC/C,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,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,CACxC,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAC/C,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,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;QAnHA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAChC,aAAa,CAAC,iBAAiB,EAC/B,YAAY,EACZ,WAAW,CAAC,aAAa,EACzB,IAAI,CAAC,aAAa,EAClB,QAAQ,CAAC,UAAU,CACpB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,YAAY,CACrC,aAAa,CAAC,iBAAiB,EAC/B,iBAAiB,EACjB,GAAG,EAAE,CAAC,WAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAC5D,QAAQ,CAAC,eAAe,CACzB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,gBAAgB,EAChB,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACxD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,YAAY,CACnC,aAAa,CAAC,iBAAiB,EAC/B,eAAe,EACf,GAAG,EAAE,CAAC,WAAW,CAAC,gBAAgB,EAAE,EACpC,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EACtD,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,YAAY,CACzC,aAAa,CAAC,iBAAiB,EAC/B,qBAAqB,EACrB,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAC7D,QAAQ,CAAC,mBAAmB,CAC7B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,aAAa,EACb,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,EACrC,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACvD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,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;IA0CM,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;;AAnJc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;SAHxC,aAAa","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 type { UiStateStorage } from \"@itwin/core-react\";\nimport { UiStateEntry } from \"@itwin/core-react\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport type { UserSettingsProvider } from \"../UiFramework\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\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>(\n      AppUiSettings._settingNamespace,\n      \"ColorTheme\",\n      UiFramework.getColorTheme,\n      this.setColorTheme,\n      defaults.colorTheme\n    );\n    this._settings.push(this.colorTheme);\n\n    this.dragInteraction = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"DragInteraction\",\n      () => UiFramework.useDragInteraction,\n      (value: boolean) => UiFramework.setUseDragInteraction(value),\n      defaults.dragInteraction\n    );\n    this._settings.push(this.dragInteraction);\n\n    this.showWidgetIcon = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"ShowWidgetIcon\",\n      () => UiFramework.showWidgetIcon,\n      (value: boolean) => UiFramework.setShowWidgetIcon(value),\n      defaults.showWidgetIcon\n    );\n    this._settings.push(this.showWidgetIcon);\n\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AutoCollapseUnpinnedPanels\",\n      () => UiFramework.autoCollapseUnpinnedPanels,\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value),\n      defaults.autoCollapseUnpinnedPanels\n    );\n    this._settings.push(this.autoCollapseUnpinnedPanels);\n\n    this.widgetOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"WidgetOpacity\",\n      () => UiFramework.getWidgetOpacity(),\n      (value: number) => UiFramework.setWidgetOpacity(value),\n      defaults.widgetOpacity\n    );\n    this._settings.push(this.widgetOpacity);\n\n    this.animateToolSettings = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AnimateToolSettings\",\n      () => UiFramework.animateToolSettings,\n      (value: boolean) => UiFramework.setAnimateToolSettings(value),\n      defaults.animateToolSettings\n    );\n    this._settings.push(this.animateToolSettings);\n\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"UseToolAsToolSettingsLabel\",\n      () => UiFramework.useToolAsToolSettingsLabel,\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value),\n      defaults.useToolAsToolSettingsLabel\n    );\n    this._settings.push(this.useToolAsToolSettingsLabel);\n\n    this.toolbarOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"ToolOpacity\",\n      () => UiFramework.getToolbarOpacity(),\n      (value: number) => UiFramework.setToolbarOpacity(value),\n      defaults.toolbarOpacity\n    );\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) 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(\n        \"uifw:defaultTheme\",\n        UiFramework.getColorTheme()\n      );\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(\n        UiFramework.getUiStateStorage()\n      );\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(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\n      await this.useToolAsToolSettingsLabel.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\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"]}
+{"version":3,"file":"AppUiSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/AppUiSettings.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAqB7C;;;;;;;;;;GAUG;AACH,MAAa,aAAa;IAsBxB,YAAY,QAAuC;QArBnC,eAAU,GAAG,uBAAuB,CAAC;QAG7C,cAAS,GAA6B,EAAE,CAAC;QACzC,2BAAsB,GAAG,KAAK,CAAC;QAW/B,kBAAa,GAAG,CAAC,KAAc,EAAE,EAAE;YACzC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,6FAA6F;YAC7F,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC;QAgFM,sBAAiB,GAAG,KAAK,EAAE,IAAqB,EAAE,EAAE;YAC1D,IAAI,IAAI,CAAC,sBAAsB;gBAAE,OAAO;YAExC,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,CACzB,mBAAmB,EACnB,WAAW,CAAC,aAAa,EAAE,CAC5B,CAAC;aACH;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,CAC/C,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,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,CACxC,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,oDAAoD,CAAC;gBACzE,MAAM,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAC/C,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;YAEJ,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;QAnHA,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,CAChC,aAAa,CAAC,iBAAiB,EAC/B,YAAY,EACZ,WAAW,CAAC,aAAa,EACzB,IAAI,CAAC,aAAa,EAClB,QAAQ,CAAC,UAAU,CACpB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,YAAY,CACrC,aAAa,CAAC,iBAAiB,EAC/B,iBAAiB,EACjB,GAAG,EAAE,CAAC,WAAW,CAAC,kBAAkB,EACpC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAC5D,QAAQ,CAAC,eAAe,CACzB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,gBAAgB,EAChB,GAAG,EAAE,CAAC,WAAW,CAAC,cAAc,EAChC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACxD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzC,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,GAAG,IAAI,YAAY,CACnC,aAAa,CAAC,iBAAiB,EAC/B,eAAe,EACf,GAAG,EAAE,CAAC,WAAW,CAAC,gBAAgB,EAAE,EACpC,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,EACtD,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,mBAAmB,GAAG,IAAI,YAAY,CACzC,aAAa,CAAC,iBAAiB,EAC/B,qBAAqB,EACrB,GAAG,EAAE,CAAC,WAAW,CAAC,mBAAmB,EACrC,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAC7D,QAAQ,CAAC,mBAAmB,CAC7B,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE9C,IAAI,CAAC,0BAA0B,GAAG,IAAI,YAAY,CAChD,aAAa,CAAC,iBAAiB,EAC/B,4BAA4B,EAC5B,GAAG,EAAE,CAAC,WAAW,CAAC,0BAA0B,EAC5C,CAAC,KAAc,EAAE,EAAE,CAAC,WAAW,CAAC,6BAA6B,CAAC,KAAK,CAAC,EACpE,QAAQ,CAAC,0BAA0B,CACpC,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CACpC,aAAa,CAAC,iBAAiB,EAC/B,aAAa,EACb,GAAG,EAAE,CAAC,WAAW,CAAC,iBAAiB,EAAE,EACrC,CAAC,KAAa,EAAE,EAAE,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,EACvD,QAAQ,CAAC,cAAc,CACxB,CAAC;QACF,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;IA0CM,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;;AAnJc,+BAAiB,GAAG,eAAe,AAAlB,CAAmB;SAHxC,aAAa","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 type { UiStateStorage } from \"@itwin/core-react\";\nimport { UiStateEntry } from \"@itwin/core-react\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport type { UserSettingsProvider } from \"../UiFramework\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\nimport type { ThemeId } from \"../theme/ThemeManager\";\n\n// cSpell:ignore configurableui\n\n/** Default values that may be specified for [[AppUiSettings]].\n * @public\n */\nexport interface InitialAppUiSettings {\n  colorTheme: ThemeId;\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,\n * how toolbar group buttons work, and the opacity of floating widget 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<ThemeId>;\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: ThemeId) => {\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<ThemeId>(\n      AppUiSettings._settingNamespace,\n      \"ColorTheme\",\n      UiFramework.getColorTheme,\n      this.setColorTheme,\n      defaults.colorTheme\n    );\n    this._settings.push(this.colorTheme);\n\n    this.dragInteraction = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"DragInteraction\",\n      () => UiFramework.useDragInteraction,\n      (value: boolean) => UiFramework.setUseDragInteraction(value),\n      defaults.dragInteraction\n    );\n    this._settings.push(this.dragInteraction);\n\n    this.showWidgetIcon = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"ShowWidgetIcon\",\n      () => UiFramework.showWidgetIcon,\n      (value: boolean) => UiFramework.setShowWidgetIcon(value),\n      defaults.showWidgetIcon\n    );\n    this._settings.push(this.showWidgetIcon);\n\n    this.autoCollapseUnpinnedPanels = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AutoCollapseUnpinnedPanels\",\n      () => UiFramework.autoCollapseUnpinnedPanels,\n      (value: boolean) => UiFramework.setAutoCollapseUnpinnedPanels(value),\n      defaults.autoCollapseUnpinnedPanels\n    );\n    this._settings.push(this.autoCollapseUnpinnedPanels);\n\n    this.widgetOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"WidgetOpacity\",\n      () => UiFramework.getWidgetOpacity(),\n      (value: number) => UiFramework.setWidgetOpacity(value),\n      defaults.widgetOpacity\n    );\n    this._settings.push(this.widgetOpacity);\n\n    this.animateToolSettings = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"AnimateToolSettings\",\n      () => UiFramework.animateToolSettings,\n      (value: boolean) => UiFramework.setAnimateToolSettings(value),\n      defaults.animateToolSettings\n    );\n    this._settings.push(this.animateToolSettings);\n\n    this.useToolAsToolSettingsLabel = new UiStateEntry<boolean>(\n      AppUiSettings._settingNamespace,\n      \"UseToolAsToolSettingsLabel\",\n      () => UiFramework.useToolAsToolSettingsLabel,\n      (value: boolean) => UiFramework.setUseToolAsToolSettingsLabel(value),\n      defaults.useToolAsToolSettingsLabel\n    );\n    this._settings.push(this.useToolAsToolSettingsLabel);\n\n    this.toolbarOpacity = new UiStateEntry<number>(\n      AppUiSettings._settingNamespace,\n      \"ToolOpacity\",\n      () => UiFramework.getToolbarOpacity(),\n      (value: number) => UiFramework.setToolbarOpacity(value),\n      defaults.toolbarOpacity\n    );\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) 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(\n        \"uifw:defaultTheme\",\n        UiFramework.getColorTheme()\n      );\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(\n        UiFramework.getUiStateStorage()\n      );\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(\n        UiFramework.getUiStateStorage()\n      );\n\n    if (args.eventIds.has(\"configurableui:set-use-tool-as-tool-settings-label\"))\n      await this.useToolAsToolSettingsLabel.saveSetting(\n        UiFramework.getUiStateStorage()\n      );\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

@@ -13,7 +13,16 @@ export declare const UiStateStorageContext: React.Context<UiStateStorage>;
 export interface UiSettingsProviderProps {
     children?: React.ReactNode;
 }
-/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
+/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings
+ * through [[UiFramework.setUiStateStorage]].
+ *
+ * This component should wrap the [[ConfigurableUiContent]].
+ *
+ * ```tsx
+ *  <UiStateStorageHandler>
+ *    <ConfigurableUiContent />
+ *  </UiStateStorageHandler>
+ * ```
  * @public
  */
 export declare function UiStateStorageHandler(props: UiSettingsProviderProps): JSX.Element;

package/lib/esm/appui-react/uistate/useUiStateStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useUiStateStorage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AASxD,cAAc;AACd,wBAAgB,wBAAwB,IAAI,cAAc,CAEzD;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,+BAEjC,CAAC;AAGF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,uBAAuB,eAyBnE"}
+{"version":3,"file":"useUiStateStorage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AASxD,cAAc;AACd,wBAAgB,wBAAwB,IAAI,cAAc,CAEzD;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,+BAEjC,CAAC;AAGF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,uBAAuB,eAyBnE"}

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

@@ -16,7 +16,16 @@ export function useUiStateStorageHandler() {
 /** @internal */
 export const UiStateStorageContext = React.createContext(new LocalStateStorage());
 UiStateStorageContext.displayName = "uifw:UiStateStorageContext";
-/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings.
+/** Allows to provide a custom [[UiStateStorage]] implementation to persist UI settings
+ * through [[UiFramework.setUiStateStorage]].
+ *
+ * This component should wrap the [[ConfigurableUiContent]].
+ *
+ * ```tsx
+ *  <UiStateStorageHandler>
+ *    <ConfigurableUiContent />
+ *  </UiStateStorageHandler>
+ * ```
  * @public
  */
 export function UiStateStorageHandler(props) {

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;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACL,qBAAqB,EACrB,aAAa,GACd,MAAM,iCAAiC,CAAC;AAGzC,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,CACtD,IAAI,iBAAiB,EAAE,CACxB,CAAC;AACF,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,CACpD,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IACE,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACtD,aAAa,CAAC,qBAAqB;aACpC,CAAC;gBAEF,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 type { UiStateStorage } from \"@itwin/core-react\";\nimport { LocalStateStorage } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\nimport {\n  SyncUiEventDispatcher,\n  SyncUiEventId,\n} from \"../syncui/SyncUiEventDispatcher\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n/** @public */\nexport function useUiStateStorageHandler(): UiStateStorage {\n  return React.useContext(UiStateStorageContext);\n}\n\n/** @internal */\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(\n  new LocalStateStorage()\n);\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(\n    UiFramework.getUiStateStorage()\n  );\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [\n          SyncUiEventId.UiStateStorageChanged,\n        ])\n      )\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"]}
+{"version":3,"file":"useUiStateStorage.js","sourceRoot":"","sources":["../../../../src/appui-react/uistate/useUiStateStorage.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACL,qBAAqB,EACrB,aAAa,GACd,MAAM,iCAAiC,CAAC;AAGzC,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,CACtD,IAAI,iBAAiB,EAAE,CACxB,CAAC;AACF,qBAAqB,CAAC,WAAW,GAAG,4BAA4B,CAAC;AASjE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAA8B;IAClE,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CACpD,WAAW,CAAC,iBAAiB,EAAE,CAChC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAuB;QACvB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,IACE,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACtD,aAAa,CAAC,qBAAqB;aACpC,CAAC;gBAEF,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 type { UiStateStorage } from \"@itwin/core-react\";\nimport { LocalStateStorage } from \"@itwin/core-react\";\nimport { UiFramework } from \"../UiFramework\";\nimport {\n  SyncUiEventDispatcher,\n  SyncUiEventId,\n} from \"../syncui/SyncUiEventDispatcher\";\nimport type { UiSyncEventArgs } from \"../syncui/UiSyncEvent\";\n\n/** @public */\nexport function useUiStateStorageHandler(): UiStateStorage {\n  return React.useContext(UiStateStorageContext);\n}\n\n/** @internal */\nexport const UiStateStorageContext = React.createContext<UiStateStorage>(\n  new LocalStateStorage()\n);\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 * through [[UiFramework.setUiStateStorage]].\n *\n * This component should wrap the [[ConfigurableUiContent]].\n *\n * ```tsx\n *  <UiStateStorageHandler>\n *    <ConfigurableUiContent />\n *  </UiStateStorageHandler>\n * ```\n * @public\n */\nexport function UiStateStorageHandler(props: UiSettingsProviderProps) {\n  const [stateStorage, setStateStorage] = React.useState(\n    UiFramework.getUiStateStorage()\n  );\n\n  React.useEffect(() => {\n    // istanbul ignore next\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, [\n          SyncUiEventId.UiStateStorageChanged,\n        ])\n      )\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/matchesWords.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+/**
+ * Interface that returns indices of matches
+ * @internal
+ */
+export interface IMatch {
+    start: number;
+    end: number;
+}
+/**
+ * Matches beginning of words supporting non-ASCII languages.
+ * @param word Filter string
+ * @param target String being searched
+ * @param contiguous - If true the filter string must be found "contiguous" in the searched string (E.g. "pul" will match "Git: Pull").
+ * Otherwise also matches sub string of the word with beginnings of the words in the target (e.g. "gp" or "g p" will match "Git: Pull").
+ * Useful in cases where the target is words (e.g. command labels)
+ * @internal
+ */
+export declare function matchesWords(word: string, target: string, contiguous?: boolean): IMatch[] | null;
+//# sourceMappingURL=matchesWords.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"matchesWords.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/matchesWords.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,UAAU,GAAE,OAAe,GAC1B,MAAM,EAAE,GAAG,IAAI,CAkBjB"}

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

@@ -0,0 +1,99 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
+/**
+ * Matches beginning of words supporting non-ASCII languages.
+ * @param word Filter string
+ * @param target String being searched
+ * @param contiguous - If true the filter string must be found "contiguous" in the searched string (E.g. "pul" will match "Git: Pull").
+ * Otherwise also matches sub string of the word with beginnings of the words in the target (e.g. "gp" or "g p" will match "Git: Pull").
+ * Useful in cases where the target is words (e.g. command labels)
+ * @internal
+ */
+export function matchesWords(word, target, contiguous = false) {
+    if (!target || target.length === 0) {
+        return null;
+    }
+    let result = null;
+    let i = 0;
+    word = word.toLowerCase();
+    target = target.toLowerCase();
+    while (i < target.length &&
+        (result = matchesWordsInternal(word, target, 0, i, contiguous)) === null) {
+        i = nextWord(target, i + 1);
+    }
+    return result;
+}
+function matchesWordsInternal(word, target, i, j, contiguous) {
+    if (i === word.length) {
+        return [];
+    }
+    else if (j === target.length) {
+        return null;
+    }
+    else if (!charactersMatch(word.charCodeAt(i), target.charCodeAt(j))) {
+        return null;
+    }
+    else {
+        let result = null;
+        let nextWordIndex = j + 1;
+        result = matchesWordsInternal(word, target, i + 1, j + 1, contiguous);
+        if (!contiguous) {
+            while (!result &&
+                (nextWordIndex = nextWord(target, nextWordIndex)) < target.length) {
+                result = matchesWordsInternal(word, target, i + 1, nextWordIndex, contiguous);
+                nextWordIndex++;
+            }
+        }
+        return result === null ? null : join({ start: j, end: j + 1 }, result);
+    }
+}
+function nextWord(word, start) {
+    for (let i = start; i < word.length; i++) {
+        if (isWordSeparator(word.charCodeAt(i)) ||
+            (i > 0 && isWordSeparator(word.charCodeAt(i - 1)))) {
+            return i;
+        }
+    }
+    return word.length;
+}
+var CharCode;
+(function (CharCode) {
+    CharCode[CharCode["Space"] = 32] = "Space";
+    CharCode[CharCode["Tab"] = 9] = "Tab";
+    CharCode[CharCode["LineFeed"] = 10] = "LineFeed";
+    CharCode[CharCode["CarriageReturn"] = 13] = "CarriageReturn";
+})(CharCode || (CharCode = {}));
+function isWhitespace(code) {
+    return (code === CharCode.Space ||
+        code === CharCode.Tab ||
+        code === CharCode.LineFeed ||
+        code === CharCode.CarriageReturn);
+}
+const wordSeparators = new Set();
+"`~!@#$%^&*()-=+[{]}\\|;:'\",.<>/?"
+    .split("")
+    .forEach((s) => wordSeparators.add(s.charCodeAt(0)));
+function isWordSeparator(code) {
+    return isWhitespace(code) || wordSeparators.has(code);
+}
+function charactersMatch(codeA, codeB) {
+    return codeA === codeB || (isWordSeparator(codeA) && isWordSeparator(codeB));
+}
+function join(head, tail) {
+    if (tail.length === 0) {
+        tail = [head];
+    }
+    else if (head.end === tail[0].start) {
+        tail[0].start = head.start;
+    }
+    else {
+        tail.unshift(head);
+    }
+    return tail;
+}
+//# sourceMappingURL=matchesWords.js.map