@itwin/appui-react 4.0.0-dev.9 → 4.0.1

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

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,0DAK+B;AAmB/B;;GAEG;AACH,MAAa,cAAe,SAAQ,+BAAkB;CACrD;AADD,wCACC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiProvider\r\n */\r\n\r\nimport {\r\n  AllowedUiItemProviderOverrides as UIA_AllowedUiItemProviderOverrides,\r\n  UiItemProviderOverrides as UIA_UiItemProviderOverrides,\r\n  UiItemProviderRegisteredEventArgs as UIA_UiItemProviderRegisteredEventArgs,\r\n  UiItemsManager as UIA_UiItemsManager,\r\n} from \"@itwin/appui-abstract\";\r\n\r\n/** UiItemsProvider register event args.\r\n * @beta\r\n */\r\nexport type UiItemsProviderRegisteredEventArgs = UIA_UiItemProviderRegisteredEventArgs;\r\n\r\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @beta\r\n */\r\nexport type AllowedUiItemsProviderOverrides = UIA_AllowedUiItemProviderOverrides;\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @beta\r\n */\r\nexport type UiItemsProviderOverrides = UIA_UiItemProviderOverrides;\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @beta\r\n */\r\nexport class UiItemsManager extends UIA_UiItemsManager {\r\n}\r\n"]}
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAsE;AAMtE,gDAA6C;AAI7C,qEAA+E;AAuC/E;;GAEG;AACH,MAAa,cAAc;IAKzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAEnD,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAED,wEAAwE;IACjE,MAAM,KAAK,2BAA2B;QAC3C,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,2BAA2B,CAAC;QAE3D,OAAO,IAAI,CAAC,4BAA4B,CAAC;IAC3C,CAAC;IAED,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;QAErD,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,CAAC;QAEtD,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE9D,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,IAAwC;QACzE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAoC;QACtF,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE/D,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,qBAAM,CAAC,OAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SACvG;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,qBAAM,CAAC,OAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAElH,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;SACpD;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,UAAkB;QACzC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC9D,qBAAM,CAAC,OAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,YAAY,CAAC,CAAC;QAE7F,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACrD,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,KAAmB,EAAE,WAA+B;QAC3H,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAE9F,MAAM,WAAW,GAAgC,EAAE,CAAC;QAEpD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,mBAAmB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC7F,UAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC;qBACpE,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;oBAC7B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB;QACjE,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtE,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC;qBAClD,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAEnD,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B;QACrH,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAElF,MAAM,OAAO,GAA2B,EAAE,CAAC;QAE3C,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC;qBAC9D,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBAClB,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;;AAzNc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AACvG,2CAA4B,GAAG,IAAI,wBAAS,EAAsC,CAAC;AACnF,+BAAgB,GAAG,IAAA,4DAAmC,GAAE,CAAC;AAH7D,wCAAc","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiProvider\n */\n\nimport { BeUiEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\nimport { BackstageItem } from \"../backstage/BackstageItem\";\nimport { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\nimport { StagePanelSection } from \"../stagepanels/StagePanelSection\";\nimport { StatusBarItem } from \"../statusbar/StatusBarItem\";\nimport { ToolbarItem, ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem\";\nimport { UiFramework } from \"../UiFramework\";\nimport { Widget } from \"../widgets/Widget\";\nimport { ProviderItem } from \"./ProviderItem\";\nimport { UiItemsProvider } from \"./UiItemsProvider\";\nimport { createAbstractUiItemsManagerAdapter } from \"./AbstractUiItemsManager\";\n\n/** UiItemsProvider register event args.\n * @public\n */\nexport interface UiItemsProviderRegisteredEventArgs {\n  providerId: string;\n}\n\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\n * @public\n */\nexport interface AllowedUiItemsProviderOverrides {\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */\n  providerId?: string;\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided */\n  stageUsages?: string[];\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided */\n  stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n * @public\n */\nexport type UiItemsProviderOverrides =\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageIds\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"stageIds\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"stageUsages\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;\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> = new Map<string, UiItemProviderEntry>();\n  private static _onUiProviderRegisteredEvent = new BeUiEvent<UiItemsProviderRegisteredEventArgs>();\n  private static _abstractAdapter = createAbstractUiItemsManagerAdapter();\n\n  /** For use in unit testing\n   * @internal */\n  public static clearAllProviders() {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.clearAllProviders();\n\n    UiItemsManager._registeredUiItemsProviders.clear();\n  }\n\n  /** Event raised any time a UiProvider is registered or unregistered. */\n  public static get onUiProviderRegisteredEvent(): BeUiEvent<UiItemsProviderRegisteredEventArgs> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.onUiProviderRegisteredEvent;\n\n    return this._onUiProviderRegisteredEvent;\n  }\n\n  /** Return number of registered UiProvider. */\n  public static get registeredProviderIds(): string[] {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.registeredProviderIds;\n\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n    return ids;\n  }\n\n  /** Return true if there is any registered UiProvider. */\n  public static get hasRegisteredProviders(): boolean {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.hasRegisteredProviders;\n\n    return this._registeredUiItemsProviders.size > 0;\n  }\n\n  /**\n   * Retrieves a previously loaded UiItemsProvider.\n   * @param providerId id of the UiItemsProvider to get\n   */\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getUiItemsProvider(providerId);\n\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n  }\n\n  private static sendRegisteredEvent(args: UiItemsProviderRegisteredEventArgs) {\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);\n  }\n\n  /**\n   * Registers a UiItemsProvider with the UiItemsManager.\n   * @param uiProvider the UI items provider to register.\n   */\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): 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(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\n    } else {\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\n      Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\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)\n      return;\n\n    provider.onUnregister && provider.onUnregister();\n\n    UiItemsManager._registeredUiItemsProviders.delete(providerId);\n    Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);\n\n    // trigger a refresh of the ui\n    UiItemsManager.sendRegisteredEvent({ providerId });\n  }\n\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\n    // istanbul ignore else\n    const overrides = entry.overrides;\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\n      return false;\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\n      return false;\n    return true;\n  }\n\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n   * an action or specify a registered ToolId into toolbar.\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param usage usage of the toolbar\n   * @param orientation orientation of the toolbar\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\n   */\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, usage: ToolbarUsage, orientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getToolbarButtonItems(stageId, stageUsage, usage, orientation);\n\n    const buttonItems: ProviderItem<ToolbarItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      // istanbul ignore else\n      if (uiProvider.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideToolbarItems(stageId, stageUsage, usage, orientation)\n          .forEach((spec: ToolbarItem) => {\n            // ignore duplicate ids\n            if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))\n              buttonItems.push({ ...spec, providerId });\n          });\n      }\n    });\n\n    return buttonItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n   */\n  public static getStatusBarItems(stageId: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);\n\n    const statusBarItems: ProviderItem<StatusBarItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideStatusBarItems(stageId, stageUsage)\n          .forEach((item: StatusBarItem) => {\n            // ignore duplicate ids\n            if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))\n              statusBarItems.push({ ...item, providerId });\n          });\n      }\n    });\n\n    return statusBarItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n   */\n  public static getBackstageItems(): ReadonlyArray<ProviderItem<BackstageItem>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getBackstageItems();\n\n    const backstageItems: ProviderItem<BackstageItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\n            // ignore duplicate ids\n            if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))\n              backstageItems.push({ ...item, providerId });\n          });\n      }\n    });\n\n    return backstageItems;\n  }\n\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param location the location within the stage.\n   * @param section the section within location.\n   * @returns An array of widgets.\n   */\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>> {\n    if (this._abstractAdapter)\n      return this._abstractAdapter.getWidgets(stageId, stageUsage, location, section);\n\n    const widgets: ProviderItem<Widget>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideWidgets(stageId, stageUsage, location, section)\n          .forEach((widget) => {\n            // ignore duplicate ids\n            if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))\n              widgets.push({ ...widget, providerId });\n          });\n      }\n    });\n\n    return widgets;\n  }\n\n}\n"]}

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

