@itwin/appui-react 4.6.4 → 4.7.0

package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.js

@@ -15,6 +15,17 @@ const AbstractUiItemsManager_1 = require("./AbstractUiItemsManager");
  * @public
  */
 class UiItemsManager {
+    /** For use in unit testing
+     * @internal
+     */
+    static useAbstractAdapter(useAbstractAdapter) {
+        if (useAbstractAdapter) {
+            this._abstractAdapter = (0, AbstractUiItemsManager_1.createAbstractUiItemsManagerAdapter)();
+        }
+        else {
+            this._abstractAdapter = undefined;
+        }
+    }
     /** For use in unit testing
      * @internal */
     static clearAllProviders() {
@@ -56,6 +67,7 @@ class UiItemsManager {
     /**
      * Registers a UiItemsProvider with the UiItemsManager.
      * @param uiProvider the UI items provider to register.
+     * @param overrides the UI items provider to register.
      */
     static register(uiProvider, overrides) {
         if (this._abstractAdapter)
@@ -101,119 +113,122 @@ class UiItemsManager {
     }
     /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
      * an action or specify a registered ToolId into toolbar.
-     * @param stageId a string identifier the active stage.
+     * @param stageId a string identifier of the active stage.
      * @param stageUsage the StageUsage of the active stage.
      * @param usage usage of the toolbar
      * @param orientation orientation of the toolbar
      * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
      */
     static getToolbarButtonItems(stageId, stageUsage, usage, orientation) {
-        if (this._abstractAdapter)
+        if (this._abstractAdapter) {
             return this._abstractAdapter.getToolbarButtonItems(stageId, stageUsage, usage, orientation);
-        const buttonItems = [];
+        }
+        const items = [];
         UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            if (!this.allowItemsFromProvider(entry, stageId, stageUsage))
+                return;
             const uiProvider = entry.provider;
             const providerId = entry.overrides?.providerId ?? uiProvider.id;
-            // istanbul ignore else
-            if (uiProvider.provideToolbarItems &&
-                this.allowItemsFromProvider(entry, stageId, stageUsage)) {
-                uiProvider
-                    .provideToolbarItems(stageId, stageUsage, usage, orientation)
-                    .forEach((spec) => {
-                    // ignore duplicate ids
-                    if (-1 ===
-                        buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
-                        buttonItems.push({ ...spec, providerId });
-                });
-            }
+            const provider = (0, AbstractUiItemsManager_1.createGetPropertyAdapter)(uiProvider);
+            const providerItems = provider
+                .provideToolbarItems(stageId, stageUsage, usage, orientation)
+                .map((item) => ({
+                ...item,
+                providerId,
+            }));
+            items.push(...providerItems);
         });
-        return buttonItems;
+        return getUniqueItems(items);
     }
     /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
-     * @param stageId a string identifier the active stage.
+     * @param stageId a string identifier of the active stage.
      * @param stageUsage the StageUsage of the active stage.
      * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
      */
     static getStatusBarItems(stageId, stageUsage) {
-        if (this._abstractAdapter)
+        if (this._abstractAdapter) {
             return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);
-        const statusBarItems = [];
+        }
+        const items = [];
         UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            if (!this.allowItemsFromProvider(entry, stageId, stageUsage))
+                return;
             const uiProvider = entry.provider;
             const providerId = entry.overrides?.providerId ?? uiProvider.id;
-            // istanbul ignore else
-            if (uiProvider.provideStatusBarItems &&
-                this.allowItemsFromProvider(entry, stageId, stageUsage)) {
-                uiProvider
-                    .provideStatusBarItems(stageId, stageUsage)
-                    .forEach((item) => {
-                    // ignore duplicate ids
-                    if (-1 ===
-                        statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
-                        statusBarItems.push({ ...item, providerId });
-                });
-            }
+            const provider = (0, AbstractUiItemsManager_1.createGetPropertyAdapter)(uiProvider);
+            const providerItems = provider
+                .provideStatusBarItems(stageId, stageUsage)
+                .map((item) => ({
+                ...item,
+                providerId,
+            }));
+            items.push(...providerItems);
         });
-        return statusBarItems;
+        return getUniqueItems(items);
     }
     /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
      * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
      */
     static getBackstageItems() {
-        if (this._abstractAdapter)
+        if (this._abstractAdapter) {
             return this._abstractAdapter.getBackstageItems();
-        const backstageItems = [];
+        }
+        const items = [];
         UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
             const uiProvider = entry.provider;
             const providerId = entry.overrides?.providerId ?? uiProvider.id;
-            // istanbul ignore else
-            if (uiProvider.provideBackstageItems) {
-                // Note: We do not call this.allowItemsFromProvider here as backstage items
-                uiProvider
-                    .provideBackstageItems() //       should not be considered stage specific. If they need to be hidden
-                    .forEach((item) => {
-                    //       the isHidden property should be set to a ConditionalBooleanValue
-                    // ignore duplicate ids
-                    if (-1 ===
-                        backstageItems.findIndex((existingItem) => item.id === existingItem.id))
-                        backstageItems.push({ ...item, providerId });
-                });
-            }
+            const provider = (0, AbstractUiItemsManager_1.createGetPropertyAdapter)(uiProvider);
+            // Note: We do not call this.allowItemsFromProvider here as backstage items
+            // should not be considered stage specific.
+            const providerItems = provider.provideBackstageItems().map((item) => ({
+                ...item,
+                providerId,
+            }));
+            items.push(...providerItems);
         });
