npm - @itwin/appui-react - Versions diffs - 4.14.0 → 4.15.0 - Mend

@itwin/appui-react 4.14.0 → 4.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1247) hide show

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

	@@ -1 +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;AAOxD,gDAA6C;AAI7C,qEAGkC;AA2ClC;;GAEG;AACH,MAAa,cAAc;IAOzB;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,kBAA2B;QAC1D,IAAI,kBAAkB,EAAE,CAAC;YACvB,IAAI,CAAC,gBAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QACpC,CAAC;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;IACxE,mDAAmD;IAC5C,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;IAED,mDAAmD;IAC3C,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,CAAC;YAClD,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,oBAAoB,UAAU,qBAAqB,CACpD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,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;QACrD,CAAC;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,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,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAChD,OAAO,EACP,UAAU,EACV,KAAK,EACL,WAAW,CACZ,CAAC;QACJ,CAAC;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,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACtE,CAAC;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,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QACnD,CAAC;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,CAAC;YAC1B,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;QACjC,CAAC;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;;AA9RH,wCA+RC;AA9RgB,0CAA2B,GACxC,IAAI,GAAG,EAA+B,CAAC;AAC1B,2CAA4B,GACzC,IAAI,wBAAS,EAAsC,CAAC,CAAC,8CAA8C;AACtF,+BAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;AA4R1E,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 * @deprecated in 4.13.x. Event args are inferred from a listener. If explicit type is needed use a type helper.\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>(); // eslint-disable-line deprecation/deprecation\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 // eslint-disable-next-line deprecation/deprecation\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 // eslint-disable-next-line deprecation/deprecation\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 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"]}