@@ -1,9 +1,27 @@
-/** @packageDocumentation
- * @module UiProvider
- */
-import { UiItemsProvider as UIA_UiItemsProvider } from "@itwin/appui-abstract";
-/** Describes interface of objects that want to provide UI component to the running IModelApp.
- * @beta
- */
-export declare type UiItemsProvider = UIA_UiItemsProvider;
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { BackstageItem } from "../backstage/BackstageItem";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
+import { StagePanelSection } from "../stagepanels/StagePanelSection";
+import { StatusBarItem } from "../statusbar/StatusBarItem";
+import { ToolbarItem, ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem";
+import { Widget } from "../widgets/Widget";
+/** Describes interface of objects that want to provide UI component to the running IModelApp.
+ * @public
+ */
+export interface UiItemsProvider {
+    /** Id of provider. */
+    readonly id: string;
+    /** Provides toolbar items. */
+    readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;
+    /** Provides status bar items. */
+    readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;
+    /** Provides backstage items. */
+    readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;
+    /** Provides widgets. */
+    readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => ReadonlyArray<Widget>;
+    /** Function called when the provider is unregistered. Allows provider to do a cleanup. */
+    readonly onUnregister?: () => void;
+}
 //# sourceMappingURL=UiItemsProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,IAAI,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE/E;;GAEG;AACH,oBAAY,eAAe,GAAG,mBAAmB,CAAC"}
+{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sBAAsB;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,8BAA8B;IAC9B,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,KAAK,aAAa,CAAC,WAAW,CAAC,CAAC;IACvK,iCAAiC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,aAAa,CAAC,aAAa,CAAC,CAAC;IACvG,gCAAgC;IAChC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,aAAa,CAAC,aAAa,CAAC,CAAC;IACpE,wBAAwB;IACxB,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC;IACpJ,0FAA0F;IAC1F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CACpC"}

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module UiProvider
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=UiItemsProvider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module UiProvider\r\n */\r\n\r\nimport { UiItemsProvider as UIA_UiItemsProvider } from \"@itwin/appui-abstract\";\r\n\r\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\r\n * @beta\r\n */\r\nexport type UiItemsProvider = UIA_UiItemsProvider; // eslint-disable-line deprecation/deprecation\r\n"]}
+{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;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 { BackstageItem } from \"../backstage/BackstageItem\";\nimport { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\nimport { StagePanelSection } from \"../stagepanels/StagePanelSection\";\nimport { StatusBarItem } from \"../statusbar/StatusBarItem\";\nimport { ToolbarItem, ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem\";\nimport { Widget } from \"../widgets/Widget\";\n\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\n * @public\n */\nexport interface UiItemsProvider {\n  /** Id of provider. */\n  readonly id: string;\n\n  /** Provides toolbar items. */\n  readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;\n  /** Provides status bar items. */\n  readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items. */\n  readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets. */\n  readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => 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/ui-items-provider/isProviderItem.d.ts

@@ -0,0 +1,7 @@
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { ProviderItem } from "./ProviderItem";
+/** @internal */
+export declare function isProviderItem<T extends object>(item: T): item is ProviderItem<T>;
+//# sourceMappingURL=isProviderItem.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isProviderItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/isProviderItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,gBAAgB;AAChB,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,IAAI,YAAY,CAAC,CAAC,CAAC,CAEjF"}

package/lib/{esm/appui-react/content/FloatingViewportContent.css → cjs/appui-react/ui-items-provider/isProviderItem.js}

@@ -1,9 +1,16 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-.ViewportContentComponent {
-  height: 100%;
-  width: 100%;
-}
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isProviderItem = void 0;
+/** @internal */
+function isProviderItem(item) {
+    return "providerId" in item;
+}
+exports.isProviderItem = isProviderItem;
+//# sourceMappingURL=isProviderItem.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isProviderItem.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/isProviderItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH,gBAAgB;AAChB,SAAgB,cAAc,CAAmB,IAAO;IACtD,OAAO,YAAY,IAAI,IAAI,CAAC;AAC9B,CAAC;AAFD,wCAEC","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 { ProviderItem } from \"./ProviderItem\";\n\n/** @internal */\nexport function isProviderItem<T extends object>(item: T): item is ProviderItem<T> {\n  return \"providerId\" in item;\n}\n"]}

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

@@ -1,202 +1,202 @@
-/** @packageDocumentation
- * @module Admin
- */
-import * as React from "react";
-import { XAndY } from "@itwin/core-geometry";
-import { AbstractMenuItemProps, AbstractToolbarProps, DialogLayoutDataProvider, DialogProps, IMatch, OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc, Primitives, PropertyDescription, PropertyRecord, RelativePosition, UiAdmin } from "@itwin/appui-abstract";
-/** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
- * @public
- */
-export declare enum KeyinFieldLocalization {
-    /** Include only non-localized key-in strings. */
-    NonLocalized = 0,
-    /** Include only localized key-in strings. */
-    Localized = 1,
-    /** Include localized and non-localized strings for each key-in. */
-    Both = 2
-}
-/** Defines a keyin entry to show/filter in UI
- * @public
-*/
-export interface KeyinEntry {
-    /** string that matched a filter string */
-    value: string;
-    /** define array of start and end positions of filter matches. */
-    matches?: IMatch[];
-    /** true if entry was loaded from key-in history */
-    isHistory?: boolean;
-}
-/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
- * @public
- */
-export declare class FrameworkUiAdmin extends UiAdmin {
-    private _localizedKeyinPreference;
-    get localizedKeyinPreference(): KeyinFieldLocalization;
-    set localizedKeyinPreference(preference: KeyinFieldLocalization);
-    /** @internal */
-    onInitialized(): void;
-    /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY. */
-    get cursorPosition(): XAndY;
-    /** Determines if focus is set to Home */
-    get isFocusOnHome(): boolean;
-    /** Sets focus to Home */
-    setFocusToHome(): void;
-    /** Show a context menu at a particular location.
-     * @param items Properties of the menu items to display.
-     * @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.
-     */
-    showContextMenu(items: AbstractMenuItemProps[], location: XAndY, htmlElement?: HTMLElement): boolean;
-    /** Resolve location and parent element */
-    private resolveHtmlElement;
-    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.
-     */
-    showKeyinPalette(htmlElement?: HTMLElement): boolean;
-    /** Hides the Key-in Palette. */
-    hideKeyinPalette(): boolean;
-    /** Show a Toolbar at a particular location.
-     * @param toolbarProps Properties of the Toolbar to display.
-     * @param location Location of the Toolbar, relative to the origin of htmlElement or the overall window.
-     * @param offset Offset of the Toolbar from the location.
-     * @param onItemExecuted Function invoked after a Toolbar item is executed
-     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
-     * @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.
-     */
-    showToolbar(toolbarProps: AbstractToolbarProps, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, htmlElement?: HTMLElement): boolean;
-    /** Hides the toolbar. */
-    hideToolbar(): boolean;
-    /** Show a menu button at a particular location. A menu button opens a context menu.
-     * @param id Id of the menu button. Multiple menu buttons may be displayed.
-     * @param menuItemsProps Properties of the menu items to display.
-     * @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.
-     */
-    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.
-     */
-    hideMenuButton(id: string): boolean;
-    /** Show a calculator at a particular location.
-     * @param initialValue Value initially displayed in the calculator.
-     * @param resultIcon Icon displayed to the left of the value.
-     * @param location Location of the calculator, relative to the origin of htmlElement or the window.
-     * @param onOk Function called when the OK button or the Enter key is pressed.
-     * @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.
-     */
-    showCalculator(initialValue: number, resultIcon: string, location: XAndY, onOk: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
-    /** Hides the calculator. */
-    hideCalculator(): boolean;
-    /** Show an input editor for an angle value at a particular location.
-     * @param initialValue Value initially displayed in the editor.
-     * @param location Location of the editor, relative to the origin of htmlElement or the window.
-     * @param onCommit Function called when the OK button or the Enter key is pressed.
-     * @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.
-     */
-    showAngleEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
-    /** Show an input editor for a length value at a particular location.
-     * @param initialValue Value initially displayed in the editor.
-     * @param location Location of the editor, relative to the origin of htmlElement or the window.
-     * @param onCommit Function called when the OK button or the Enter key is pressed.
-     * @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.
-     */
-    showLengthEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
-    /** Show an input editor for a height value at a particular location.
-     * @param initialValue Value initially displayed in the editor.
-     * @param location Location of the editor, relative to the origin of htmlElement or the window.
-     * @param onCommit Function called when the OK button or the Enter key is pressed.
-     * @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.
-     */
-    showHeightEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
-    /** Show an input editor for a primitive value at a particular location.
-     * @param initialValue Value initially displayed in the editor.
-     * @param propertyDescription Description of the primitive value property
-     * @param location Location of the editor, relative to the origin of htmlElement or the window.
-     * @param onCommit Function called when the OK button or the Enter key is pressed.
-     * @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.
-     */
-    showInputEditor(initialValue: Primitives.Value, propertyDescription: PropertyDescription, location: XAndY, onCommit: OnValueCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
-    /** Hides the input editor. */
-    hideInputEditor(): boolean;
-    /** Show an HTML element at a particular location.
-     * @param displayElement The HTMLElement to display
-     * @param location Location of the display element, relative to the origin of htmlElement or the window
-     * @param offset Offset of the display element from the location
-     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element
-     * @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.
-     */
-    showHTMLElement(displayElement: HTMLElement, location: XAndY, offset: XAndY, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
-    /** Hides the HTML Element. */
-    hideHTMLElement(): boolean;
-    /** Show a Card containing content, a title and a toolbar at a particular location.
-     * @param content The HTMLElement of the content to display
-     * @param title Title to display at the top of the card.
-     * @param toolbarProps Properties of the Toolbar to display.
-     * @param location Location of the Card, relative to the origin of htmlElement or the window.
-     * @param offset Offset of the Card from the location.
-     * @param onItemExecuted Function invoked after a Toolbar item is executed
-     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
-     * @param relativePosition Position relative to the given location. Defaults to TopRight.
-     * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
-     * @return true if the Card was displayed, false if the Card could not be displayed.
-     */
-    showCard(content: HTMLElement, title: string | PropertyRecord | undefined, toolbarProps: AbstractToolbarProps | undefined, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
-    /** Show a Card containing React-based content, a title and a toolbar at a particular location.
-     * @param content The React node of the content to display
-     * @param title Title to display at the top of the card.
-     * @param toolbarProps Properties of the Toolbar to display.
-     * @param location Location of the Card, relative to the origin of htmlElement or the window.
-     * @param offset Offset of the Card from the location.
-     * @param onItemExecuted Function invoked after a Toolbar item is executed
-     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
-     * @param relativePosition Position relative to the given location. Defaults to TopRight.
-     * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
-     * @return true if the Card was displayed, false if the Card could not be displayed.
-     */
-    showReactCard(content: React.ReactNode, title: string | PropertyRecord | undefined, toolbarProps: AbstractToolbarProps | undefined, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
-    /** Hides the Card. */
-    hideCard(): boolean;
-    /** Opens a Tool Settings Ui popup at a particular location.
-     * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.
-     * @param location Location of the tool settings, relative to the origin of anchorElement or the window
-     * @param offset Offset of the tool settings from the location
-     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
-     * @param relativePosition Position relative to the given location. Defaults to TopRight.
-     * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
-     * @return true if the tool settings were displayed, false if the tool settings could not be displayed.
-     */
-    openToolSettingsPopup(dataProvider: DialogLayoutDataProvider, location: XAndY, offset: XAndY, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
-    /** Closes the Tool Settings Ui popup. */
-    closeToolSettingsPopup(): boolean;
-    /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
-    * @param uiDataProvider The UiDataProvider for the tool settings
-    * @param title Specify title for dialog.
-    * @param isModal Specify if the dialog is opened as a modal or modeless.
-    * @param id Id of the dialog that is used to close it.
-    * @param optionalProps Optional props for Dialog construction.
-    * @return true if the tool settings were displayed, false if the tool settings could not be displayed.
-    */
-    openDialog(uiDataProvider: DialogLayoutDataProvider, title: string, isModal: boolean, id: string, optionalProps?: DialogProps): boolean;
-    /** Closes the Tool Settings Ui popup. */
-    closeDialog(dialogId: string): boolean;
-}
+/** @packageDocumentation
+ * @module Admin
+ */
+import * as React from "react";
+import { XAndY } from "@itwin/core-geometry";
+import { AbstractMenuItemProps, AbstractToolbarProps, DialogLayoutDataProvider, DialogProps, IMatch, OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc, Primitives, PropertyDescription, PropertyRecord, RelativePosition, UiAdmin } from "@itwin/appui-abstract";
+/** Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.
+ * @public
+ */
+export declare enum KeyinFieldLocalization {
+    /** Include only non-localized key-in strings. */
+    NonLocalized = 0,
+    /** Include only localized key-in strings. */
+    Localized = 1,
+    /** Include localized and non-localized strings for each key-in. */
+    Both = 2
+}
+/** Defines a keyin entry to show/filter in UI
+ * @public
+*/
+export interface KeyinEntry {
+    /** string that matched a filter string */
+    value: string;
+    /** define array of start and end positions of filter matches. */
+    matches?: IMatch[];
+    /** true if entry was loaded from key-in history */
+    isHistory?: boolean;
+}
+/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
+ * @public
+ */
+export declare class FrameworkUiAdmin extends UiAdmin {
+    private _localizedKeyinPreference;
+    get localizedKeyinPreference(): KeyinFieldLocalization;
+    set localizedKeyinPreference(preference: KeyinFieldLocalization);
+    /** @internal */
+    onInitialized(): void;
+    /** Gets the cursor X and Y position, which is mouseEvent.pageX and mouseEvent.pageY. */
+    get cursorPosition(): XAndY;
+    /** Determines if focus is set to Home */
+    get isFocusOnHome(): boolean;
+    /** Sets focus to Home */
+    setFocusToHome(): void;
+    /** Show a context menu at a particular location.
+     * @param items Properties of the menu items to display.
+     * @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.
+     */
+    showContextMenu(items: AbstractMenuItemProps[], location: XAndY, htmlElement?: HTMLElement): boolean;
+    /** Resolve location and parent element */
+    private resolveHtmlElement;
+    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.
+     */
+    showKeyinPalette(htmlElement?: HTMLElement): boolean;
+    /** Hides the Key-in Palette. */
+    hideKeyinPalette(): boolean;
+    /** Show a Toolbar at a particular location.
+     * @param toolbarProps Properties of the Toolbar to display.
+     * @param location Location of the Toolbar, relative to the origin of htmlElement or the overall window.
+     * @param offset Offset of the Toolbar from the location.
+     * @param onItemExecuted Function invoked after a Toolbar item is executed
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
+     * @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.
+     */
+    showToolbar(toolbarProps: AbstractToolbarProps, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, htmlElement?: HTMLElement): boolean;
+    /** Hides the toolbar. */
+    hideToolbar(): boolean;
+    /** Show a menu button at a particular location. A menu button opens a context menu.
+     * @param id Id of the menu button. Multiple menu buttons may be displayed.
+     * @param menuItemsProps Properties of the menu items to display.
+     * @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.
+     */
+    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.
+     */
+    hideMenuButton(id: string): boolean;
+    /** Show a calculator at a particular location.
+     * @param initialValue Value initially displayed in the calculator.
+     * @param resultIcon Icon displayed to the left of the value.
+     * @param location Location of the calculator, relative to the origin of htmlElement or the window.
+     * @param onOk Function called when the OK button or the Enter key is pressed.
+     * @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.
+     */
+    showCalculator(initialValue: number, resultIcon: string, location: XAndY, onOk: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
+    /** Hides the calculator. */
+    hideCalculator(): boolean;
+    /** Show an input editor for an angle value at a particular location.
+     * @param initialValue Value initially displayed in the editor.
+     * @param location Location of the editor, relative to the origin of htmlElement or the window.
+     * @param onCommit Function called when the OK button or the Enter key is pressed.
+     * @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.
+     */
+    showAngleEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
+    /** Show an input editor for a length value at a particular location.
+     * @param initialValue Value initially displayed in the editor.
+     * @param location Location of the editor, relative to the origin of htmlElement or the window.
+     * @param onCommit Function called when the OK button or the Enter key is pressed.
+     * @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.
+     */
+    showLengthEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
+    /** Show an input editor for a height value at a particular location.
+     * @param initialValue Value initially displayed in the editor.
+     * @param location Location of the editor, relative to the origin of htmlElement or the window.
+     * @param onCommit Function called when the OK button or the Enter key is pressed.
+     * @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.
+     */
+    showHeightEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
+    /** Show an input editor for a primitive value at a particular location.
+     * @param initialValue Value initially displayed in the editor.
+     * @param propertyDescription Description of the primitive value property
+     * @param location Location of the editor, relative to the origin of htmlElement or the window.
+     * @param onCommit Function called when the OK button or the Enter key is pressed.
+     * @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.
+     */
+    showInputEditor(initialValue: Primitives.Value, propertyDescription: PropertyDescription, location: XAndY, onCommit: OnValueCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean;
+    /** Hides the input editor. */
+    hideInputEditor(): boolean;
+    /** Show an HTML element at a particular location.
+     * @param displayElement The HTMLElement to display
+     * @param location Location of the display element, relative to the origin of htmlElement or the window
+     * @param offset Offset of the display element from the location
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element
+     * @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.
+     */
+    showHTMLElement(displayElement: HTMLElement, location: XAndY, offset: XAndY, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
+    /** Hides the HTML Element. */
+    hideHTMLElement(): boolean;
+    /** Show a Card containing content, a title and a toolbar at a particular location.
+     * @param content The HTMLElement of the content to display
+     * @param title Title to display at the top of the card.
+     * @param toolbarProps Properties of the Toolbar to display.
+     * @param location Location of the Card, relative to the origin of htmlElement or the window.
+     * @param offset Offset of the Card from the location.
+     * @param onItemExecuted Function invoked after a Toolbar item is executed
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
+     * @param relativePosition Position relative to the given location. Defaults to TopRight.
+     * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
+     * @return true if the Card was displayed, false if the Card could not be displayed.
+     */
+    showCard(content: HTMLElement, title: string | PropertyRecord | undefined, toolbarProps: AbstractToolbarProps | undefined, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
+    /** Show a Card containing React-based content, a title and a toolbar at a particular location.
+     * @param content The React node of the content to display
+     * @param title Title to display at the top of the card.
+     * @param toolbarProps Properties of the Toolbar to display.
+     * @param location Location of the Card, relative to the origin of htmlElement or the window.
+     * @param offset Offset of the Card from the location.
+     * @param onItemExecuted Function invoked after a Toolbar item is executed
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
+     * @param relativePosition Position relative to the given location. Defaults to TopRight.
+     * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
+     * @return true if the Card was displayed, false if the Card could not be displayed.
+     */
+    showReactCard(content: React.ReactNode, title: string | PropertyRecord | undefined, toolbarProps: AbstractToolbarProps | undefined, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
+    /** Hides the Card. */
+    hideCard(): boolean;
+    /** Opens a Tool Settings Ui popup at a particular location.
+     * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.
+     * @param location Location of the tool settings, relative to the origin of anchorElement or the window
+     * @param offset Offset of the tool settings from the location
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
+     * @param relativePosition Position relative to the given location. Defaults to TopRight.
+     * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
+     * @return true if the tool settings were displayed, false if the tool settings could not be displayed.
+     */
+    openToolSettingsPopup(dataProvider: DialogLayoutDataProvider, location: XAndY, offset: XAndY, onCancel: OnCancelFunc, relativePosition?: RelativePosition, anchorElement?: HTMLElement): boolean;
+    /** Closes the Tool Settings Ui popup. */
+    closeToolSettingsPopup(): boolean;
+    /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
+    * @param uiDataProvider The UiDataProvider for the tool settings
+    * @param title Specify title for dialog.
+    * @param isModal Specify if the dialog is opened as a modal or modeless.
+    * @param id Id of the dialog that is used to close it.
+    * @param optionalProps Optional props for Dialog construction.
+    * @return true if the tool settings were displayed, false if the tool settings could not be displayed.
+    */
+    openDialog(uiDataProvider: DialogLayoutDataProvider, title: string, isModal: boolean, id: string, optionalProps?: DialogProps): boolean;
+    /** Closes the Tool Settings Ui popup. */
+    closeDialog(dialogId: string): boolean;
+}
 //# sourceMappingURL=FrameworkUiAdmin.d.ts.map