-        return backstageItems;
+        return getUniqueItems(items);
     }
     /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
-     * @param stageId a string identifier the active stage.
+     * @param stageId a string identifier of the active stage.
      * @param stageUsage the StageUsage of the active stage.
      * @param location the location within the stage.
      * @param section the section within location.
      * @returns An array of widgets.
      */
     static getWidgets(stageId, stageUsage, location, section) {
-        if (this._abstractAdapter)
-            return this._abstractAdapter.getWidgets(stageId, stageUsage, location, section);
-        const widgets = [];
+        const items = [];
+        if (this._abstractAdapter) {
+            const abstractWidgets = this._abstractAdapter.getWidgets(stageId, stageUsage, location, section);
+            items.push(...abstractWidgets);
+        }
         UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
             const uiProvider = entry.provider;
             const providerId = entry.overrides?.providerId ?? uiProvider.id;
-            // istanbul ignore else
-            if (uiProvider.provideWidgets &&
-                this.allowItemsFromProvider(entry, stageId, stageUsage)) {
-                uiProvider
-                    .provideWidgets(stageId, stageUsage, location, section)
-                    .forEach((widget) => {
-                    // ignore duplicate ids
-                    if (-1 ===
-                        widgets.findIndex((existingItem) => widget.id === existingItem.id))
-                        widgets.push({ ...widget, providerId });
-                });
-            }
+            if (!this.allowItemsFromProvider(entry, stageId, stageUsage))
+                return;
+            const provider = (0, AbstractUiItemsManager_1.createGetPropertyAdapter)(uiProvider);
+            const providerItems = provider
+                .provideWidgets(stageId, stageUsage, location, section)
+                .map((item) => ({
+                ...item,
+                providerId,
+            }));
+            items.push(...providerItems);
         });
-        return widgets;
+        return getUniqueItems(items);
     }
 }
 UiItemsManager._registeredUiItemsProviders = new Map();
 UiItemsManager._onUiProviderRegisteredEvent = new core_bentley_1.BeUiEvent();
 UiItemsManager._abstractAdapter = (0, AbstractUiItemsManager_1.createAbstractUiItemsManagerAdapter)();
 exports.UiItemsManager = UiItemsManager;
+function getUniqueItems(items) {
+    const uniqueItems = [];
+    items.forEach((item) => {
+        if (uniqueItems.find((existingItem) => item.id === existingItem.id))
+            return;
+        uniqueItems.push(item);
+    });
+    return uniqueItems;
+}
 //# sourceMappingURL=UiItemsManager.js.map

