@itwin/appui-react 4.14.0 → 4.15.0

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

@@ -14,37 +14,31 @@ export interface UiItemsProvider {
     /** Id of provider. */
     readonly id: string;
     /** Provides toolbar items.
-     * @note Use [[ToolbarItem.layouts]] to map item to location previously specified by `provideToolbarItems` arguments.
-     * @alpha
+     * @note Use {@link CommonToolbarItem.layouts} to map item to location previously specified by `provideToolbarItems` arguments.
      */
     readonly getToolbarItems?: () => ReadonlyArray<ToolbarItem>;
-    /** Provides status bar items.
-     * @alpha
-     */
+    /** Provides status bar items. */
     readonly getStatusBarItems?: () => ReadonlyArray<StatusBarItem>;
-    /** Provides backstage items.
-     * @alpha
-     */
+    /** Provides backstage items. */
     readonly getBackstageItems?: () => ReadonlyArray<BackstageItem>;
     /** Provides widgets.
-     * @note Use [[Widget.layouts]] to map item to location previously specified by `provideWidgets` arguments.
-     * @alpha
+     * @note Use {@link Widget.layouts} to map item to location previously specified by `provideWidgets` arguments.
      */
     readonly getWidgets?: () => ReadonlyArray<Widget>;
     /** Provides toolbar items.
-     * @note Use [[UiItemsProvider.getToolbarItems]] instead. To map item to location previously specified by arguments use [[ToolbarItem.layouts]].
+     * @deprecated in 4.15.0. Use {@link UiItemsProvider.getToolbarItems} instead. To map item to location previously specified by arguments use {@link CommonToolbarItem.layouts}.
      */
     readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;
     /** Provides status bar items.
-     * @note Use [[UiItemsProvider.getStatusBarItems]] instead.
+     * @deprecated in 4.15.0. Use {@link UiItemsProvider.getStatusBarItems} instead.
      */
     readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;
     /** Provides backstage items.
-     * @note Use [[UiItemsProvider.getBackstageItems]] instead.
+     * @deprecated in 4.15.0. Use {@link UiItemsProvider.getBackstageItems} instead.
      */
     readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;
     /** Provides widgets.
-     * @note Use [[UiItemsProvider.getWidgets]] instead. To map item to location previously specified by arguments use [[Widget.layouts]].
+     * @deprecated in 4.15.0. Use {@link UiItemsProvider.getWidgets} instead. To map item to location previously specified by arguments use {@link 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. */

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;;;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"}
+{"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,EAEV,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;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;IAC5D,iCAAiC;IACjC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IAChE,gCAAgC;IAChC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IAChE;;OAEG;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   * @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"]}
+{"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  CommonToolbarItem,\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 {@link CommonToolbarItem.layouts} to map item to location previously specified by `provideToolbarItems` arguments.\n   */\n  readonly getToolbarItems?: () => ReadonlyArray<ToolbarItem>;\n  /** Provides status bar items. */\n  readonly getStatusBarItems?: () => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items. */\n  readonly getBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets.\n   * @note Use {@link Widget.layouts} to map item to location previously specified by `provideWidgets` arguments.\n   */\n  readonly getWidgets?: () => ReadonlyArray<Widget>;\n\n  /** Provides toolbar items.\n   * @deprecated in 4.15.0. Use {@link UiItemsProvider.getToolbarItems} instead. To map item to location previously specified by arguments use {@link CommonToolbarItem.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   * @deprecated in 4.15.0. Use {@link UiItemsProvider.getStatusBarItems} instead.\n   */\n  readonly provideStatusBarItems?: (\n    stageId: string,\n    stageUsage: string\n  ) => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items.\n   * @deprecated in 4.15.0. Use {@link UiItemsProvider.getBackstageItems} instead.\n   */\n  readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets.\n   * @deprecated in 4.15.0. Use {@link UiItemsProvider.getWidgets} instead. To map item to location previously specified by arguments use {@link 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

@@ -21,20 +21,20 @@ import { KeyinFieldLocalization } from "../keyins/Keyins";
 export declare class FrameworkUiAdmin extends UiAdmin {
     private _localizedKeyinPreference;
     /**
-     * @deprecated in 4.11.x. Gathering and filtering of keyins is now left up to the user.
+     * @deprecated in 4.11.0. Gathering and filtering of keyins is now left up to the user.
      */
     get localizedKeyinPreference(): KeyinFieldLocalization;
     set localizedKeyinPreference(preference: KeyinFieldLocalization);
     /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY.
-     * @deprecated in 4.11.x. Please use {@link CursorInformation.cursorPosition}
+     * @deprecated in 4.11.0. Please use {@link CursorInformation.cursorPosition}
      */
     get cursorPosition(): XAndY;
     /** Determines if focus is set to Home
-     * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}
+     * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}
      */
     get isFocusOnHome(): boolean;
     /** Sets focus to Home
-     * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}
+     * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}
      */
     setFocusToHome(): void;
     /** Show a context menu at a particular location.
@@ -42,22 +42,22 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param location Location of the context menu, relative to the origin of htmlElement or the overall window.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the menu was displayed, false if the menu could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.openContextMenu}
+     * @deprecated in 4.11.0. Use {@link UiFramework.openContextMenu}
      */
     showContextMenu(items: AbstractMenuItemProps[], location: XAndY, htmlElement?: HTMLElement): boolean;
     /**
-     * @deprecated in 4.11.x. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.
+     * @deprecated in 4.11.0. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.
      */
     getKeyins(): KeyinEntry[];
     /** Show the Key-in Palette to display key-in from all registered Tools.
      * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.
      * @return true if the Command Palette was displayed, false if it could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.
      */
     showKeyinPalette(htmlElement?: HTMLElement): boolean;
     /**
      * Hides the Key-in Palette.
-     * @deprecated in 4.11.x. Use {@link UiFramework.hideKeyinPalette}
+     * @deprecated in 4.11.0. Use {@link UiFramework.hideKeyinPalette}
      */
     hideKeyinPalette(): boolean;
     /** Show a Toolbar at a particular location.
@@ -69,11 +69,11 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param relativePosition Position relative to the given location. Defaults to TopRight.
      * @param htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
      * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.showToolbar}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.showToolbar}.
      */
     showToolbar(toolbarProps: AbstractToolbarProps, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, htmlElement?: HTMLElement): boolean;
     /** Hides the toolbar.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.hideToolbar}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.hideToolbar}.
      */
     hideToolbar(): boolean;
     /** Show a menu button at a particular location. A menu button opens a context menu.
@@ -82,13 +82,13 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param location Location of the context menu, relative to the origin of htmlElement or the window.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the menu was displayed, false if the menu could not be displayed.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.showMenuButton}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.showMenuButton}.
      */
     showMenuButton(id: string, menuItemsProps: AbstractMenuItemProps[], location: XAndY, htmlElement?: HTMLElement): boolean;
     /** Hides a menu button.
      * @param id Id of the menu button. Multiple menu buttons may be displayed.
      * @return true if the menu was hidden, false if the menu could not be hidden.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.hideMenuButton}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.hideMenuButton}.
      */
     hideMenuButton(id: string): boolean;
     /** Show a calculator at a particular location.
@@ -99,11 +99,11 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the menu was displayed, false if the menu could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showCalculator}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showCalculator}.
      */
     showCalculator(initialValue: number, resultIcon: string, location: XAndY, onOk: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
     /** Hides the calculator.
-     * @deprecated in 4.11.x. Use {@link UiFramework.hideCalculator}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.hideCalculator}.
      */
     hideCalculator(): boolean;
     /** Show an input editor for an angle value at a particular location.
@@ -113,7 +113,7 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the editor was displayed, false if the editor could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showAngleEditor}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showAngleEditor}.
      */
     showAngleEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
     /** Show an input editor for a length value at a particular location.
@@ -123,7 +123,7 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the editor was displayed, false if the editor could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor("length")}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor("length")}.
      */
     showLengthEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
     /** Show an input editor for a height value at a particular location.
@@ -133,7 +133,7 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the editor was displayed, false if the editor could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor("height")}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor("height")}.
      */
     showHeightEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
     /** Show an input editor for a primitive value at a particular location.
@@ -156,12 +156,12 @@ export declare class FrameworkUiAdmin extends UiAdmin {
      * @param relativePosition Position relative to the given location. Defaults to TopRight.
      * @param anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.
      * @return true if the display element was displayed, false if the display element could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showComponent}
+     * @deprecated in 4.11.0. Use {@link UiFramework.showComponent}
      */
     showHTMLElement(displayElement: HTMLElement, location: XAndY, offset: XAndY, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
     /**
      *  Hides the HTML Element.
-     * @deprecated in 4.11.x. Use {@link UiFramework.hideComponent}
+     * @deprecated in 4.11.0. Use {@link UiFramework.hideComponent}
      */
     hideHTMLElement(): boolean;
     /** Show a Card containing content, a title and a toolbar at a particular location.

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

@@ -30,7 +30,7 @@ export class FrameworkUiAdmin extends UiAdmin {
         this._localizedKeyinPreference = KeyinFieldLocalization.NonLocalized;
     }
     /**
-     * @deprecated in 4.11.x. Gathering and filtering of keyins is now left up to the user.
+     * @deprecated in 4.11.0. Gathering and filtering of keyins is now left up to the user.
      */
     get localizedKeyinPreference() {
         return this._localizedKeyinPreference;
@@ -39,19 +39,19 @@ export class FrameworkUiAdmin extends UiAdmin {
         this._localizedKeyinPreference = preference;
     }
     /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY.
-     * @deprecated in 4.11.x. Please use {@link CursorInformation.cursorPosition}
+     * @deprecated in 4.11.0. Please use {@link CursorInformation.cursorPosition}
      */
     get cursorPosition() {
         return CursorInformation.cursorPosition;
     }
     /** Determines if focus is set to Home
-     * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}
+     * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}
      */
     get isFocusOnHome() {
         return UiFramework.keyboardShortcuts.isFocusOnHome;
     }
     /** Sets focus to Home
-     * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}
+     * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}
      */
     setFocusToHome() {
         UiFramework.keyboardShortcuts.setFocusToHome();
@@ -61,13 +61,13 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param location Location of the context menu, relative to the origin of htmlElement or the overall window.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the menu was displayed, false if the menu could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.openContextMenu}
+     * @deprecated in 4.11.0. Use {@link UiFramework.openContextMenu}
      */
     showContextMenu(items, location, htmlElement) {
         return UiFramework.openContextMenu(items, location, htmlElement);
     }
     /**
-     * @deprecated in 4.11.x. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.
+     * @deprecated in 4.11.0. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.
      */
     getKeyins() {
         const tools = IModelApp.tools.getToolList();
@@ -76,7 +76,7 @@ export class FrameworkUiAdmin extends UiAdmin {
     /** Show the Key-in Palette to display key-in from all registered Tools.
      * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.
      * @return true if the Command Palette was displayed, false if it could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.
      */
     showKeyinPalette(htmlElement) {
         if (!this.featureFlags.allowKeyinPalette)
@@ -87,7 +87,7 @@ export class FrameworkUiAdmin extends UiAdmin {
     }
     /**
      * Hides the Key-in Palette.
-     * @deprecated in 4.11.x. Use {@link UiFramework.hideKeyinPalette}
+     * @deprecated in 4.11.0. Use {@link UiFramework.hideKeyinPalette}
      */
     hideKeyinPalette() {
         if (!this.featureFlags.allowKeyinPalette)
@@ -103,14 +103,14 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param relativePosition Position relative to the given location. Defaults to TopRight.
      * @param htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
      * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.showToolbar}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.showToolbar}.
      */
     showToolbar(toolbarProps, location, offset, onItemExecuted, onCancel, relativePosition, htmlElement) {
         const placement = mapToPlacement(relativePosition);
         return UiFramework.showToolbar(toolbarProps, location, offset, onItemExecuted, onCancel, placement, htmlElement);
     }
     /** Hides the toolbar.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.hideToolbar}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.hideToolbar}.
      */
     hideToolbar() {
         return UiFramework.hideToolbar();
@@ -121,7 +121,7 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param location Location of the context menu, relative to the origin of htmlElement or the window.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the menu was displayed, false if the menu could not be displayed.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.showMenuButton}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.showMenuButton}.
      */
     showMenuButton(id, menuItemsProps, location, htmlElement) {
         return UiFramework.showMenuButton(id, menuItemsProps, location, htmlElement);
@@ -129,7 +129,7 @@ export class FrameworkUiAdmin extends UiAdmin {
     /** Hides a menu button.
      * @param id Id of the menu button. Multiple menu buttons may be displayed.
      * @return true if the menu was hidden, false if the menu could not be hidden.
-     * @deprecated in 4.11.x. Please use {@link UiFramework.hideMenuButton}.
+     * @deprecated in 4.11.0. Please use {@link UiFramework.hideMenuButton}.
      */
     hideMenuButton(id) {
         return UiFramework.hideMenuButton(id);
@@ -142,13 +142,13 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the menu was displayed, false if the menu could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showCalculator}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showCalculator}.
      */
     showCalculator(initialValue, resultIcon, location, onOk, onCancel, htmlElement) {
         return UiFramework.showCalculator(initialValue, resultIcon, location, onOk, onCancel, htmlElement);
     }
     /** Hides the calculator.
-     * @deprecated in 4.11.x. Use {@link UiFramework.hideCalculator}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.hideCalculator}.
      */
     hideCalculator() {
         return UiFramework.hideCalculator();
@@ -160,7 +160,7 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the editor was displayed, false if the editor could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showAngleEditor}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showAngleEditor}.
      */
     showAngleEditor(initialValue, location, onCommit, onCancel, htmlElement) {
         return UiFramework.showAngleEditor(initialValue, location, onCommit, onCancel, htmlElement);
@@ -172,7 +172,7 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the editor was displayed, false if the editor could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor("length")}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor("length")}.
      */
     showLengthEditor(initialValue, location, onCommit, onCancel, htmlElement) {
         return UiFramework.showDimensionEditor("length", initialValue, location, onCommit, onCancel, htmlElement);
@@ -184,7 +184,7 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
      * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
      * @return true if the editor was displayed, false if the editor could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor("height")}.
+     * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor("height")}.
      */
     showHeightEditor(initialValue, location, onCommit, onCancel, htmlElement) {
         return UiFramework.showDimensionEditor("height", initialValue, location, onCommit, onCancel, htmlElement);
@@ -220,7 +220,7 @@ export class FrameworkUiAdmin extends UiAdmin {
      * @param relativePosition Position relative to the given location. Defaults to TopRight.
      * @param anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.
      * @return true if the display element was displayed, false if the display element could not be displayed.
-     * @deprecated in 4.11.x. Use {@link UiFramework.showComponent}
+     * @deprecated in 4.11.0. Use {@link UiFramework.showComponent}
      */
     showHTMLElement(displayElement, location, offset, onCancel, relativePosition, anchorElement) {
         const el = anchorElement ?? UiFramework.controls.getWrapperElement();
@@ -230,7 +230,7 @@ export class FrameworkUiAdmin extends UiAdmin {
     }
     /**
      *  Hides the HTML Element.
-     * @deprecated in 4.11.x. Use {@link UiFramework.hideComponent}
+     * @deprecated in 4.11.0. Use {@link UiFramework.hideComponent}
      */
     hideHTMLElement() {
         return PopupManager.hideHTMLElement();

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,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAA7C;;QACU,8BAAyB,GAC/B,sBAAsB,CAAC,YAAY,CAAC;IAuexC,CAAC;IAreC;;OAEG;IACH,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAED,IAAW,wBAAwB,CAAC,UAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,IAAoB,cAAc;QAChC,OAAO,iBAAiB,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAoB,aAAa;QAC/B,OAAO,WAAW,CAAC,iBAAiB,CAAC,aAAa,CAAC;IACrD,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACa,eAAe,CAC7B,KAA8B,EAC9B,QAAe,EACf,WAAyB;QAEzB,OAAO,WAAW,CAAC,eAAe,CAChC,KAA8B,EAC9B,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACa,gBAAgB,CAAC,WAAyB;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAE5C,OAAO,WAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACa,gBAAgB;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,OAAO,WAAW,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACa,WAAW,CACzB,YAAkC,EAClC,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,WAAyB;QAEzB,MAAM,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QAEnD,OAAO,WAAW,CAAC,WAAW,CAC5B,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,WAAW;QACzB,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACa,cAAc,CAC5B,EAAU,EACV,cAAuC,EACvC,QAAe,EACf,WAAyB;QAEzB,OAAO,WAAW,CAAC,cAAc,CAC/B,EAAE,EACF,cAAuC,EACvC,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACa,cAAc,CAAC,EAAU;QACvC,OAAO,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACa,cAAc,CAC5B,YAAoB,EACpB,UAAkB,EAClB,QAAe,EACf,IAAwB,EACxB,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,cAAc,CAC/B,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,OAAO,WAAW,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,eAAe,CAChC,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAA8B,EAC9B,mBAAwC,EACxC,QAAe,EACf,QAA2B,EAC3B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,eAAe,CAAC;YACjC,YAAY;YACZ,mBAAmB;YACnB,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,aAAa,EAAE,WAAW;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IACb,eAAe;QAC7B,OAAO,WAAW,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACa,eAAe,CAC7B,cAA2B,EAC3B,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,GAAG,aAAa,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAErE,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;;;OAGG;IACa,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,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,WAAW,CAAC,QAAQ,CACzB,oBAAC,YAAY,IAAC,OAAO,EAAE,OAAO,GAAI,EAClC,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,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,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,WAAW,CAAC,QAAQ,CACzB,OAAO,EACP,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;SAEK;IACW,QAAQ;QACtB,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAsC,EACtC,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,WAAW,CAAC,qBAAqB,CACtC,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzB,sBAAsB;QACpC,OAAO,WAAW,CAAC,sBAAsB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACa,UAAU,CACxB,cAAwC,EACxC,KAAa,EACb,OAAgB,EAChB,EAAU,EACV,aAA2B;QAE3B,OAAO,WAAW,CAAC,UAAU,CAC3B,cAAc,EACd,KAAK,EACL,OAAO,EACP,EAAE,EACF,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxB,WAAW,CAAC,QAAgB;QAC1C,OAAO,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,+CAA+C;AAC/C,SAAS,kCAAkC,CACzC,KAA2B;IAE3B,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,CAAC;QACtD,MAAM,EAAE,KAAK,CAAC,SAAS;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAuB;IAC7D,OAAO;QACL,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,SAAS;KACtB,CAAC;AACJ,CAAC;AAMD,SAAS,YAAY,CAAC,EAAE,OAAO,EAAqB;IAClD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QACvB,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO,6BAAK,GAAG,EAAE,GAAG,GAAI,CAAC;AAC3B,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 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  CommonToolbarItem,\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 { CursorInformation } from \"../cursor/CursorInformation\";\nimport { PopupManager } from \"../popup/PopupManager\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { KeyinEntry } from \"../keyins/Keyins\";\nimport {\n  getKeyinsFromToolList,\n  KeyinFieldLocalization,\n} from \"../keyins/Keyins\";\nimport { mapToPlacement } from \"../utils/Placement\";\nimport type { ToolbarProps } from \"../toolbar/Toolbar\";\nimport type { ToolbarItem } from \"../toolbar/ToolbarItem\";\nimport type { CursorMenuItemProps } from \"../shared/MenuItem\";\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  /**\n   * @deprecated in 4.11.x. Gathering and filtering of keyins is now left up to the user.\n   */\n  public get localizedKeyinPreference(): KeyinFieldLocalization {\n    return this._localizedKeyinPreference;\n  }\n\n  public set localizedKeyinPreference(preference: KeyinFieldLocalization) {\n    this._localizedKeyinPreference = preference;\n  }\n\n  /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY.\n   * @deprecated in 4.11.x. Please use {@link CursorInformation.cursorPosition}\n   */\n  public override get cursorPosition(): XAndY {\n    return CursorInformation.cursorPosition;\n  }\n\n  /** Determines if focus is set to Home\n   * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}\n   */\n  public override get isFocusOnHome(): boolean {\n    return UiFramework.keyboardShortcuts.isFocusOnHome;\n  }\n\n  /** Sets focus to Home\n   * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}\n   */\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   * @deprecated in 4.11.x. Use {@link UiFramework.openContextMenu}\n   */\n  public override showContextMenu(\n    items: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.openContextMenu(\n      items as CursorMenuItemProps[],\n      location,\n      htmlElement\n    );\n  }\n\n  /**\n   * @deprecated in 4.11.x. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.\n   */\n  public getKeyins(): KeyinEntry[] {\n    const tools = IModelApp.tools.getToolList();\n    return getKeyinsFromToolList(tools);\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   * @deprecated in 4.11.x. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.\n   */\n  public override showKeyinPalette(htmlElement?: HTMLElement): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    const tools = IModelApp.tools.getToolList();\n    const keyIns = getKeyinsFromToolList(tools);\n\n    return UiFramework.showKeyinPalette(keyIns, htmlElement);\n  }\n\n  /**\n   * Hides the Key-in Palette.\n   * @deprecated in 4.11.x. Use {@link UiFramework.hideKeyinPalette}\n   */\n  public override hideKeyinPalette(): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    return UiFramework.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   * @deprecated in 4.11.x. Please use {@link UiFramework.showToolbar}.\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 placement = mapToPlacement(relativePosition);\n\n    return UiFramework.showToolbar(\n      toolbarProps,\n      location,\n      offset,\n      onItemExecuted,\n      onCancel,\n      placement,\n      htmlElement\n    );\n  }\n\n  /** Hides the toolbar.\n   * @deprecated in 4.11.x. Please use {@link UiFramework.hideToolbar}.\n   */\n  public override hideToolbar(): boolean {\n    return UiFramework.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   * @deprecated in 4.11.x. Please use {@link UiFramework.showMenuButton}.\n   */\n  public override showMenuButton(\n    id: string,\n    menuItemsProps: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showMenuButton(\n      id,\n      menuItemsProps as CursorMenuItemProps[],\n      location,\n      htmlElement\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   * @deprecated in 4.11.x. Please use {@link UiFramework.hideMenuButton}.\n   */\n  public override hideMenuButton(id: string): boolean {\n    return UiFramework.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   * @deprecated in 4.11.x. Use {@link UiFramework.showCalculator}.\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    return UiFramework.showCalculator(\n      initialValue,\n      resultIcon,\n      location,\n      onOk,\n      onCancel,\n      htmlElement\n    );\n  }\n\n  /** Hides the calculator.\n   * @deprecated in 4.11.x. Use {@link UiFramework.hideCalculator}.\n   */\n  public override hideCalculator(): boolean {\n    return UiFramework.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   * @deprecated in 4.11.x. Use {@link UiFramework.showAngleEditor}.\n   */\n  public override showAngleEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showAngleEditor(\n      initialValue,\n      location,\n      onCommit,\n      onCancel,\n      htmlElement\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   * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor(\"length\")}.\n   */\n  public override showLengthEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showDimensionEditor(\n      \"length\",\n      initialValue,\n      location,\n      onCommit,\n      onCancel,\n      htmlElement\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   * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor(\"height\")}.\n   */\n  public override showHeightEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showDimensionEditor(\n      \"height\",\n      initialValue,\n      location,\n      onCommit,\n      onCancel,\n      htmlElement\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    return UiFramework.showInputEditor({\n      initialValue,\n      propertyDescription,\n      location,\n      onCommit,\n      onCancel,\n      anchorElement: htmlElement,\n    });\n  }\n\n  /** Hides the input editor.*/\n  public override hideInputEditor(): boolean {\n    return UiFramework.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   * @deprecated in 4.11.x. Use {@link UiFramework.showComponent}\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 el = anchorElement ?? UiFramework.controls.getWrapperElement();\n\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showHTMLElement(\n      displayElement,\n      el,\n      location,\n      offset,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /**\n   *  Hides the HTML Element.\n   * @deprecated in 4.11.x. Use {@link UiFramework.hideComponent}\n   */\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 placement = mapToPlacement(relativePosition);\n    return UiFramework.showCard(\n      <CardRenderer content={content} />,\n      title,\n      toolbarProps\n        ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n        : { items: [] },\n      location,\n      offset,\n      onItemExecuted,\n      onCancel,\n      placement,\n      anchorElement\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 placement = mapToPlacement(relativePosition);\n    return UiFramework.showCard(\n      content,\n      title,\n      toolbarProps\n        ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n        : { items: [] },\n      location,\n      offset,\n      onItemExecuted,\n      onCancel,\n      placement,\n      anchorElement\n    );\n  }\n\n  /**\n   * Hides the Card.\n   * */\n  public override hideCard(): boolean {\n    return UiFramework.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 placement = mapToPlacement(relativePosition);\n    return UiFramework.openToolSettingsPopup(\n      dataProvider,\n      location,\n      offset,\n      onCancel,\n      placement,\n      anchorElement\n    );\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public override closeToolSettingsPopup(): boolean {\n    return UiFramework.closeToolSettingsPopup();\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    return UiFramework.openDialog(\n      uiDataProvider,\n      title,\n      isModal,\n      id,\n      optionalProps\n    );\n  }\n\n  /** Closes the Tool Settings Ui popup.*/\n  public override closeDialog(dialogId: string): boolean {\n    return UiFramework.closeDialog(dialogId);\n  }\n}\n\n// utility functions to wean off appui-abstract\nfunction AbstractToolbarPropsToToolbarProps(\n  props: AbstractToolbarProps\n): ToolbarProps {\n  return {\n    items: props.items.map(CommonToolbarItemToToolBarItem),\n    itemId: props.toolbarId,\n  };\n}\n\nfunction CommonToolbarItemToToolBarItem(item: CommonToolbarItem): ToolbarItem {\n  return {\n    ...item,\n    badge: item.badgeType,\n  };\n}\n\ninterface CardRendererProps {\n  content: HTMLElement;\n}\n\nfunction CardRenderer({ content }: CardRendererProps) {\n  const ref = React.useRef<HTMLDivElement>(null);\n\n  React.useEffect(() => {\n    const el = ref.current;\n    el?.appendChild(content);\n    return () => {\n      el?.removeChild(content);\n    };\n  }, [content]);\n\n  return <div ref={ref} />;\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;AAejD,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAA7C;;QACU,8BAAyB,GAC/B,sBAAsB,CAAC,YAAY,CAAC;IAuexC,CAAC;IAreC;;OAEG;IACH,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAED,IAAW,wBAAwB,CAAC,UAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,IAAoB,cAAc;QAChC,OAAO,iBAAiB,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAoB,aAAa;QAC/B,OAAO,WAAW,CAAC,iBAAiB,CAAC,aAAa,CAAC;IACrD,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACa,eAAe,CAC7B,KAA8B,EAC9B,QAAe,EACf,WAAyB;QAEzB,OAAO,WAAW,CAAC,eAAe,CAChC,KAA8B,EAC9B,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACa,gBAAgB,CAAC,WAAyB;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAE5C,OAAO,WAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACa,gBAAgB;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,OAAO,WAAW,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACa,WAAW,CACzB,YAAkC,EAClC,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,WAAyB;QAEzB,MAAM,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QAEnD,OAAO,WAAW,CAAC,WAAW,CAC5B,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,WAAW;QACzB,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACa,cAAc,CAC5B,EAAU,EACV,cAAuC,EACvC,QAAe,EACf,WAAyB;QAEzB,OAAO,WAAW,CAAC,cAAc,CAC/B,EAAE,EACF,cAAuC,EACvC,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACa,cAAc,CAAC,EAAU;QACvC,OAAO,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACa,cAAc,CAC5B,YAAoB,EACpB,UAAkB,EAClB,QAAe,EACf,IAAwB,EACxB,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,cAAc,CAC/B,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,OAAO,WAAW,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,eAAe,CAChC,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAA8B,EAC9B,mBAAwC,EACxC,QAAe,EACf,QAA2B,EAC3B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,WAAW,CAAC,eAAe,CAAC;YACjC,YAAY;YACZ,mBAAmB;YACnB,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,aAAa,EAAE,WAAW;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IACb,eAAe;QAC7B,OAAO,WAAW,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACa,eAAe,CAC7B,cAA2B,EAC3B,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,GAAG,aAAa,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAErE,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;;;OAGG;IACa,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,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,WAAW,CAAC,QAAQ,CACzB,oBAAC,YAAY,IAAC,OAAO,EAAE,OAAO,GAAI,EAClC,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,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,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,WAAW,CAAC,QAAQ,CACzB,OAAO,EACP,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;SAEK;IACW,QAAQ;QACtB,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAsC,EACtC,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,SAAS,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,WAAW,CAAC,qBAAqB,CACtC,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzB,sBAAsB;QACpC,OAAO,WAAW,CAAC,sBAAsB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACa,UAAU,CACxB,cAAwC,EACxC,KAAa,EACb,OAAgB,EAChB,EAAU,EACV,aAA2B;QAE3B,OAAO,WAAW,CAAC,UAAU,CAC3B,cAAc,EACd,KAAK,EACL,OAAO,EACP,EAAE,EACF,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxB,WAAW,CAAC,QAAgB;QAC1C,OAAO,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,+CAA+C;AAC/C,SAAS,kCAAkC,CACzC,KAA2B;IAE3B,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,CAAC;QACtD,MAAM,EAAE,KAAK,CAAC,SAAS;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAuB;IAC7D,OAAO;QACL,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,SAAS;KACtB,CAAC;AACJ,CAAC;AAMD,SAAS,YAAY,CAAC,EAAE,OAAO,EAAqB;IAClD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QACvB,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO,6BAAK,GAAG,EAAE,GAAG,GAAI,CAAC;AAC3B,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 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  CommonToolbarItem,\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 { CursorInformation } from \"../cursor/CursorInformation\";\nimport { PopupManager } from \"../popup/PopupManager\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { KeyinEntry } from \"../keyins/Keyins\";\nimport {\n  getKeyinsFromToolList,\n  KeyinFieldLocalization,\n} from \"../keyins/Keyins\";\nimport { mapToPlacement } from \"../utils/Placement\";\nimport type { ToolbarProps } from \"../toolbar/Toolbar\";\nimport type { ToolbarItem } from \"../toolbar/ToolbarItem\";\nimport type { CursorMenuItemProps } from \"../shared/MenuItem\";\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  /**\n   * @deprecated in 4.11.0. Gathering and filtering of keyins is now left up to the user.\n   */\n  public get localizedKeyinPreference(): KeyinFieldLocalization {\n    return this._localizedKeyinPreference;\n  }\n\n  public set localizedKeyinPreference(preference: KeyinFieldLocalization) {\n    this._localizedKeyinPreference = preference;\n  }\n\n  /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY.\n   * @deprecated in 4.11.0. Please use {@link CursorInformation.cursorPosition}\n   */\n  public override get cursorPosition(): XAndY {\n    return CursorInformation.cursorPosition;\n  }\n\n  /** Determines if focus is set to Home\n   * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}\n   */\n  public override get isFocusOnHome(): boolean {\n    return UiFramework.keyboardShortcuts.isFocusOnHome;\n  }\n\n  /** Sets focus to Home\n   * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}\n   */\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   * @deprecated in 4.11.0. Use {@link UiFramework.openContextMenu}\n   */\n  public override showContextMenu(\n    items: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.openContextMenu(\n      items as CursorMenuItemProps[],\n      location,\n      htmlElement\n    );\n  }\n\n  /**\n   * @deprecated in 4.11.0. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.\n   */\n  public getKeyins(): KeyinEntry[] {\n    const tools = IModelApp.tools.getToolList();\n    return getKeyinsFromToolList(tools);\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   * @deprecated in 4.11.0. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.\n   */\n  public override showKeyinPalette(htmlElement?: HTMLElement): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    const tools = IModelApp.tools.getToolList();\n    const keyIns = getKeyinsFromToolList(tools);\n\n    return UiFramework.showKeyinPalette(keyIns, htmlElement);\n  }\n\n  /**\n   * Hides the Key-in Palette.\n   * @deprecated in 4.11.0. Use {@link UiFramework.hideKeyinPalette}\n   */\n  public override hideKeyinPalette(): boolean {\n    if (!this.featureFlags.allowKeyinPalette) return false;\n\n    return UiFramework.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   * @deprecated in 4.11.0. Please use {@link UiFramework.showToolbar}.\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 placement = mapToPlacement(relativePosition);\n\n    return UiFramework.showToolbar(\n      toolbarProps,\n      location,\n      offset,\n      onItemExecuted,\n      onCancel,\n      placement,\n      htmlElement\n    );\n  }\n\n  /** Hides the toolbar.\n   * @deprecated in 4.11.0. Please use {@link UiFramework.hideToolbar}.\n   */\n  public override hideToolbar(): boolean {\n    return UiFramework.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   * @deprecated in 4.11.0. Please use {@link UiFramework.showMenuButton}.\n   */\n  public override showMenuButton(\n    id: string,\n    menuItemsProps: AbstractMenuItemProps[],\n    location: XAndY,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showMenuButton(\n      id,\n      menuItemsProps as CursorMenuItemProps[],\n      location,\n      htmlElement\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   * @deprecated in 4.11.0. Please use {@link UiFramework.hideMenuButton}.\n   */\n  public override hideMenuButton(id: string): boolean {\n    return UiFramework.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   * @deprecated in 4.11.0. Use {@link UiFramework.showCalculator}.\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    return UiFramework.showCalculator(\n      initialValue,\n      resultIcon,\n      location,\n      onOk,\n      onCancel,\n      htmlElement\n    );\n  }\n\n  /** Hides the calculator.\n   * @deprecated in 4.11.0. Use {@link UiFramework.hideCalculator}.\n   */\n  public override hideCalculator(): boolean {\n    return UiFramework.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   * @deprecated in 4.11.0. Use {@link UiFramework.showAngleEditor}.\n   */\n  public override showAngleEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showAngleEditor(\n      initialValue,\n      location,\n      onCommit,\n      onCancel,\n      htmlElement\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   * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor(\"length\")}.\n   */\n  public override showLengthEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showDimensionEditor(\n      \"length\",\n      initialValue,\n      location,\n      onCommit,\n      onCancel,\n      htmlElement\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   * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor(\"height\")}.\n   */\n  public override showHeightEditor(\n    initialValue: number,\n    location: XAndY,\n    onCommit: OnNumberCommitFunc,\n    onCancel: OnCancelFunc,\n    htmlElement?: HTMLElement\n  ): boolean {\n    return UiFramework.showDimensionEditor(\n      \"height\",\n      initialValue,\n      location,\n      onCommit,\n      onCancel,\n      htmlElement\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    return UiFramework.showInputEditor({\n      initialValue,\n      propertyDescription,\n      location,\n      onCommit,\n      onCancel,\n      anchorElement: htmlElement,\n    });\n  }\n\n  /** Hides the input editor.*/\n  public override hideInputEditor(): boolean {\n    return UiFramework.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   * @deprecated in 4.11.0. Use {@link UiFramework.showComponent}\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 el = anchorElement ?? UiFramework.controls.getWrapperElement();\n\n    if (relativePosition === undefined)\n      relativePosition = RelativePosition.TopRight;\n\n    return PopupManager.showHTMLElement(\n      displayElement,\n      el,\n      location,\n      offset,\n      onCancel,\n      relativePosition\n    );\n  }\n\n  /**\n   *  Hides the HTML Element.\n   * @deprecated in 4.11.0. Use {@link UiFramework.hideComponent}\n   */\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 placement = mapToPlacement(relativePosition);\n    return UiFramework.showCard(\n      <CardRenderer content={content} />,\n      title,\n      toolbarProps\n        ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n        : { items: [] },\n      location,\n      offset,\n      onItemExecuted,\n      onCancel,\n      placement,\n      anchorElement\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 placement = mapToPlacement(relativePosition);\n    return UiFramework.showCard(\n      content,\n      title,\n      toolbarProps\n        ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n        : { items: [] },\n      location,\n      offset,\n      onItemExecuted,\n      onCancel,\n      placement,\n      anchorElement\n    );\n  }\n\n  /**\n   * Hides the Card.\n   * */\n  public override hideCard(): boolean {\n    return UiFramework.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 placement = mapToPlacement(relativePosition);\n    return UiFramework.openToolSettingsPopup(\n      dataProvider,\n      location,\n      offset,\n      onCancel,\n      placement,\n      anchorElement\n    );\n  }\n\n  /** Closes the Tool Settings Ui popup. */\n  public override closeToolSettingsPopup(): boolean {\n    return UiFramework.closeToolSettingsPopup();\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    return UiFramework.openDialog(\n      uiDataProvider,\n      title,\n      isModal,\n      id,\n      optionalProps\n    );\n  }\n\n  /** Closes the Tool Settings Ui popup.*/\n  public override closeDialog(dialogId: string): boolean {\n    return UiFramework.closeDialog(dialogId);\n  }\n}\n\n// utility functions to wean off appui-abstract\nfunction AbstractToolbarPropsToToolbarProps(\n  props: AbstractToolbarProps\n): ToolbarProps {\n  return {\n    items: props.items.map(CommonToolbarItemToToolBarItem),\n    itemId: props.toolbarId,\n  };\n}\n\nfunction CommonToolbarItemToToolBarItem(item: CommonToolbarItem): ToolbarItem {\n  return {\n    ...item,\n    badge: item.badgeType,\n  };\n}\n\ninterface CardRendererProps {\n  content: HTMLElement;\n}\n\nfunction CardRenderer({ content }: CardRendererProps) {\n  const ref = React.useRef<HTMLDivElement>(null);\n\n  React.useEffect(() => {\n    const el = ref.current;\n    el?.appendChild(content);\n    return () => {\n      el?.removeChild(content);\n    };\n  }, [content]);\n\n  return <div ref={ref} />;\n}\n"]}

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

@@ -4,9 +4,10 @@
 import type { UiStateStorage } from "@itwin/core-react";
 import { UiStateEntry } from "@itwin/core-react";
 import type { UserSettingsProvider } from "../UiFramework";
-import type { ThemeId } from "../theme/ThemeManager";
+import type { ThemeId } from "../theme/ThemeId";
 /** Default values that may be specified for [[AppUiSettings]].
  * @public
+ * @deprecated in 4.15.0. Interface used in a deprecated class {@link AppUiSettings}.
  */
 export interface InitialAppUiSettings {
     colorTheme: ThemeId;
@@ -27,8 +28,8 @@ export interface InitialAppUiSettings {
  * ```ts
  * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));
  * ```
- *
  * @public
+ * @deprecated in 4.15.0. Use {@link @itwin/core-react#UiStateStorage} to persist UI settings.
  */
 export declare class AppUiSettings implements UserSettingsProvider {
     readonly providerId = "AppUiSettingsProvider";

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;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;IA+EnD,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,kBAAkB,CAAC;AAKhD;;;GAGG;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;IA+EnD,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,6 +8,7 @@
 import { UiStateEntry } from "@itwin/core-react";
 import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
 import { UiFramework } from "../UiFramework";
+import { ConfigurableUiActionId } from "../redux/ConfigurableUiState";
 /** 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
@@ -16,8 +17,8 @@ import { UiFramework } from "../UiFramework";
  * ```ts
  * UiFramework.registerUserSettingsProvider(new AppUiSettings(defaults));
  * ```
- *
  * @public
+ * @deprecated in 4.15.0. Use {@link @itwin/core-react#UiStateStorage} to persist UI settings.
  */
 export class AppUiSettings {
     constructor(defaults) {
@@ -33,24 +34,24 @@ export class AppUiSettings {
         this.handleSyncUiEvent = async (args) => {
             if (this._applyingLocalSettings)
                 return;
-            if (args.eventIds.has("configurableui:set_theme")) {
+            if (args.eventIds.has(ConfigurableUiActionId.SetTheme)) {
                 await this.colorTheme.saveSetting(UiFramework.getUiStateStorage());
                 // always store as default theme in local storage to avoid flicker during startup if user is not yet logged-in
                 window.localStorage.setItem("uifw:defaultTheme", UiFramework.getColorTheme());
             }
-            if (args.eventIds.has("configurableui:set-drag-interaction"))
+            if (args.eventIds.has(ConfigurableUiActionId.SetDragInteraction))
                 await this.dragInteraction.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-show-widget-icon"))
+            if (args.eventIds.has(ConfigurableUiActionId.SetShowWidgetIcon))
                 await this.showWidgetIcon.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-auto-collapse-unpinned-panels"))
+            if (args.eventIds.has(ConfigurableUiActionId.AutoCollapseUnpinnedPanels))
                 await this.autoCollapseUnpinnedPanels.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set_widget_opacity"))
+            if (args.eventIds.has(ConfigurableUiActionId.SetWidgetOpacity))
                 await this.widgetOpacity.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-animate-tool-settings"))
+            if (args.eventIds.has(ConfigurableUiActionId.AnimateToolSettings))
                 await this.animateToolSettings.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-use-tool-as-tool-settings-label"))
+            if (args.eventIds.has(ConfigurableUiActionId.UseToolAsToolSettingsLabel))
                 await this.useToolAsToolSettingsLabel.saveSetting(UiFramework.getUiStateStorage());
-            if (args.eventIds.has("configurableui:set-toolbar-opacity"))
+            if (args.eventIds.has(ConfigurableUiActionId.SetToolbarOpacity))
                 await this.toolbarOpacity.saveSetting(UiFramework.getUiStateStorage());
         };
         this._settings = [];