1	+ {"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;AA2ClC;;GAEG;AACH,MAAa,cAAc;IAOzB;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,kBAA2B;QAC1D,IAAI,kBAAkB,EAAE,CAAC;YACvB,IAAI,CAAC,gBAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QACpC,CAAC;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;IACxE,mDAAmD;IAC5C,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;IAED,mDAAmD;IAC3C,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,CAAC;YAClD,qBAAM,CAAC,OAAO,CACZ,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,oBAAoB,UAAU,qBAAqB,CACpD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,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;QACrD,CAAC;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,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,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAChD,OAAO,EACP,UAAU,EACV,KAAK,EACL,WAAW,CACZ,CAAC;QACJ,CAAC;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,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACtE,CAAC;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,CAAC;YAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QACnD,CAAC;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,CAAC;YAC1B,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;QACjC,CAAC;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;;AA9RH,wCA+RC;AA9RgB,0CAA2B,GACxC,IAAI,GAAG,EAA+B,CAAC;AAC1B,2CAA4B,GACzC,IAAI,wBAAS,EAAsC,CAAC,CAAC,8CAA8C;AACtF,+BAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;AA4R1E,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 * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.\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>(); // eslint-disable-line deprecation/deprecation\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 // eslint-disable-next-line deprecation/deprecation\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 // eslint-disable-next-line deprecation/deprecation\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 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 CHANGED Viewed

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

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

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

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

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

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

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

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

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

package/lib/cjs/appui-react/uiadmin/FrameworkUiAdmin.js.map CHANGED Viewed

	@@ -1 +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,mEAAgE;AAChE,wDAAqD;AACrD,gDAA6C;AAE7C,6CAG0B;AAC1B,kDAAoD;AAKpD;;;;;;;;;;GAUG;AACH,MAAa,gBAAiB,SAAQ,wBAAO;IAA7C;;QACU,8BAAyB,GAC/B,+BAAsB,CAAC,YAAY,CAAC;IAuexC,CAAC;IAreC;;OAEG;IACH,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAED,IAAW,wBAAwB,CAAC,UAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,IAAoB,cAAc;QAChC,OAAO,qCAAiB,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAoB,aAAa;QAC/B,OAAO,yBAAW,CAAC,iBAAiB,CAAC,aAAa,CAAC;IACrD,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,yBAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACa,eAAe,CAC7B,KAA8B,EAC9B,QAAe,EACf,WAAyB;QAEzB,OAAO,yBAAW,CAAC,eAAe,CAChC,KAA8B,EAC9B,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,KAAK,GAAG,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACa,gBAAgB,CAAC,WAAyB;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,MAAM,KAAK,GAAG,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;QAE5C,OAAO,yBAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACa,gBAAgB;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,OAAO,yBAAW,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACa,WAAW,CACzB,YAAkC,EAClC,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,WAAyB;QAEzB,MAAM,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QAEnD,OAAO,yBAAW,CAAC,WAAW,CAC5B,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,WAAW;QACzB,OAAO,yBAAW,CAAC,WAAW,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACa,cAAc,CAC5B,EAAU,EACV,cAAuC,EACvC,QAAe,EACf,WAAyB;QAEzB,OAAO,yBAAW,CAAC,cAAc,CAC/B,EAAE,EACF,cAAuC,EACvC,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACa,cAAc,CAAC,EAAU;QACvC,OAAO,yBAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACa,cAAc,CAC5B,YAAoB,EACpB,UAAkB,EAClB,QAAe,EACf,IAAwB,EACxB,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,cAAc,CAC/B,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,OAAO,yBAAW,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,eAAe,CAChC,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAA8B,EAC9B,mBAAwC,EACxC,QAAe,EACf,QAA2B,EAC3B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,eAAe,CAAC;YACjC,YAAY;YACZ,mBAAmB;YACnB,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,aAAa,EAAE,WAAW;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IACb,eAAe;QAC7B,OAAO,yBAAW,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACa,eAAe,CAC7B,cAA2B,EAC3B,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,GAAG,aAAa,IAAI,yBAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAErE,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;;;OAGG;IACa,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,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,yBAAW,CAAC,QAAQ,CACzB,oBAAC,YAAY,IAAC,OAAO,EAAE,OAAO,GAAI,EAClC,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAwB,EACxB,KAA0C,EAC1C,YAA8C,EAC9C,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,yBAAW,CAAC,QAAQ,CACzB,OAAO,EACP,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;SAEK;IACW,QAAQ;QACtB,OAAO,yBAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAsC,EACtC,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,yBAAW,CAAC,qBAAqB,CACtC,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzB,sBAAsB;QACpC,OAAO,yBAAW,CAAC,sBAAsB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACa,UAAU,CACxB,cAAwC,EACxC,KAAa,EACb,OAAgB,EAChB,EAAU,EACV,aAA2B;QAE3B,OAAO,yBAAW,CAAC,UAAU,CAC3B,cAAc,EACd,KAAK,EACL,OAAO,EACP,EAAE,EACF,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxB,WAAW,CAAC,QAAgB;QAC1C,OAAO,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;CACF;AAzeD,4CAyeC;AAED,+CAA+C;AAC/C,SAAS,kCAAkC,CACzC,KAA2B;IAE3B,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,CAAC;QACtD,MAAM,EAAE,KAAK,CAAC,SAAS;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAuB;IAC7D,OAAO;QACL,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,SAAS;KACtB,CAAC;AACJ,CAAC;AAMD,SAAS,YAAY,CAAC,EAAE,OAAO,EAAqB;IAClD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QACvB,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO,6BAAK,GAAG,EAAE,GAAG,GAAI,CAAC;AAC3B,CAAC","sourcesContent":["/---------------------------------------------------------------------------------------------\n Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n --------------------------------------------------------------------------------------------/\n/** @packageDocumentation\n * @module Admin\n /\n\nimport as React from \"react\";\nimport type { XAndY } from \"@itwin/core-geometry\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport type {\n AbstractMenuItemProps,\n AbstractToolbarProps,\n CommonToolbarItem,\n DialogLayoutDataProvider,\n DialogProps,\n OnCancelFunc,\n OnItemExecutedFunc,\n OnNumberCommitFunc,\n OnValueCommitFunc,\n Primitives,\n PropertyDescription,\n PropertyRecord,\n} from \"@itwin/appui-abstract\";\nimport { RelativePosition, UiAdmin } from \"@itwin/appui-abstract\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport { PopupManager } from \"../popup/PopupManager\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { KeyinEntry } from \"../keyins/Keyins\";\nimport {\n getKeyinsFromToolList,\n KeyinFieldLocalization,\n} from \"../keyins/Keyins\";\nimport { mapToPlacement } from \"../utils/Placement\";\nimport type { ToolbarProps } from \"../toolbar/Toolbar\";\nimport type { ToolbarItem } from \"../toolbar/ToolbarItem\";\nimport type { CursorMenuItemProps } from \"../shared/MenuItem\";\n\n/** Subclass of `UiAdmin` in `@itwin/core-frontend` to be used to initialize `IModelApp`.\n \n This implementation uses themed react components that blends in AppUI look and feel.\n \n ```ts\n * await IModelApp.startup({\n * uiAdmin: new FrameworkUiAdmin()\n * });\n * ```\n * @public\n /\nexport class FrameworkUiAdmin extends UiAdmin {\n private _localizedKeyinPreference: KeyinFieldLocalization =\n KeyinFieldLocalization.NonLocalized;\n\n /\n @deprecated in 4.11.x. Gathering and filtering of keyins is now left up to the user.\n /\n public get localizedKeyinPreference(): KeyinFieldLocalization {\n return this._localizedKeyinPreference;\n }\n\n public set localizedKeyinPreference(preference: KeyinFieldLocalization) {\n this._localizedKeyinPreference = preference;\n }\n\n /* Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY.\n * @deprecated in 4.11.x. Please use {@link CursorInformation.cursorPosition}\n /\n public override get cursorPosition(): XAndY {\n return CursorInformation.cursorPosition;\n }\n\n /* Determines if focus is set to Home\n * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}\n /\n public override get isFocusOnHome(): boolean {\n return UiFramework.keyboardShortcuts.isFocusOnHome;\n }\n\n /* Sets focus to Home\n * @deprecated in 4.11.x. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}\n /\n public override setFocusToHome(): void {\n UiFramework.keyboardShortcuts.setFocusToHome();\n }\n\n /* Show a context menu at a particular location.\n * @param items Properties of the menu items to display.\n * @param location Location of the context menu, relative to the origin of htmlElement or the overall window.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.openContextMenu}\n /\n public override showContextMenu(\n items: AbstractMenuItemProps[],\n location: XAndY,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.openContextMenu(\n items as CursorMenuItemProps[],\n location,\n htmlElement\n );\n }\n\n /\n @deprecated in 4.11.x. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.\n /\n public getKeyins(): KeyinEntry[] {\n const tools = IModelApp.tools.getToolList();\n return getKeyinsFromToolList(tools);\n }\n\n /* Show the Key-in Palette to display key-in from all registered Tools.\n * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.\n * @return true if the Command Palette was displayed, false if it could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.\n /\n public override showKeyinPalette(htmlElement?: HTMLElement): boolean {\n if (!this.featureFlags.allowKeyinPalette) return false;\n\n const tools = IModelApp.tools.getToolList();\n const keyIns = getKeyinsFromToolList(tools);\n\n return UiFramework.showKeyinPalette(keyIns, htmlElement);\n }\n\n /\n Hides the Key-in Palette.\n * @deprecated in 4.11.x. Use {@link UiFramework.hideKeyinPalette}\n /\n public override hideKeyinPalette(): boolean {\n if (!this.featureFlags.allowKeyinPalette) return false;\n\n return UiFramework.hideKeyinPalette();\n }\n\n /* Show a Toolbar at a particular location.\n * @param toolbarProps Properties of the Toolbar to display.\n * @param location Location of the Toolbar, relative to the origin of htmlElement or the overall window.\n * @param offset Offset of the Toolbar from the location.\n * @param onItemExecuted Function invoked after a Toolbar item is executed\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\n * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\n * @deprecated in 4.11.x. Please use {@link UiFramework.showToolbar}.\n /\n public override showToolbar(\n toolbarProps: AbstractToolbarProps,\n location: XAndY,\n offset: XAndY,\n onItemExecuted: OnItemExecutedFunc,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n htmlElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n\n return UiFramework.showToolbar(\n toolbarProps,\n location,\n offset,\n onItemExecuted,\n onCancel,\n placement,\n htmlElement\n );\n }\n\n /* Hides the toolbar.\n * @deprecated in 4.11.x. Please use {@link UiFramework.hideToolbar}.\n /\n public override hideToolbar(): boolean {\n return UiFramework.hideToolbar();\n }\n\n /* Show a menu button at a particular location. A menu button opens a context menu.\n * @param id Id of the menu button. Multiple menu buttons may be displayed.\n * @param menuItemsProps Properties of the menu items to display.\n * @param location Location of the context menu, relative to the origin of htmlElement or the window.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n * @deprecated in 4.11.x. Please use {@link UiFramework.showMenuButton}.\n /\n public override showMenuButton(\n id: string,\n menuItemsProps: AbstractMenuItemProps[],\n location: XAndY,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showMenuButton(\n id,\n menuItemsProps as CursorMenuItemProps[],\n location,\n htmlElement\n );\n }\n\n /* Hides a menu button.\n * @param id Id of the menu button. Multiple menu buttons may be displayed.\n * @return true if the menu was hidden, false if the menu could not be hidden.\n * @deprecated in 4.11.x. Please use {@link UiFramework.hideMenuButton}.\n /\n public override hideMenuButton(id: string): boolean {\n return UiFramework.hideMenuButton(id);\n }\n\n /* Show a calculator at a particular location.\n * @param initialValue Value initially displayed in the calculator.\n * @param resultIcon Icon displayed to the left of the value.\n * @param location Location of the calculator, relative to the origin of htmlElement or the window.\n * @param onOk Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.showCalculator}.\n /\n public override showCalculator(\n initialValue: number,\n resultIcon: string,\n location: XAndY,\n onOk: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showCalculator(\n initialValue,\n resultIcon,\n location,\n onOk,\n onCancel,\n htmlElement\n );\n }\n\n /* Hides the calculator.\n * @deprecated in 4.11.x. Use {@link UiFramework.hideCalculator}.\n /\n public override hideCalculator(): boolean {\n return UiFramework.hideCalculator();\n }\n\n /* Show an input editor for an angle value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.showAngleEditor}.\n /\n public override showAngleEditor(\n initialValue: number,\n location: XAndY,\n onCommit: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showAngleEditor(\n initialValue,\n location,\n onCommit,\n onCancel,\n htmlElement\n );\n }\n\n /* Show an input editor for a length value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor(\"length\")}.\n /\n public override showLengthEditor(\n initialValue: number,\n location: XAndY,\n onCommit: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showDimensionEditor(\n \"length\",\n initialValue,\n location,\n onCommit,\n onCancel,\n htmlElement\n );\n }\n\n /* Show an input editor for a height value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.showDimensionEditor(\"height\")}.\n /\n public override showHeightEditor(\n initialValue: number,\n location: XAndY,\n onCommit: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showDimensionEditor(\n \"height\",\n initialValue,\n location,\n onCommit,\n onCancel,\n htmlElement\n );\n }\n\n /* Show an input editor for a primitive value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param propertyDescription Description of the primitive value property\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n /\n public override showInputEditor(\n initialValue: Primitives.Value,\n propertyDescription: PropertyDescription,\n location: XAndY,\n onCommit: OnValueCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showInputEditor({\n initialValue,\n propertyDescription,\n location,\n onCommit,\n onCancel,\n anchorElement: htmlElement,\n });\n }\n\n /* Hides the input editor./\n public override hideInputEditor(): boolean {\n return UiFramework.hideInputEditor();\n }\n\n /* Show an HTML element at a particular location.\n * @param displayElement The HTMLElement to display\n * @param location Location of the display element, relative to the origin of htmlElement or the window\n * @param offset Offset of the display element from the location\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\n * @return true if the display element was displayed, false if the display element could not be displayed.\n * @deprecated in 4.11.x. Use {@link UiFramework.showComponent}\n /\n public override showHTMLElement(\n displayElement: HTMLElement,\n location: XAndY,\n offset: XAndY,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const el = anchorElement ?? UiFramework.controls.getWrapperElement();\n\n if (relativePosition === undefined)\n relativePosition = RelativePosition.TopRight;\n\n return PopupManager.showHTMLElement(\n displayElement,\n el,\n location,\n offset,\n onCancel,\n relativePosition\n );\n }\n\n /\n Hides the HTML Element.\n * @deprecated in 4.11.x. Use {@link UiFramework.hideComponent}\n /\n public override hideHTMLElement(): boolean {\n return PopupManager.hideHTMLElement();\n }\n\n /* Show a Card containing content, a title and a toolbar at a particular location.\n * @param content The HTMLElement of the content to display\n * @param title Title to display at the top of the card.\n * @param toolbarProps Properties of the Toolbar to display.\n * @param location Location of the Card, relative to the origin of htmlElement or the window.\n * @param offset Offset of the Card from the location.\n * @param onItemExecuted Function invoked after a Toolbar item is executed\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n * @return true if the Card was displayed, false if the Card could not be displayed.\n /\n public override showCard(\n content: HTMLElement,\n title: string \| PropertyRecord \| undefined,\n toolbarProps: AbstractToolbarProps \| undefined,\n location: XAndY,\n offset: XAndY,\n onItemExecuted: OnItemExecutedFunc,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n return UiFramework.showCard(\n <CardRenderer content={content} />,\n title,\n toolbarProps\n ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n : { items: [] },\n location,\n offset,\n onItemExecuted,\n onCancel,\n placement,\n anchorElement\n );\n }\n\n /* Show a Card containing React-based content, a title and a toolbar at a particular location.\n * @param content The React node of the content to display\n * @param title Title to display at the top of the card.\n * @param toolbarProps Properties of the Toolbar to display.\n * @param location Location of the Card, relative to the origin of htmlElement or the window.\n * @param offset Offset of the Card from the location.\n * @param onItemExecuted Function invoked after a Toolbar item is executed\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n * @return true if the Card was displayed, false if the Card could not be displayed.\n /\n public showReactCard(\n content: React.ReactNode,\n title: string \| PropertyRecord \| undefined,\n toolbarProps: AbstractToolbarProps \| undefined,\n location: XAndY,\n offset: XAndY,\n onItemExecuted: OnItemExecutedFunc,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n return UiFramework.showCard(\n content,\n title,\n toolbarProps\n ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n : { items: [] },\n location,\n offset,\n onItemExecuted,\n onCancel,\n placement,\n anchorElement\n );\n }\n\n /\n Hides the Card.\n * /\n public override hideCard(): boolean {\n return UiFramework.hideCard();\n }\n\n /* Opens a Tool Settings Ui popup at a particular location.\n * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.\n * @param location Location of the tool settings, relative to the origin of anchorElement or the window\n * @param offset Offset of the tool settings from the location\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n /\n public override openToolSettingsPopup(\n dataProvider: DialogLayoutDataProvider,\n location: XAndY,\n offset: XAndY,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n return UiFramework.openToolSettingsPopup(\n dataProvider,\n location,\n offset,\n onCancel,\n placement,\n anchorElement\n );\n }\n\n /* Closes the Tool Settings Ui popup. /\n public override closeToolSettingsPopup(): boolean {\n return UiFramework.closeToolSettingsPopup();\n }\n\n /* Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\n * @param uiDataProvider The UiDataProvider for the tool settings\n * @param title Specify title for dialog.\n * @param isModal Specify if the dialog is opened as a modal or modeless.\n * @param id Id of the dialog that is used to close it.\n * @param optionalProps Optional props for Dialog construction.\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n /\n public override openDialog(\n uiDataProvider: DialogLayoutDataProvider,\n title: string,\n isModal: boolean,\n id: string,\n optionalProps?: DialogProps\n ): boolean {\n return UiFramework.openDialog(\n uiDataProvider,\n title,\n isModal,\n id,\n optionalProps\n );\n }\n\n /* Closes the Tool Settings Ui popup.*/\n public override closeDialog(dialogId: string): boolean {\n return UiFramework.closeDialog(dialogId);\n }\n}\n\n// utility functions to wean off appui-abstract\nfunction AbstractToolbarPropsToToolbarProps(\n props: AbstractToolbarProps\n): ToolbarProps {\n return {\n items: props.items.map(CommonToolbarItemToToolBarItem),\n itemId: props.toolbarId,\n };\n}\n\nfunction CommonToolbarItemToToolBarItem(item: CommonToolbarItem): ToolbarItem {\n return {\n ...item,\n badge: item.badgeType,\n };\n}\n\ninterface CardRendererProps {\n content: HTMLElement;\n}\n\nfunction CardRenderer({ content }: CardRendererProps) {\n const ref = React.useRef<HTMLDivElement>(null);\n\n React.useEffect(() => {\n const el = ref.current;\n el?.appendChild(content);\n return () => {\n el?.removeChild(content);\n };\n }, [content]);\n\n return <div ref={ref} />;\n}\n"]}
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,mEAAgE;AAChE,wDAAqD;AACrD,gDAA6C;AAE7C,6CAG0B;AAC1B,kDAAoD;AAKpD;;;;;;;;;;GAUG;AACH,MAAa,gBAAiB,SAAQ,wBAAO;IAA7C;;QACU,8BAAyB,GAC/B,+BAAsB,CAAC,YAAY,CAAC;IAuexC,CAAC;IAreC;;OAEG;IACH,IAAW,wBAAwB;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACxC,CAAC;IAED,IAAW,wBAAwB,CAAC,UAAkC;QACpE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,IAAoB,cAAc;QAChC,OAAO,qCAAiB,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAoB,aAAa;QAC/B,OAAO,yBAAW,CAAC,iBAAiB,CAAC,aAAa,CAAC;IACrD,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,yBAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACa,eAAe,CAC7B,KAA8B,EAC9B,QAAe,EACf,WAAyB;QAEzB,OAAO,yBAAW,CAAC,eAAe,CAChC,KAA8B,EAC9B,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,KAAK,GAAG,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACa,gBAAgB,CAAC,WAAyB;QACxD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,MAAM,KAAK,GAAG,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAA,8BAAqB,EAAC,KAAK,CAAC,CAAC;QAE5C,OAAO,yBAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACa,gBAAgB;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB;YAAE,OAAO,KAAK,CAAC;QAEvD,OAAO,yBAAW,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACa,WAAW,CACzB,YAAkC,EAClC,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,WAAyB;QAEzB,MAAM,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QAEnD,OAAO,yBAAW,CAAC,WAAW,CAC5B,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,WAAW;QACzB,OAAO,yBAAW,CAAC,WAAW,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACa,cAAc,CAC5B,EAAU,EACV,cAAuC,EACvC,QAAe,EACf,WAAyB;QAEzB,OAAO,yBAAW,CAAC,cAAc,CAC/B,EAAE,EACF,cAAuC,EACvC,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACa,cAAc,CAAC,EAAU;QACvC,OAAO,yBAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACa,cAAc,CAC5B,YAAoB,EACpB,UAAkB,EAClB,QAAe,EACf,IAAwB,EACxB,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,cAAc,CAC/B,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,OAAO,yBAAW,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,eAAe,CAChC,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,gBAAgB,CAC9B,YAAoB,EACpB,QAAe,EACf,QAA4B,EAC5B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,mBAAmB,CACpC,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACa,eAAe,CAC7B,YAA8B,EAC9B,mBAAwC,EACxC,QAAe,EACf,QAA2B,EAC3B,QAAsB,EACtB,WAAyB;QAEzB,OAAO,yBAAW,CAAC,eAAe,CAAC;YACjC,YAAY;YACZ,mBAAmB;YACnB,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,aAAa,EAAE,WAAW;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IACb,eAAe;QAC7B,OAAO,yBAAW,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;;;OASG;IACa,eAAe,CAC7B,cAA2B,EAC3B,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,EAAE,GAAG,aAAa,IAAI,yBAAW,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAErE,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;;;OAGG;IACa,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,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,yBAAW,CAAC,QAAQ,CACzB,oBAAC,YAAY,IAAC,OAAO,EAAE,OAAO,GAAI,EAClC,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAwB,EACxB,KAA0C,EAC1C,YAA8C,EAC9C,QAAe,EACf,MAAa,EACb,cAAkC,EAClC,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,yBAAW,CAAC,QAAQ,CACzB,OAAO,EACP,KAAK,EACL,YAAY;YACV,CAAC,CAAC,kCAAkC,CAAC,YAAY,CAAC;YAClD,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,EACjB,QAAQ,EACR,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED;;SAEK;IACW,QAAQ;QACtB,OAAO,yBAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAsC,EACtC,QAAe,EACf,MAAa,EACb,QAAsB,EACtB,gBAAmC,EACnC,aAA2B;QAE3B,MAAM,SAAS,GAAG,IAAA,0BAAc,EAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,yBAAW,CAAC,qBAAqB,CACtC,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,CACd,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzB,sBAAsB;QACpC,OAAO,yBAAW,CAAC,sBAAsB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACa,UAAU,CACxB,cAAwC,EACxC,KAAa,EACb,OAAgB,EAChB,EAAU,EACV,aAA2B;QAE3B,OAAO,yBAAW,CAAC,UAAU,CAC3B,cAAc,EACd,KAAK,EACL,OAAO,EACP,EAAE,EACF,aAAa,CACd,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxB,WAAW,CAAC,QAAgB;QAC1C,OAAO,yBAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;CACF;AAzeD,4CAyeC;AAED,+CAA+C;AAC/C,SAAS,kCAAkC,CACzC,KAA2B;IAE3B,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,CAAC;QACtD,MAAM,EAAE,KAAK,CAAC,SAAS;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAuB;IAC7D,OAAO;QACL,GAAG,IAAI;QACP,KAAK,EAAE,IAAI,CAAC,SAAS;KACtB,CAAC;AACJ,CAAC;AAMD,SAAS,YAAY,CAAC,EAAE,OAAO,EAAqB;IAClD,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAiB,IAAI,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC;QACvB,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,OAAO,6BAAK,GAAG,EAAE,GAAG,GAAI,CAAC;AAC3B,CAAC","sourcesContent":["/---------------------------------------------------------------------------------------------\n Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n --------------------------------------------------------------------------------------------/\n/** @packageDocumentation\n * @module Admin\n /\n\nimport as React from \"react\";\nimport type { XAndY } from \"@itwin/core-geometry\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport type {\n AbstractMenuItemProps,\n AbstractToolbarProps,\n CommonToolbarItem,\n DialogLayoutDataProvider,\n DialogProps,\n OnCancelFunc,\n OnItemExecutedFunc,\n OnNumberCommitFunc,\n OnValueCommitFunc,\n Primitives,\n PropertyDescription,\n PropertyRecord,\n} from \"@itwin/appui-abstract\";\nimport { RelativePosition, UiAdmin } from \"@itwin/appui-abstract\";\nimport { CursorInformation } from \"../cursor/CursorInformation\";\nimport { PopupManager } from \"../popup/PopupManager\";\nimport { UiFramework } from \"../UiFramework\";\nimport type { KeyinEntry } from \"../keyins/Keyins\";\nimport {\n getKeyinsFromToolList,\n KeyinFieldLocalization,\n} from \"../keyins/Keyins\";\nimport { mapToPlacement } from \"../utils/Placement\";\nimport type { ToolbarProps } from \"../toolbar/Toolbar\";\nimport type { ToolbarItem } from \"../toolbar/ToolbarItem\";\nimport type { CursorMenuItemProps } from \"../shared/MenuItem\";\n\n/** Subclass of `UiAdmin` in `@itwin/core-frontend` to be used to initialize `IModelApp`.\n \n This implementation uses themed react components that blends in AppUI look and feel.\n \n ```ts\n * await IModelApp.startup({\n * uiAdmin: new FrameworkUiAdmin()\n * });\n * ```\n * @public\n /\nexport class FrameworkUiAdmin extends UiAdmin {\n private _localizedKeyinPreference: KeyinFieldLocalization =\n KeyinFieldLocalization.NonLocalized;\n\n /\n @deprecated in 4.11.0. Gathering and filtering of keyins is now left up to the user.\n /\n public get localizedKeyinPreference(): KeyinFieldLocalization {\n return this._localizedKeyinPreference;\n }\n\n public set localizedKeyinPreference(preference: KeyinFieldLocalization) {\n this._localizedKeyinPreference = preference;\n }\n\n /* Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY.\n * @deprecated in 4.11.0. Please use {@link CursorInformation.cursorPosition}\n /\n public override get cursorPosition(): XAndY {\n return CursorInformation.cursorPosition;\n }\n\n /* Determines if focus is set to Home\n * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().isFocusOnHome}\n /\n public override get isFocusOnHome(): boolean {\n return UiFramework.keyboardShortcuts.isFocusOnHome;\n }\n\n /* Sets focus to Home\n * @deprecated in 4.11.0. Please use {@link UiFramework.keyboardShortcuts().setFocusToHome}\n /\n public override setFocusToHome(): void {\n UiFramework.keyboardShortcuts.setFocusToHome();\n }\n\n /* Show a context menu at a particular location.\n * @param items Properties of the menu items to display.\n * @param location Location of the context menu, relative to the origin of htmlElement or the overall window.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.openContextMenu}\n /\n public override showContextMenu(\n items: AbstractMenuItemProps[],\n location: XAndY,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.openContextMenu(\n items as CursorMenuItemProps[],\n location,\n htmlElement\n );\n }\n\n /\n @deprecated in 4.11.0. Construct your own {@link KeyinEntry[]} via {@link @itwin/core-frontend#IModelApp.tools.getToolList}.\n /\n public getKeyins(): KeyinEntry[] {\n const tools = IModelApp.tools.getToolList();\n return getKeyinsFromToolList(tools);\n }\n\n /* Show the Key-in Palette to display key-in from all registered Tools.\n * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.\n * @return true if the Command Palette was displayed, false if it could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.showKeyinPalette}. Please note, the use of feature flags to control whether the KeyinPalette can be opened has been deprecated.\n /\n public override showKeyinPalette(htmlElement?: HTMLElement): boolean {\n if (!this.featureFlags.allowKeyinPalette) return false;\n\n const tools = IModelApp.tools.getToolList();\n const keyIns = getKeyinsFromToolList(tools);\n\n return UiFramework.showKeyinPalette(keyIns, htmlElement);\n }\n\n /\n Hides the Key-in Palette.\n * @deprecated in 4.11.0. Use {@link UiFramework.hideKeyinPalette}\n /\n public override hideKeyinPalette(): boolean {\n if (!this.featureFlags.allowKeyinPalette) return false;\n\n return UiFramework.hideKeyinPalette();\n }\n\n /* Show a Toolbar at a particular location.\n * @param toolbarProps Properties of the Toolbar to display.\n * @param location Location of the Toolbar, relative to the origin of htmlElement or the overall window.\n * @param offset Offset of the Toolbar from the location.\n * @param onItemExecuted Function invoked after a Toolbar item is executed\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\n * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\n * @deprecated in 4.11.0. Please use {@link UiFramework.showToolbar}.\n /\n public override showToolbar(\n toolbarProps: AbstractToolbarProps,\n location: XAndY,\n offset: XAndY,\n onItemExecuted: OnItemExecutedFunc,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n htmlElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n\n return UiFramework.showToolbar(\n toolbarProps,\n location,\n offset,\n onItemExecuted,\n onCancel,\n placement,\n htmlElement\n );\n }\n\n /* Hides the toolbar.\n * @deprecated in 4.11.0. Please use {@link UiFramework.hideToolbar}.\n /\n public override hideToolbar(): boolean {\n return UiFramework.hideToolbar();\n }\n\n /* Show a menu button at a particular location. A menu button opens a context menu.\n * @param id Id of the menu button. Multiple menu buttons may be displayed.\n * @param menuItemsProps Properties of the menu items to display.\n * @param location Location of the context menu, relative to the origin of htmlElement or the window.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n * @deprecated in 4.11.0. Please use {@link UiFramework.showMenuButton}.\n /\n public override showMenuButton(\n id: string,\n menuItemsProps: AbstractMenuItemProps[],\n location: XAndY,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showMenuButton(\n id,\n menuItemsProps as CursorMenuItemProps[],\n location,\n htmlElement\n );\n }\n\n /* Hides a menu button.\n * @param id Id of the menu button. Multiple menu buttons may be displayed.\n * @return true if the menu was hidden, false if the menu could not be hidden.\n * @deprecated in 4.11.0. Please use {@link UiFramework.hideMenuButton}.\n /\n public override hideMenuButton(id: string): boolean {\n return UiFramework.hideMenuButton(id);\n }\n\n /* Show a calculator at a particular location.\n * @param initialValue Value initially displayed in the calculator.\n * @param resultIcon Icon displayed to the left of the value.\n * @param location Location of the calculator, relative to the origin of htmlElement or the window.\n * @param onOk Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.showCalculator}.\n /\n public override showCalculator(\n initialValue: number,\n resultIcon: string,\n location: XAndY,\n onOk: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showCalculator(\n initialValue,\n resultIcon,\n location,\n onOk,\n onCancel,\n htmlElement\n );\n }\n\n /* Hides the calculator.\n * @deprecated in 4.11.0. Use {@link UiFramework.hideCalculator}.\n /\n public override hideCalculator(): boolean {\n return UiFramework.hideCalculator();\n }\n\n /* Show an input editor for an angle value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.showAngleEditor}.\n /\n public override showAngleEditor(\n initialValue: number,\n location: XAndY,\n onCommit: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showAngleEditor(\n initialValue,\n location,\n onCommit,\n onCancel,\n htmlElement\n );\n }\n\n /* Show an input editor for a length value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor(\"length\")}.\n /\n public override showLengthEditor(\n initialValue: number,\n location: XAndY,\n onCommit: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showDimensionEditor(\n \"length\",\n initialValue,\n location,\n onCommit,\n onCancel,\n htmlElement\n );\n }\n\n /* Show an input editor for a height value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.showDimensionEditor(\"height\")}.\n /\n public override showHeightEditor(\n initialValue: number,\n location: XAndY,\n onCommit: OnNumberCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showDimensionEditor(\n \"height\",\n initialValue,\n location,\n onCommit,\n onCancel,\n htmlElement\n );\n }\n\n /* Show an input editor for a primitive value at a particular location.\n * @param initialValue Value initially displayed in the editor.\n * @param propertyDescription Description of the primitive value property\n * @param location Location of the editor, relative to the origin of htmlElement or the window.\n * @param onCommit Function called when the OK button or the Enter key is pressed.\n * @param onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n /\n public override showInputEditor(\n initialValue: Primitives.Value,\n propertyDescription: PropertyDescription,\n location: XAndY,\n onCommit: OnValueCommitFunc,\n onCancel: OnCancelFunc,\n htmlElement?: HTMLElement\n ): boolean {\n return UiFramework.showInputEditor({\n initialValue,\n propertyDescription,\n location,\n onCommit,\n onCancel,\n anchorElement: htmlElement,\n });\n }\n\n /* Hides the input editor./\n public override hideInputEditor(): boolean {\n return UiFramework.hideInputEditor();\n }\n\n /* Show an HTML element at a particular location.\n * @param displayElement The HTMLElement to display\n * @param location Location of the display element, relative to the origin of htmlElement or the window\n * @param offset Offset of the display element from the location\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\n * @return true if the display element was displayed, false if the display element could not be displayed.\n * @deprecated in 4.11.0. Use {@link UiFramework.showComponent}\n /\n public override showHTMLElement(\n displayElement: HTMLElement,\n location: XAndY,\n offset: XAndY,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const el = anchorElement ?? UiFramework.controls.getWrapperElement();\n\n if (relativePosition === undefined)\n relativePosition = RelativePosition.TopRight;\n\n return PopupManager.showHTMLElement(\n displayElement,\n el,\n location,\n offset,\n onCancel,\n relativePosition\n );\n }\n\n /\n Hides the HTML Element.\n * @deprecated in 4.11.0. Use {@link UiFramework.hideComponent}\n /\n public override hideHTMLElement(): boolean {\n return PopupManager.hideHTMLElement();\n }\n\n /* Show a Card containing content, a title and a toolbar at a particular location.\n * @param content The HTMLElement of the content to display\n * @param title Title to display at the top of the card.\n * @param toolbarProps Properties of the Toolbar to display.\n * @param location Location of the Card, relative to the origin of htmlElement or the window.\n * @param offset Offset of the Card from the location.\n * @param onItemExecuted Function invoked after a Toolbar item is executed\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n * @return true if the Card was displayed, false if the Card could not be displayed.\n /\n public override showCard(\n content: HTMLElement,\n title: string \| PropertyRecord \| undefined,\n toolbarProps: AbstractToolbarProps \| undefined,\n location: XAndY,\n offset: XAndY,\n onItemExecuted: OnItemExecutedFunc,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n return UiFramework.showCard(\n <CardRenderer content={content} />,\n title,\n toolbarProps\n ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n : { items: [] },\n location,\n offset,\n onItemExecuted,\n onCancel,\n placement,\n anchorElement\n );\n }\n\n /* Show a Card containing React-based content, a title and a toolbar at a particular location.\n * @param content The React node of the content to display\n * @param title Title to display at the top of the card.\n * @param toolbarProps Properties of the Toolbar to display.\n * @param location Location of the Card, relative to the origin of htmlElement or the window.\n * @param offset Offset of the Card from the location.\n * @param onItemExecuted Function invoked after a Toolbar item is executed\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n * @return true if the Card was displayed, false if the Card could not be displayed.\n /\n public showReactCard(\n content: React.ReactNode,\n title: string \| PropertyRecord \| undefined,\n toolbarProps: AbstractToolbarProps \| undefined,\n location: XAndY,\n offset: XAndY,\n onItemExecuted: OnItemExecutedFunc,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n return UiFramework.showCard(\n content,\n title,\n toolbarProps\n ? AbstractToolbarPropsToToolbarProps(toolbarProps)\n : { items: [] },\n location,\n offset,\n onItemExecuted,\n onCancel,\n placement,\n anchorElement\n );\n }\n\n /\n Hides the Card.\n * /\n public override hideCard(): boolean {\n return UiFramework.hideCard();\n }\n\n /* Opens a Tool Settings Ui popup at a particular location.\n * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.\n * @param location Location of the tool settings, relative to the origin of anchorElement or the window\n * @param offset Offset of the tool settings from the location\n * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\n * @param relativePosition Position relative to the given location. Defaults to TopRight.\n * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n /\n public override openToolSettingsPopup(\n dataProvider: DialogLayoutDataProvider,\n location: XAndY,\n offset: XAndY,\n onCancel: OnCancelFunc,\n relativePosition?: RelativePosition,\n anchorElement?: HTMLElement\n ): boolean {\n const placement = mapToPlacement(relativePosition);\n return UiFramework.openToolSettingsPopup(\n dataProvider,\n location,\n offset,\n onCancel,\n placement,\n anchorElement\n );\n }\n\n /* Closes the Tool Settings Ui popup. /\n public override closeToolSettingsPopup(): boolean {\n return UiFramework.closeToolSettingsPopup();\n }\n\n /* Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\n * @param uiDataProvider The UiDataProvider for the tool settings\n * @param title Specify title for dialog.\n * @param isModal Specify if the dialog is opened as a modal or modeless.\n * @param id Id of the dialog that is used to close it.\n * @param optionalProps Optional props for Dialog construction.\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n /\n public override openDialog(\n uiDataProvider: DialogLayoutDataProvider,\n title: string,\n isModal: boolean,\n id: string,\n optionalProps?: DialogProps\n ): boolean {\n return UiFramework.openDialog(\n uiDataProvider,\n title,\n isModal,\n id,\n optionalProps\n );\n }\n\n /* Closes the Tool Settings Ui popup.*/\n public override closeDialog(dialogId: string): boolean {\n return UiFramework.closeDialog(dialogId);\n }\n}\n\n// utility functions to wean off appui-abstract\nfunction AbstractToolbarPropsToToolbarProps(\n props: AbstractToolbarProps\n): ToolbarProps {\n return {\n items: props.items.map(CommonToolbarItemToToolBarItem),\n itemId: props.toolbarId,\n };\n}\n\nfunction CommonToolbarItemToToolBarItem(item: CommonToolbarItem): ToolbarItem {\n return {\n ...item,\n badge: item.badgeType,\n };\n}\n\ninterface CardRendererProps {\n content: HTMLElement;\n}\n\nfunction CardRenderer({ content }: CardRendererProps) {\n const ref = React.useRef<HTMLDivElement>(null);\n\n React.useEffect(() => {\n const el = ref.current;\n el?.appendChild(content);\n return () => {\n el?.removeChild(content);\n };\n }, [content]);\n\n return <div ref={ref} />;\n}\n"]}