package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,sDAAwD;AAUxD,gDAA6C;AAI7C,qEAA+E;AA0C/E;;GAEG;AACH,MAAa,cAAc;IAOzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAE5E,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAED,wEAAwE;IACjE,MAAM,KAAK,2BAA2B;QAC3C,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,2BAA2B,CAAC;QAE3D,OAAO,IAAI,CAAC,4BAA4B,CAAC;IAC3C,CAAC;IAED,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;QAErD,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,CAAC;QAEtD,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAC9B,UAAkB;QAElB,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE9D,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,IAAwC;QACzE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CACpB,UAA2B,EAC3B,SAAoC;QAEpC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE/D,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,oBAAoB,UAAU,qBAAqB,CACpD,CAAC;SACH;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE;gBACzD,QAAQ,EAAE,UAAU;gBACpB,SAAS;aACV,CAAC,CAAC;YACH,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAChE,CAAC;YAEF,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;SACpD;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,UAAkB;QACzC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ;YAAE,OAAO;QAEtB,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC9D,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,oBAAoB,UAAU,YAAY,CAC3C,CAAC;QAEF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACrD,CAAC;IAEO,MAAM,CAAC,sBAAsB,CACnC,KAA0B,EAC1B,OAAgB,EAChB,UAAmB;QAEnB,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IACE,SAAS,KAAK,OAAO;YACrB,SAAS,EAAE,QAAQ;YACnB,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC;YAE9D,OAAO,KAAK,CAAC;QACf,IACE,SAAS,KAAK,UAAU;YACxB,SAAS,EAAE,WAAW;YACtB,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YAEpE,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CACjC,OAAe,EACf,UAAkB,EAClB,KAAmB,EACnB,WAA+B;QAE/B,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAChD,OAAO,EACP,UAAU,EACV,KAAK,EACL,WAAW,CACZ,CAAC;QAEJ,MAAM,WAAW,GAAgC,EAAE,CAAC;QAEpD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAChD,CAAC,KAA0B,EAAE,EAAE;YAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IACE,UAAU,CAAC,mBAAmB;gBAC9B,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EACvD;gBACA,UAAU;qBACP,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC;qBAC5D,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;oBAC7B,uBAAuB;oBACvB,IACE,CAAC,CAAC;wBACF,WAAW,CAAC,SAAS,CACnB,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAC9C;wBAED,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CACF,CAAC;QAEF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAC7B,OAAe,EACf,UAAkB;QAElB,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtE,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAChD,CAAC,KAA0B,EAAE,EAAE;YAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IACE,UAAU,CAAC,qBAAqB;gBAChC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EACvD;gBACA,UAAU;qBACP,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC;qBAC1C,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IACE,CAAC,CAAC;wBACF,cAAc,CAAC,SAAS,CACtB,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAC9C;wBAED,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CACF,CAAC;QAEF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAG7B,IAAI,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAE5E,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAChD,CAAC,KAA0B,EAAE,EAAE;YAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE;gBACpC,2EAA2E;gBAC3E,UAAU;qBACP,qBAAqB,EAAE,CAAC,2EAA2E;qBACnG,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,yEAAyE;oBACzE,uBAAuB;oBACvB,IACE,CAAC,CAAC;wBACF,cAAc,CAAC,SAAS,CACtB,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAC9C;wBAED,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CACF,CAAC;QAEF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CACtB,OAAe,EACf,UAAkB,EAClB,QAA4B,EAC5B,OAA2B;QAE3B,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CACrC,OAAO,EACP,UAAU,EACV,QAAQ,EACR,OAAO,CACR,CAAC;QAEJ,MAAM,OAAO,GAA2B,EAAE,CAAC;QAE3C,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IACE,UAAU,CAAC,cAAc;gBACzB,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EACvD;gBACA,UAAU;qBACP,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC;qBACtD,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBAClB,uBAAuB;oBACvB,IACE,CAAC,CAAC;wBACF,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAElE,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;;AArTc,0CAA2B,GACxC,IAAI,GAAG,EAA+B,CAAC;AAC1B,2CAA4B,GACzC,IAAI,wBAAS,EAAsC,CAAC;AACvC,+BAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;AAL7D,wCAAc","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 { MarkRequired } from \"@itwin/core-bentley\";\nimport { BeUiEvent, Logger } from \"@itwin/core-bentley\";\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 { UiFramework } from \"../UiFramework\";\nimport type { Widget } from \"../widgets/Widget\";\nimport type { ProviderItem } from \"./ProviderItem\";\nimport type { UiItemsProvider } from \"./UiItemsProvider\";\nimport { createAbstractUiItemsManagerAdapter } from \"./AbstractUiItemsManager\";\n\n/** UiItemsProvider register event args.\n * @public\n */\nexport interface UiItemsProviderRegisteredEventArgs {\n  providerId: string;\n}\n\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\n * @public\n */\nexport interface AllowedUiItemsProviderOverrides {\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */\n  providerId?: string;\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided */\n  stageUsages?: string[];\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided */\n  stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n * @public\n */\nexport type UiItemsProviderOverrides =\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\">\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageIds\">\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"stageIds\">\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"stageUsages\">\n  | MarkRequired<\n      AllowedUiItemsProviderOverrides,\n      \"providerId\" | \"stageUsages\" | \"stageIds\"\n    >;\n\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\ninterface UiItemProviderEntry {\n  provider: UiItemsProvider;\n  overrides?: UiItemsProviderOverrides;\n}\n\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\n * @public\n */\nexport class UiItemsManager {\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> =\n    new Map<string, UiItemProviderEntry>();\n  private static _onUiProviderRegisteredEvent =\n    new BeUiEvent<UiItemsProviderRegisteredEventArgs>();\n  private static _abstractAdapter = createAbstractUiItemsManagerAdapter();\n\n  /** For use in unit testing\n   * @internal */\n  public static clearAllProviders() {\n    if (this._abstractAdapter) return this._abstractAdapter.clearAllProviders();\n\n    UiItemsManager._registeredUiItemsProviders.clear();\n  }\n\n  /** Event raised any time a UiProvider is registered or unregistered. */\n  public static get onUiProviderRegisteredEvent(): BeUiEvent<UiItemsProviderRegisteredEventArgs> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.onUiProviderRegisteredEvent;\n\n    return this._onUiProviderRegisteredEvent;\n  }\n\n  /** Return number of registered UiProvider. */\n  public static get registeredProviderIds(): string[] {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.registeredProviderIds;\n\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n    return ids;\n  }\n\n  /** Return true if there is any registered UiProvider. */\n  public static get hasRegisteredProviders(): boolean {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.hasRegisteredProviders;\n\n    return this._registeredUiItemsProviders.size > 0;\n  }\n\n  /**\n   * Retrieves a previously loaded UiItemsProvider.\n   * @param providerId id of the UiItemsProvider to get\n   */\n  public static getUiItemsProvider(\n    providerId: string\n  ): UiItemsProvider | undefined {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getUiItemsProvider(providerId);\n\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n  }\n\n  private static sendRegisteredEvent(args: UiItemsProviderRegisteredEventArgs) {\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);\n  }\n\n  /**\n   * Registers a UiItemsProvider with the UiItemsManager.\n   * @param uiProvider the UI items provider to register.\n   */\n  public static register(\n    uiProvider: UiItemsProvider,\n    overrides?: UiItemsProviderOverrides\n  ): void {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.register(uiProvider, overrides);\n\n    const providerId = overrides?.providerId ?? uiProvider.id;\n\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `UiItemsProvider (${providerId}) is already loaded`\n      );\n    } else {\n      UiItemsManager._registeredUiItemsProviders.set(providerId, {\n        provider: uiProvider,\n        overrides,\n      });\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `UiItemsProvider ${uiProvider.id} registered as ${providerId} `\n      );\n\n      UiItemsManager.sendRegisteredEvent({ providerId });\n    }\n  }\n\n  /** Remove a specific UiItemsProvider from the list of available providers. */\n  public static unregister(providerId: string): void {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.unregister(providerId);\n\n    const provider = UiItemsManager.getUiItemsProvider(providerId);\n    if (!provider) return;\n\n    provider.onUnregister && provider.onUnregister();\n\n    UiItemsManager._registeredUiItemsProviders.delete(providerId);\n    Logger.logInfo(\n      UiFramework.loggerCategory(this),\n      `UiItemsProvider (${providerId}) unloaded`\n    );\n\n    // trigger a refresh of the ui\n    UiItemsManager.sendRegisteredEvent({ providerId });\n  }\n\n  private static allowItemsFromProvider(\n    entry: UiItemProviderEntry,\n    stageId?: string,\n    stageUsage?: string\n  ) {\n    // istanbul ignore else\n    const overrides = entry.overrides;\n    if (\n      undefined !== stageId &&\n      overrides?.stageIds &&\n      !overrides.stageIds.some((value: string) => value === stageId)\n    )\n      return false;\n    if (\n      undefined !== stageUsage &&\n      overrides?.stageUsages &&\n      !overrides.stageUsages.some((value: string) => value === stageUsage)\n    )\n      return false;\n    return true;\n  }\n\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n   * an action or specify a registered ToolId into toolbar.\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param usage usage of the toolbar\n   * @param orientation orientation of the toolbar\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\n   */\n  public static getToolbarButtonItems(\n    stageId: string,\n    stageUsage: string,\n    usage: ToolbarUsage,\n    orientation: ToolbarOrientation\n  ): ReadonlyArray<ProviderItem<ToolbarItem>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getToolbarButtonItems(\n        stageId,\n        stageUsage,\n        usage,\n        orientation\n      );\n\n    const buttonItems: ProviderItem<ToolbarItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach(\n      (entry: UiItemProviderEntry) => {\n        const uiProvider = entry.provider;\n        const providerId = entry.overrides?.providerId ?? uiProvider.id;\n        // istanbul ignore else\n        if (\n          uiProvider.provideToolbarItems &&\n          this.allowItemsFromProvider(entry, stageId, stageUsage)\n        ) {\n          uiProvider\n            .provideToolbarItems(stageId, stageUsage, usage, orientation)\n            .forEach((spec: ToolbarItem) => {\n              // ignore duplicate ids\n              if (\n                -1 ===\n                buttonItems.findIndex(\n                  (existingItem) => spec.id === existingItem.id\n                )\n              )\n                buttonItems.push({ ...spec, providerId });\n            });\n        }\n      }\n    );\n\n    return buttonItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n   */\n  public static getStatusBarItems(\n    stageId: string,\n    stageUsage: string\n  ): ReadonlyArray<ProviderItem<StatusBarItem>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);\n\n    const statusBarItems: ProviderItem<StatusBarItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach(\n      (entry: UiItemProviderEntry) => {\n        const uiProvider = entry.provider;\n        const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n        // istanbul ignore else\n        if (\n          uiProvider.provideStatusBarItems &&\n          this.allowItemsFromProvider(entry, stageId, stageUsage)\n        ) {\n          uiProvider\n            .provideStatusBarItems(stageId, stageUsage)\n            .forEach((item: StatusBarItem) => {\n              // ignore duplicate ids\n              if (\n                -1 ===\n                statusBarItems.findIndex(\n                  (existingItem) => item.id === existingItem.id\n                )\n              )\n                statusBarItems.push({ ...item, providerId });\n            });\n        }\n      }\n    );\n\n    return statusBarItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n   */\n  public static getBackstageItems(): ReadonlyArray<\n    ProviderItem<BackstageItem>\n  > {\n    if (this._abstractAdapter) return this._abstractAdapter.getBackstageItems();\n\n    const backstageItems: ProviderItem<BackstageItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach(\n      (entry: UiItemProviderEntry) => {\n        const uiProvider = entry.provider;\n        const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n        // istanbul ignore else\n        if (uiProvider.provideBackstageItems) {\n          // Note: We do not call this.allowItemsFromProvider here as backstage items\n          uiProvider\n            .provideBackstageItems() //       should not be considered stage specific. If they need to be hidden\n            .forEach((item: BackstageItem) => {\n              //       the isHidden property should be set to a ConditionalBooleanValue\n              // ignore duplicate ids\n              if (\n                -1 ===\n                backstageItems.findIndex(\n                  (existingItem) => item.id === existingItem.id\n                )\n              )\n                backstageItems.push({ ...item, providerId });\n            });\n        }\n      }\n    );\n\n    return backstageItems;\n  }\n\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param location the location within the stage.\n   * @param section the section within location.\n   * @returns An array of widgets.\n   */\n  public static getWidgets(\n    stageId: string,\n    stageUsage: string,\n    location: StagePanelLocation,\n    section?: StagePanelSection\n  ): ReadonlyArray<ProviderItem<Widget>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getWidgets(\n        stageId,\n        stageUsage,\n        location,\n        section\n      );\n\n    const widgets: ProviderItem<Widget>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (\n        uiProvider.provideWidgets &&\n        this.allowItemsFromProvider(entry, stageId, stageUsage)\n      ) {\n        uiProvider\n          .provideWidgets(stageId, stageUsage, location, section)\n          .forEach((widget) => {\n            // ignore duplicate ids\n            if (\n              -1 ===\n              widgets.findIndex((existingItem) => widget.id === existingItem.id)\n            )\n              widgets.push({ ...widget, providerId });\n          });\n      }\n    });\n\n    return widgets;\n  }\n}\n"]}
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,sDAAwD;AAOxD,gDAA6C;AAI7C,qEAGkC;AA0ClC;;GAEG;AACH,MAAa,cAAc;IAOzB;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,kBAA2B;QAC1D,IAAI,kBAAkB,EAAE;YACtB,IAAI,CAAC,gBAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;SAC/D;aAAM;YACL,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SACnC;IACH,CAAC;IAED;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAE5E,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAED,wEAAwE;IACjE,MAAM,KAAK,2BAA2B;QAC3C,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,2BAA2B,CAAC;QAE3D,OAAO,IAAI,CAAC,4BAA4B,CAAC;IAC3C,CAAC;IAED,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;QAErD,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,CAAC;QAEtD,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAC9B,UAAkB;QAElB,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE9D,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,IAAwC;QACzE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CACpB,UAA2B,EAC3B,SAAoC;QAEpC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE/D,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,oBAAoB,UAAU,qBAAqB,CACpD,CAAC;SACH;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE;gBACzD,QAAQ,EAAE,UAAU;gBACpB,SAAS;aACV,CAAC,CAAC;YACH,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAChE,CAAC;YAEF,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;SACpD;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,UAAkB;QACzC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ;YAAE,OAAO;QAEtB,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC9D,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,oBAAoB,UAAU,YAAY,CAC3C,CAAC;QAEF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACrD,CAAC;IAEO,MAAM,CAAC,sBAAsB,CACnC,KAA0B,EAC1B,OAAgB,EAChB,UAAmB;QAEnB,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IACE,SAAS,KAAK,OAAO;YACrB,SAAS,EAAE,QAAQ;YACnB,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC;YAE9D,OAAO,KAAK,CAAC;QACf,IACE,SAAS,KAAK,UAAU;YACxB,SAAS,EAAE,WAAW;YACtB,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YAEpE,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CACjC,OAAe,EACf,UAAkB,EAClB,KAAmB,EACnB,WAA+B;QAE/B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAChD,OAAO,EACP,UAAU,EACV,KAAK,EACL,WAAW,CACZ,CAAC;SACH;QAED,MAAM,KAAK,GAAgC,EAAE,CAAC;QAC9C,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC;gBAAE,OAAO;YAErE,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,MAAM,QAAQ,GAAG,IAAA,iDAAwB,EAAC,UAAU,CAAC,CAAC;YACtD,MAAM,aAAa,GAAG,QAAQ;iBAC3B,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC;iBAC5D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACd,GAAG,IAAI;gBACP,UAAU;aACX,CAAC,CAAC,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAC7B,OAAe,EACf,UAAkB;QAElB,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SACrE;QAED,MAAM,KAAK,GAAkC,EAAE,CAAC;QAChD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC;gBAAE,OAAO;YAErE,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,MAAM,QAAQ,GAAG,IAAA,iDAAwB,EAAC,UAAU,CAAC,CAAC;YAEtD,MAAM,aAAa,GAAG,QAAQ;iBAC3B,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC;iBAC1C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACd,GAAG,IAAI;gBACP,UAAU;aACX,CAAC,CAAC,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAG7B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;SAClD;QAED,MAAM,KAAK,GAAkC,EAAE,CAAC;QAChD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,MAAM,QAAQ,GAAG,IAAA,iDAAwB,EAAC,UAAU,CAAC,CAAC;YACtD,2EAA2E;YAC3E,2CAA2C;YAC3C,MAAM,aAAa,GAAG,QAAQ,CAAC,qBAAqB,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACpE,GAAG,IAAI;gBACP,UAAU;aACX,CAAC,CAAC,CAAC;YACJ,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CACtB,OAAe,EACf,UAAkB,EAClB,QAA4B,EAC5B,OAA2B;QAE3B,MAAM,KAAK,GAA2B,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CACtD,OAAO,EACP,UAAU,EACV,QAAQ,EACR,OAAO,CACR,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;SAChC;QAED,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC;gBAAE,OAAO;YAErE,MAAM,QAAQ,GAAG,IAAA,iDAAwB,EAAC,UAAU,CAAC,CAAC;YACtD,MAAM,aAAa,GAAG,QAAQ;iBAC3B,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC;iBACtD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACd,GAAG,IAAI;gBACP,UAAU;aACX,CAAC,CAAC,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;;AA5Rc,0CAA2B,GACxC,IAAI,GAAG,EAA+B,CAAC;AAC1B,2CAA4B,GACzC,IAAI,wBAAS,EAAsC,CAAC;AACvC,+BAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;AAL7D,wCAAc;AAgS3B,SAAS,cAAc,CAA2B,KAAmB;IACnE,MAAM,WAAW,GAAQ,EAAE,CAAC;IAC5B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;YAAE,OAAO;QAC5E,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACrB,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 UiProvider\n */\n\nimport type { MarkRequired } from \"@itwin/core-bentley\";\nimport { BeUiEvent, Logger } from \"@itwin/core-bentley\";\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 { ToolbarItem } from \"../toolbar/ToolbarItem\";\nimport type { ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { Widget } from \"../widgets/Widget\";\nimport type { ProviderItem } from \"./ProviderItem\";\nimport type { UiItemsProvider } from \"./UiItemsProvider\";\nimport {\n  createAbstractUiItemsManagerAdapter,\n  createGetPropertyAdapter,\n} from \"./AbstractUiItemsManager\";\n\n/** UiItemsProvider register event args.\n * @public\n */\nexport interface UiItemsProviderRegisteredEventArgs {\n  providerId: string;\n}\n\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\n * @public\n */\nexport interface AllowedUiItemsProviderOverrides {\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */\n  providerId?: string;\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided */\n  stageUsages?: string[];\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided */\n  stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n * @public\n */\nexport type UiItemsProviderOverrides =\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\">\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageIds\">\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"stageIds\">\n  | MarkRequired<AllowedUiItemsProviderOverrides, \"stageUsages\">\n  | MarkRequired<\n      AllowedUiItemsProviderOverrides,\n      \"providerId\" | \"stageUsages\" | \"stageIds\"\n    >;\n\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\ninterface UiItemProviderEntry {\n  provider: UiItemsProvider;\n  overrides?: UiItemsProviderOverrides;\n}\n\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\n * @public\n */\nexport class UiItemsManager {\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> =\n    new Map<string, UiItemProviderEntry>();\n  private static _onUiProviderRegisteredEvent =\n    new BeUiEvent<UiItemsProviderRegisteredEventArgs>();\n  private static _abstractAdapter = createAbstractUiItemsManagerAdapter();\n\n  /** For use in unit testing\n   * @internal\n   */\n  public static useAbstractAdapter(useAbstractAdapter: boolean) {\n    if (useAbstractAdapter) {\n      this._abstractAdapter = createAbstractUiItemsManagerAdapter();\n    } else {\n      this._abstractAdapter = undefined;\n    }\n  }\n\n  /** For use in unit testing\n   * @internal */\n  public static clearAllProviders() {\n    if (this._abstractAdapter) return this._abstractAdapter.clearAllProviders();\n\n    UiItemsManager._registeredUiItemsProviders.clear();\n  }\n\n  /** Event raised any time a UiProvider is registered or unregistered. */\n  public static get onUiProviderRegisteredEvent(): BeUiEvent<UiItemsProviderRegisteredEventArgs> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.onUiProviderRegisteredEvent;\n\n    return this._onUiProviderRegisteredEvent;\n  }\n\n  /** Return number of registered UiProvider. */\n  public static get registeredProviderIds(): string[] {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.registeredProviderIds;\n\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n    return ids;\n  }\n\n  /** Return true if there is any registered UiProvider. */\n  public static get hasRegisteredProviders(): boolean {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.hasRegisteredProviders;\n\n    return this._registeredUiItemsProviders.size > 0;\n  }\n\n  /**\n   * Retrieves a previously loaded UiItemsProvider.\n   * @param providerId id of the UiItemsProvider to get\n   */\n  public static getUiItemsProvider(\n    providerId: string\n  ): UiItemsProvider | undefined {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getUiItemsProvider(providerId);\n\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n  }\n\n  private static sendRegisteredEvent(args: UiItemsProviderRegisteredEventArgs) {\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);\n  }\n\n  /**\n   * Registers a UiItemsProvider with the UiItemsManager.\n   * @param uiProvider the UI items provider to register.\n   * @param overrides the UI items provider to register.\n   */\n  public static register(\n    uiProvider: UiItemsProvider,\n    overrides?: UiItemsProviderOverrides\n  ): void {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.register(uiProvider, overrides);\n\n    const providerId = overrides?.providerId ?? uiProvider.id;\n\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `UiItemsProvider (${providerId}) is already loaded`\n      );\n    } else {\n      UiItemsManager._registeredUiItemsProviders.set(providerId, {\n        provider: uiProvider,\n        overrides,\n      });\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `UiItemsProvider ${uiProvider.id} registered as ${providerId} `\n      );\n\n      UiItemsManager.sendRegisteredEvent({ providerId });\n    }\n  }\n\n  /** Remove a specific UiItemsProvider from the list of available providers. */\n  public static unregister(providerId: string): void {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.unregister(providerId);\n\n    const provider = UiItemsManager.getUiItemsProvider(providerId);\n    if (!provider) return;\n\n    provider.onUnregister && provider.onUnregister();\n\n    UiItemsManager._registeredUiItemsProviders.delete(providerId);\n    Logger.logInfo(\n      UiFramework.loggerCategory(this),\n      `UiItemsProvider (${providerId}) unloaded`\n    );\n\n    // trigger a refresh of the ui\n    UiItemsManager.sendRegisteredEvent({ providerId });\n  }\n\n  private static allowItemsFromProvider(\n    entry: UiItemProviderEntry,\n    stageId?: string,\n    stageUsage?: string\n  ) {\n    // istanbul ignore else\n    const overrides = entry.overrides;\n    if (\n      undefined !== stageId &&\n      overrides?.stageIds &&\n      !overrides.stageIds.some((value: string) => value === stageId)\n    )\n      return false;\n    if (\n      undefined !== stageUsage &&\n      overrides?.stageUsages &&\n      !overrides.stageUsages.some((value: string) => value === stageUsage)\n    )\n      return false;\n    return true;\n  }\n\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n   * an action or specify a registered ToolId into toolbar.\n   * @param stageId a string identifier of the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param usage usage of the toolbar\n   * @param orientation orientation of the toolbar\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\n   */\n  public static getToolbarButtonItems(\n    stageId: string,\n    stageUsage: string,\n    usage: ToolbarUsage,\n    orientation: ToolbarOrientation\n  ): ReadonlyArray<ProviderItem<ToolbarItem>> {\n    if (this._abstractAdapter) {\n      return this._abstractAdapter.getToolbarButtonItems(\n        stageId,\n        stageUsage,\n        usage,\n        orientation\n      );\n    }\n\n    const items: ProviderItem<ToolbarItem>[] = [];\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      if (!this.allowItemsFromProvider(entry, stageId, stageUsage)) return;\n\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      const provider = createGetPropertyAdapter(uiProvider);\n      const providerItems = provider\n        .provideToolbarItems(stageId, stageUsage, usage, orientation)\n        .map((item) => ({\n          ...item,\n          providerId,\n        }));\n      items.push(...providerItems);\n    });\n\n    return getUniqueItems(items);\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @param stageId a string identifier of the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n   */\n  public static getStatusBarItems(\n    stageId: string,\n    stageUsage: string\n  ): ReadonlyArray<ProviderItem<StatusBarItem>> {\n    if (this._abstractAdapter) {\n      return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);\n    }\n\n    const items: ProviderItem<StatusBarItem>[] = [];\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      if (!this.allowItemsFromProvider(entry, stageId, stageUsage)) return;\n\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      const provider = createGetPropertyAdapter(uiProvider);\n\n      const providerItems = provider\n        .provideStatusBarItems(stageId, stageUsage)\n        .map((item) => ({\n          ...item,\n          providerId,\n        }));\n      items.push(...providerItems);\n    });\n\n    return getUniqueItems(items);\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n   */\n  public static getBackstageItems(): ReadonlyArray<\n    ProviderItem<BackstageItem>\n  > {\n    if (this._abstractAdapter) {\n      return this._abstractAdapter.getBackstageItems();\n    }\n\n    const items: ProviderItem<BackstageItem>[] = [];\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      const provider = createGetPropertyAdapter(uiProvider);\n      // Note: We do not call this.allowItemsFromProvider here as backstage items\n      // should not be considered stage specific.\n      const providerItems = provider.provideBackstageItems().map((item) => ({\n        ...item,\n        providerId,\n      }));\n      items.push(...providerItems);\n    });\n\n    return getUniqueItems(items);\n  }\n\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n   * @param stageId a string identifier of the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param location the location within the stage.\n   * @param section the section within location.\n   * @returns An array of widgets.\n   */\n  public static getWidgets(\n    stageId: string,\n    stageUsage: string,\n    location: StagePanelLocation,\n    section?: StagePanelSection\n  ): ReadonlyArray<ProviderItem<Widget>> {\n    const items: ProviderItem<Widget>[] = [];\n    if (this._abstractAdapter) {\n      const abstractWidgets = this._abstractAdapter.getWidgets(\n        stageId,\n        stageUsage,\n        location,\n        section\n      );\n      items.push(...abstractWidgets);\n    }\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      if (!this.allowItemsFromProvider(entry, stageId, stageUsage)) return;\n\n      const provider = createGetPropertyAdapter(uiProvider);\n      const providerItems = provider\n        .provideWidgets(stageId, stageUsage, location, section)\n        .map((item) => ({\n          ...item,\n          providerId,\n        }));\n      items.push(...providerItems);\n    });\n\n    return getUniqueItems(items);\n  }\n}\n\nfunction getUniqueItems<T extends { id: string }>(items: readonly T[]) {\n  const uniqueItems: T[] = [];\n  items.forEach((item) => {\n    if (uniqueItems.find((existingItem) => item.id === existingItem.id)) return;\n    uniqueItems.push(item);\n  });\n  return uniqueItems;\n}\n"]}

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

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

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

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

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

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

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

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

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

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

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

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

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