@itwin/appui-react 3.0.0-dev.100

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

@@ -0,0 +1,44 @@
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage, UiItemsProvider } from "@itwin/appui-abstract";
+/**
+ * Defines what tools to include from the provider. If any tools in the horizontal or vertical group are
+ * specified then only those tools will be provided to stage.
+ * @public
+ */
+export interface DefaultNavigationTools {
+    horizontal?: {
+        rotateView?: boolean;
+        panView?: boolean;
+        fitView?: boolean;
+        windowArea?: boolean;
+        viewUndoRedo?: boolean;
+    };
+    vertical?: {
+        walk?: boolean;
+        toggleCamera?: boolean;
+    };
+}
+/**
+ * Provide standard tools for the ViewNavigationWidgetComposer.
+ * @public
+ */
+export declare class StandardNavigationToolsProvider implements UiItemsProvider {
+    private defaultNavigationTools?;
+    private isSupportedStage?;
+    static providerId: string;
+    readonly id: string;
+    /**
+     * static function to register the StandardContentToolsProvider
+     * @param defaultNavigationTools - if undefined all available tools are provided to stage. If defined only those
+     * specific tool buttons are shown.
+     * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
+     * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
+     */
+    static register(defaultNavigationTools?: DefaultNavigationTools, isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean): void;
+    static unregister(): void;
+    constructor(defaultNavigationTools?: DefaultNavigationTools | undefined, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined);
+    provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[];
+}
+//# sourceMappingURL=StandardNavigationToolsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardNavigationToolsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardNavigationToolsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAc,kBAAkB,EAAE,YAAY,EAAkB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAIzI;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE;QACX,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;CACH;AAED;;;GAGG;AACH,qBAAa,+BAAgC,YAAW,eAAe;IAmBzD,OAAO,CAAC,sBAAsB,CAAC;IAA0B,OAAO,CAAC,gBAAgB,CAAC;IAlB9F,OAAc,UAAU,SAA0C;IAClE,SAAgB,EAAE,SAA8C;IAEhE;;;;;;OAMG;WACW,QAAQ,CAAC,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,OAAO;WAIjJ,UAAU;gBAIJ,sBAAsB,CAAC,oCAAwB,EAAU,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,KAAK,OAAO,aAAA;IAE7J,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;CAyCnL"}

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

@@ -0,0 +1,69 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import { StageUsage, ToolbarOrientation, ToolbarUsage, UiItemsManager } from "@itwin/appui-abstract";
+import { ToolbarHelper } from "../toolbar/ToolbarHelper";
+import { CoreTools } from "../tools/CoreToolDefinitions";
+/**
+ * Provide standard tools for the ViewNavigationWidgetComposer.
+ * @public
+ */
+export class StandardNavigationToolsProvider {
+    constructor(defaultNavigationTools, isSupportedStage) {
+        this.defaultNavigationTools = defaultNavigationTools;
+        this.isSupportedStage = isSupportedStage;
+        this.id = StandardNavigationToolsProvider.providerId;
+    }
+    /**
+     * static function to register the StandardContentToolsProvider
+     * @param defaultNavigationTools - if undefined all available tools are provided to stage. If defined only those
+     * specific tool buttons are shown.
+     * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
+     * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
+     */
+    static register(defaultNavigationTools, isSupportedStage) {
+        UiItemsManager.register(new StandardNavigationToolsProvider(defaultNavigationTools, isSupportedStage));
+    }
+    static unregister() {
+        UiItemsManager.unregister(StandardNavigationToolsProvider.providerId);
+    }
+    provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
+        const items = [];
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage.General);
+        }
+        if (provideToStage && toolbarUsage === ToolbarUsage.ViewNavigation && toolbarOrientation === ToolbarOrientation.Horizontal) {
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.rotateView)
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(10, CoreTools.rotateViewCommand));
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.panView)
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(20, CoreTools.panViewCommand));
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.fitView) {
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(30, CoreTools.fitViewCommand));
+            }
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.windowArea) {
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(40, CoreTools.windowAreaCommand));
+            }
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.viewUndoRedo) {
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(50, CoreTools.viewUndoCommand));
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(60, CoreTools.viewRedoCommand));
+            }
+        }
+        else /* istanbul ignore else */ if (provideToStage && toolbarUsage === ToolbarUsage.ViewNavigation && toolbarOrientation === ToolbarOrientation.Vertical) {
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.vertical || this.defaultNavigationTools.vertical.walk)
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(10, CoreTools.walkViewCommand));
+            if (!this.defaultNavigationTools || !this.defaultNavigationTools.vertical || this.defaultNavigationTools.vertical.toggleCamera)
+                items.push(ToolbarHelper.createToolbarItemFromItemDef(20, CoreTools.toggleCameraViewCommand));
+        }
+        return items;
+    }
+}
+StandardNavigationToolsProvider.providerId = "uifw:StandardNavigationToolsProvider";
+//# sourceMappingURL=StandardNavigationToolsProvider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardNavigationToolsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardNavigationToolsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAqB,UAAU,EAAE,kBAAkB,EAAE,YAAY,EAAE,cAAc,EAAmB,MAAM,uBAAuB,CAAC;AACzI,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAqBzD;;;GAGG;AACH,MAAM,OAAO,+BAA+B;IAmB1C,YAAoB,sBAA+C,EAAU,gBAAuF;QAAhJ,2BAAsB,GAAtB,sBAAsB,CAAyB;QAAU,qBAAgB,GAAhB,gBAAgB,CAAuE;QAjBpJ,OAAE,GAAG,+BAA+B,CAAC,UAAU,CAAC;IAiBwG,CAAC;IAfzK;;;;;;OAMG;IACI,MAAM,CAAC,QAAQ,CAAC,sBAA+C,EAAE,gBAAuF;QAC7J,cAAc,CAAC,QAAQ,CAAC,IAAI,+BAA+B,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACzG,CAAC;IAEM,MAAM,CAAC,UAAU;QACtB,cAAc,CAAC,UAAU,CAAC,+BAA+B,CAAC,UAAU,CAAC,CAAC;IACxE,CAAC;IAIM,yBAAyB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EAAE,kBAAsC,EAAE,YAAkB;QAC1J,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SAC3E;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,IAAI,cAAc,IAAI,YAAY,KAAK,YAAY,CAAC,cAAc,IAAI,kBAAkB,KAAK,kBAAkB,CAAC,UAAU,EAAE;YAE1H,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,UAAU;gBAC9H,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAE1F,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,OAAO;gBAC3H,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;YAEvF,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,OAAO,EAAE;gBAC7H,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;aACtF;YAED,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,UAAU,EAAE;gBAChI,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC;aACzF;YAED,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,YAAY,EAAE;gBAClI,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;gBACtF,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;aACvF;SAEF;aAAM,0BAA0B,CAAC,IAAI,cAAc,IAAI,YAAY,KAAK,YAAY,CAAC,cAAc,IAAI,kBAAkB,KAAK,kBAAkB,CAAC,QAAQ,EAAE;YAE1J,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,IAAI,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI;gBACpH,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;YAExF,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,IAAI,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY;gBAC5H,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAE,EAAE,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC;SACjG;QACD,OAAO,KAAK,CAAC;IACf,CAAC;;AA5Da,0CAAU,GAAG,sCAAsC,CAAC","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 StandardUiItemsProvider\r\n */\r\n\r\nimport { CommonToolbarItem, StageUsage, ToolbarOrientation, ToolbarUsage, UiItemsManager, UiItemsProvider } from \"@itwin/appui-abstract\";\r\nimport { ToolbarHelper } from \"../toolbar/ToolbarHelper\";\r\nimport { CoreTools } from \"../tools/CoreToolDefinitions\";\r\n\r\n/**\r\n * Defines what tools to include from the provider. If any tools in the horizontal or vertical group are\r\n * specified then only those tools will be provided to stage.\r\n * @public\r\n */\r\nexport interface DefaultNavigationTools {\r\n  horizontal?: {\r\n    rotateView?: boolean;\r\n    panView?: boolean;\r\n    fitView?: boolean;\r\n    windowArea?: boolean;\r\n    viewUndoRedo?: boolean;\r\n  };\r\n  vertical?: {\r\n    walk?: boolean;\r\n    toggleCamera?: boolean;\r\n  };\r\n}\r\n\r\n/**\r\n * Provide standard tools for the ViewNavigationWidgetComposer.\r\n * @public\r\n */\r\nexport class StandardNavigationToolsProvider implements UiItemsProvider {\r\n  public static providerId = \"uifw:StandardNavigationToolsProvider\";\r\n  public readonly id = StandardNavigationToolsProvider.providerId;\r\n\r\n  /**\r\n   * static function to register the StandardContentToolsProvider\r\n   * @param defaultNavigationTools - if undefined all available tools are provided to stage. If defined only those\r\n   * specific tool buttons are shown.\r\n   * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\r\n   * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\r\n   */\r\n  public static register(defaultNavigationTools?: DefaultNavigationTools, isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean) {\r\n    UiItemsManager.register(new StandardNavigationToolsProvider(defaultNavigationTools, isSupportedStage));\r\n  }\r\n\r\n  public static unregister() {\r\n    UiItemsManager.unregister(StandardNavigationToolsProvider.providerId);\r\n  }\r\n\r\n  constructor(private defaultNavigationTools?: DefaultNavigationTools, private isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean) { }\r\n\r\n  public provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    const items: CommonToolbarItem[] = [];\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    if (provideToStage && toolbarUsage === ToolbarUsage.ViewNavigation && toolbarOrientation === ToolbarOrientation.Horizontal) {\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.rotateView)\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(10, CoreTools.rotateViewCommand));\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.panView)\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(20, CoreTools.panViewCommand));\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.fitView) {\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(30, CoreTools.fitViewCommand));\r\n      }\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.windowArea) {\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(40, CoreTools.windowAreaCommand));\r\n      }\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.horizontal || this.defaultNavigationTools.horizontal.viewUndoRedo) {\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(50, CoreTools.viewUndoCommand));\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(60, CoreTools.viewRedoCommand));\r\n      }\r\n\r\n    } else /* istanbul ignore else */ if (provideToStage && toolbarUsage === ToolbarUsage.ViewNavigation && toolbarOrientation === ToolbarOrientation.Vertical) {\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.vertical || this.defaultNavigationTools.vertical.walk)\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(10, CoreTools.walkViewCommand));\r\n\r\n      if (!this.defaultNavigationTools || !this.defaultNavigationTools.vertical || this.defaultNavigationTools.vertical.toggleCamera)\r\n        items.push(ToolbarHelper.createToolbarItemFromItemDef(20, CoreTools.toggleCameraViewCommand));\r\n    }\r\n    return items;\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,42 @@
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import { CommonStatusBarItem, UiItemsProvider } from "@itwin/appui-abstract";
+/**
+ * Defines what items to include from the provider. If any items are
+ * specified then only those items will be added to statusbar.
+ * @public
+ */
+export interface DefaultStatusbarItems {
+    messageCenter?: boolean;
+    preToolAssistanceSeparator?: boolean;
+    toolAssistance?: boolean;
+    postToolAssistanceSeparator?: boolean;
+    activityCenter?: boolean;
+    accuSnapModePicker?: boolean;
+    tileLoadIndicator?: boolean;
+    selectionScope?: boolean;
+    selectionInfo?: boolean;
+}
+/**
+ * Provide standard tools for the SimpleStatusbarWidget
+ * @public
+ */
+export declare class StandardStatusbarItemsProvider implements UiItemsProvider {
+    private _defaultItems?;
+    private _isSupportedStage?;
+    static providerId: string;
+    readonly id: string;
+    constructor(_defaultItems?: DefaultStatusbarItems | undefined, _isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined);
+    /**
+    * static function to register the StandardStatusbarItemsProvider
+    * @param defaultItems - if undefined all available tools are provided to stage. If defined only those
+    * specific tool buttons are shown.
+    * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
+    * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
+    */
+    static register(defaultItems?: DefaultStatusbarItems, isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean): void;
+    static unregister(): void;
+    provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[];
+}
+//# sourceMappingURL=StandardStatusbarItemsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardStatusbarItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarItemsProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAgD,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAa3H;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,qBAAa,8BAA+B,YAAW,eAAe;IAIxD,OAAO,CAAC,aAAa,CAAC;IAAyB,OAAO,CAAC,iBAAiB,CAAC;IAHrF,OAAc,UAAU,SAAyC;IACjE,SAAgB,EAAE,SAA6C;gBAE3C,aAAa,CAAC,mCAAuB,EAAU,iBAAiB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,KAAK,OAAO,aAAA;IAE3J;;;;;;MAME;WACY,QAAQ,CAAC,YAAY,CAAC,EAAE,qBAAqB,EAAE,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,OAAO;WAItI,UAAU;IAIjB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;CAqD7G"}

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

@@ -0,0 +1,92 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import * as React from "react";
+import { StageUsage, StatusBarSection, UiItemsManager } from "@itwin/appui-abstract";
+import { FooterSeparator } from "@itwin/appui-layout-react";
+import { StatusBarItemUtilities } from "../statusbar/StatusBarItemUtilities";
+import { ToolAssistanceField } from "../statusfields/toolassistance/ToolAssistanceField";
+import { withStatusFieldProps } from "../statusbar/withStatusFieldProps";
+import { MessageCenterField } from "../statusfields/MessageCenter";
+import { withMessageCenterFieldProps } from "../statusbar/withMessageCenterFieldProps";
+import { ActivityCenterField } from "../statusfields/ActivityCenter";
+import { SnapModeField } from "../statusfields/SnapMode";
+import { SelectionInfoField } from "../statusfields/SelectionInfo";
+import { TileLoadingIndicator } from "../statusfields/tileloading/TileLoadingIndicator";
+import { SelectionScopeField } from "../statusfields/SelectionScope";
+/**
+ * Provide standard tools for the SimpleStatusbarWidget
+ * @public
+ */
+export class StandardStatusbarItemsProvider {
+    constructor(_defaultItems, _isSupportedStage) {
+        this._defaultItems = _defaultItems;
+        this._isSupportedStage = _isSupportedStage;
+        this.id = StandardStatusbarItemsProvider.providerId;
+    }
+    /**
+    * static function to register the StandardStatusbarItemsProvider
+    * @param defaultItems - if undefined all available tools are provided to stage. If defined only those
+    * specific tool buttons are shown.
+    * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
+    * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
+    */
+    static register(defaultItems, isSupportedStage) {
+        UiItemsManager.register(new StandardStatusbarItemsProvider(defaultItems, isSupportedStage));
+    }
+    static unregister() {
+        UiItemsManager.unregister(StandardStatusbarItemsProvider.providerId);
+    }
+    provideStatusBarItems(stageId, stageUsage, stageAppData) {
+        const statusBarItems = [];
+        let provideToStage = false;
+        if (this._isSupportedStage) {
+            provideToStage = this._isSupportedStage(stageId, stageUsage, stageAppData);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage.General);
+        }
+        /* istanbul ignore else */
+        if (provideToStage) {
+            if (!this._defaultItems || this._defaultItems.messageCenter) {
+                const MessageCenter = withMessageCenterFieldProps(MessageCenterField);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.MessageCenter", StatusBarSection.Left, 10, React.createElement(MessageCenter, null)));
+            }
+            if (!this._defaultItems || this._defaultItems.toolAssistance) {
+                if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)
+                    statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.PreToolAssistance", StatusBarSection.Left, 15, React.createElement(FooterSeparator, null)));
+                const ToolAssistance = withStatusFieldProps(ToolAssistanceField);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.ToolAssistance", StatusBarSection.Left, 20, React.createElement(ToolAssistance, null)));
+                if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)
+                    statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.PostToolAssistance", StatusBarSection.Left, 25, React.createElement(FooterSeparator, null)));
+            }
+            if (!this._defaultItems || this._defaultItems.activityCenter) {
+                const ActivityCenter = withStatusFieldProps(ActivityCenterField);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.ActivityCenter", StatusBarSection.Left, 30, React.createElement(ActivityCenter, null)));
+            }
+            if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {
+                const SnapMode = withMessageCenterFieldProps(SnapModeField);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.SnapMode", StatusBarSection.Center, 10, React.createElement(SnapMode, null)));
+            }
+            if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {
+                const TileLoadIndicator = withStatusFieldProps(TileLoadingIndicator);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.TileLoadIndicator", StatusBarSection.Right, 10, React.createElement(TileLoadIndicator, null)));
+            }
+            if (!this._defaultItems || this._defaultItems.selectionScope) {
+                const SelectionScope = withStatusFieldProps(SelectionScopeField);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.SelectionScope", StatusBarSection.Right, 20, React.createElement(SelectionScope, null)));
+            }
+            if (!this._defaultItems || this._defaultItems.selectionInfo) {
+                const SelectionInfo = withStatusFieldProps(SelectionInfoField);
+                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.SelectionInfo", StatusBarSection.Right, 30, React.createElement(SelectionInfo, null)));
+            }
+        }
+        return statusBarItems;
+    }
+}
+StandardStatusbarItemsProvider.providerId = "uifw:StandardStatusbarItemsProvider";
+//# sourceMappingURL=StandardStatusbarItemsProvider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardStatusbarItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarItemsProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAuB,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAmB,MAAM,uBAAuB,CAAC;AAC3H,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAmBrE;;;GAGG;AACH,MAAM,OAAO,8BAA8B;IAIzC,YAAoB,aAAqC,EAAU,iBAAwF;QAAvI,kBAAa,GAAb,aAAa,CAAwB;QAAU,sBAAiB,GAAjB,iBAAiB,CAAuE;QAF3I,OAAE,GAAG,8BAA8B,CAAC,UAAU,CAAC;IAEgG,CAAC;IAEhK;;;;;;MAME;IACK,MAAM,CAAC,QAAQ,CAAC,YAAoC,EAAE,gBAAuF;QAClJ,cAAc,CAAC,QAAQ,CAAC,IAAI,8BAA8B,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,UAAU;QACtB,cAAc,CAAC,UAAU,CAAC,8BAA8B,CAAC,UAAU,CAAC,CAAC;IACvE,CAAC;IAEM,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QAClF,MAAM,cAAc,GAA0B,EAAE,CAAC;QACjD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SAC5E;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,0BAA0B;QAC1B,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;gBAC3D,MAAM,aAAa,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;gBACtE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,aAAa,OAAG,CAAC,CAAC,CAAC;aACrI;YACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;gBAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B;oBACtE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,eAAe,OAAG,CAAC,CAAC,CAAC;gBAE5I,MAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;gBACjE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,cAAc,OAAG,CAAC,CAAC,CAAC;gBAEtI,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,2BAA2B;oBACvE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,eAAe,OAAG,CAAC,CAAC,CAAC;aAC9I;YACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;gBAC5D,MAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;gBACjE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,cAAc,OAAG,CAAC,CAAC,CAAC;aACvI;YACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;gBAChE,MAAM,QAAQ,GAAG,2BAA2B,CAAC,aAAa,CAAC,CAAC;gBAC5D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,EAAE,gBAAgB,CAAC,MAAM,EAAE,EAAE,EAAE,oBAAC,QAAQ,OAAG,CAAC,CAAC,CAAC;aAC7H;YAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;gBAC/D,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;gBACrE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,iBAAiB,OAAG,CAAC,CAAC,CAAC;aAC9I;YAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;gBAC5D,MAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;gBACjE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,cAAc,OAAG,CAAC,CAAC,CAAC;aACxI;YAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;gBAC3D,MAAM,aAAa,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;gBAC/D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,aAAa,OAAG,CAAC,CAAC,CAAC;aACtI;SACF;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;;AAxEa,yCAAU,GAAG,qCAAqC,CAAC","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 StandardUiItemsProvider\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonStatusBarItem, StageUsage, StatusBarSection, UiItemsManager, UiItemsProvider } from \"@itwin/appui-abstract\";\r\nimport { FooterSeparator } from \"@itwin/appui-layout-react\";\r\nimport { StatusBarItemUtilities } from \"../statusbar/StatusBarItemUtilities\";\r\nimport { ToolAssistanceField } from \"../statusfields/toolassistance/ToolAssistanceField\";\r\nimport { withStatusFieldProps } from \"../statusbar/withStatusFieldProps\";\r\nimport { MessageCenterField } from \"../statusfields/MessageCenter\";\r\nimport { withMessageCenterFieldProps } from \"../statusbar/withMessageCenterFieldProps\";\r\nimport { ActivityCenterField } from \"../statusfields/ActivityCenter\";\r\nimport { SnapModeField } from \"../statusfields/SnapMode\";\r\nimport { SelectionInfoField } from \"../statusfields/SelectionInfo\";\r\nimport { TileLoadingIndicator } from \"../statusfields/tileloading/TileLoadingIndicator\";\r\nimport { SelectionScopeField } from \"../statusfields/SelectionScope\";\r\n\r\n/**\r\n * Defines what items to include from the provider. If any items are\r\n * specified then only those items will be added to statusbar.\r\n * @public\r\n */\r\nexport interface DefaultStatusbarItems {\r\n  messageCenter?: boolean;\r\n  preToolAssistanceSeparator?: boolean;\r\n  toolAssistance?: boolean;\r\n  postToolAssistanceSeparator?: boolean;\r\n  activityCenter?: boolean;\r\n  accuSnapModePicker?: boolean;\r\n  tileLoadIndicator?: boolean;\r\n  selectionScope?: boolean;\r\n  selectionInfo?: boolean;\r\n}\r\n\r\n/**\r\n * Provide standard tools for the SimpleStatusbarWidget\r\n * @public\r\n */\r\nexport class StandardStatusbarItemsProvider implements UiItemsProvider {\r\n  public static providerId = \"uifw:StandardStatusbarItemsProvider\";\r\n  public readonly id = StandardStatusbarItemsProvider.providerId;\r\n\r\n  constructor(private _defaultItems?: DefaultStatusbarItems, private _isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean) { }\r\n\r\n  /**\r\n  * static function to register the StandardStatusbarItemsProvider\r\n  * @param defaultItems - if undefined all available tools are provided to stage. If defined only those\r\n  * specific tool buttons are shown.\r\n  * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\r\n  * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\r\n  */\r\n  public static register(defaultItems?: DefaultStatusbarItems, isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean) {\r\n    UiItemsManager.register(new StandardStatusbarItemsProvider(defaultItems, isSupportedStage));\r\n  }\r\n\r\n  public static unregister() {\r\n    UiItemsManager.unregister(StandardStatusbarItemsProvider.providerId);\r\n  }\r\n\r\n  public provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n    let provideToStage = false;\r\n\r\n    if (this._isSupportedStage) {\r\n      provideToStage = this._isSupportedStage(stageId, stageUsage, stageAppData);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    /* istanbul ignore else */\r\n    if (provideToStage) {\r\n      if (!this._defaultItems || this._defaultItems.messageCenter) {\r\n        const MessageCenter = withMessageCenterFieldProps(MessageCenterField);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.MessageCenter\", StatusBarSection.Left, 10, <MessageCenter />));\r\n      }\r\n      if (!this._defaultItems || this._defaultItems.toolAssistance) {\r\n        if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)\r\n          statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.PreToolAssistance\", StatusBarSection.Left, 15, <FooterSeparator />));\r\n\r\n        const ToolAssistance = withStatusFieldProps(ToolAssistanceField);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.ToolAssistance\", StatusBarSection.Left, 20, <ToolAssistance />));\r\n\r\n        if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)\r\n          statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.PostToolAssistance\", StatusBarSection.Left, 25, <FooterSeparator />));\r\n      }\r\n      if (!this._defaultItems || this._defaultItems.activityCenter) {\r\n        const ActivityCenter = withStatusFieldProps(ActivityCenterField);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.ActivityCenter\", StatusBarSection.Left, 30, <ActivityCenter />));\r\n      }\r\n      if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {\r\n        const SnapMode = withMessageCenterFieldProps(SnapModeField);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SnapMode\", StatusBarSection.Center, 10, <SnapMode />));\r\n      }\r\n\r\n      if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {\r\n        const TileLoadIndicator = withStatusFieldProps(TileLoadingIndicator);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.TileLoadIndicator\", StatusBarSection.Right, 10, <TileLoadIndicator />));\r\n      }\r\n\r\n      if (!this._defaultItems || this._defaultItems.selectionScope) {\r\n        const SelectionScope = withStatusFieldProps(SelectionScopeField);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SelectionScope\", StatusBarSection.Right, 20, <SelectionScope />));\r\n      }\r\n\r\n      if (!this._defaultItems || this._defaultItems.selectionInfo) {\r\n        const SelectionInfo = withStatusFieldProps(SelectionInfoField);\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SelectionInfo\", StatusBarSection.Right, 30, <SelectionInfo />));\r\n      }\r\n    }\r\n\r\n    return statusBarItems;\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +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;
+}
+//# sourceMappingURL=FrameworkUiAdmin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkUiAdmin.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/uiadmin/FrameworkUiAdmin.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,OAAO,EACL,qBAAqB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,WAAW,EAAE,MAAM,EAC1F,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EACvE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,EAAE,OAAO,EAC3E,MAAM,uBAAuB,CAAC;AAY/B;;GAEG;AACH,oBAAY,sBAAsB;IAChC,iDAAiD;IACjD,YAAY,IAAA;IACZ,6CAA6C;IAC7C,SAAS,IAAA;IACT,mEAAmE;IACnE,IAAI,IAAA;CACL;AAED;;EAEE;AACF,MAAM,WAAW,UAAU;IACzB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,OAAO;IAC3C,OAAO,CAAC,yBAAyB,CAA+D;IAEhG,IAAW,wBAAwB,IAAI,sBAAsB,CAA2C;IACxG,IAAW,wBAAwB,CAAC,UAAU,EAAE,sBAAsB,EAAkD;IAExH,gBAAgB;IACA,aAAa;IAE7B,wFAAwF;IACxF,IAAoB,cAAc,IAAI,KAAK,CAA6C;IAExF,yCAAyC;IACzC,IAAoB,aAAa,IAAI,OAAO,CAAkD;IAE9F,yBAAyB;IACT,cAAc,IAAI,IAAI;IAEtC;;;;;OAKG;IACa,eAAe,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAkBpH,0CAA0C;IAC1C,OAAO,CAAC,kBAAkB;IAMnB,SAAS,IAAI,UAAU,EAAE;IA0BhC;;;OAGG;IACa,gBAAgB,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAepE,gCAAgC;IAChB,gBAAgB,IAAI,OAAO;IAO3C;;;;;;;;;OASG;IACa,WAAW,CAAC,YAAY,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAC5F,cAAc,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAC1D,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,WAAW,CAAC,EAAE,WAAW,GAC7D,OAAO;IASV,yBAAyB;IACT,WAAW,IAAI,OAAO;IAItC;;;;;;OAMG;IACa,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,qBAAqB,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAMxI;;;OAGG;IACa,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAInD;;;;;;;;OAQG;IACa,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAM/K,4BAA4B;IACZ,cAAc,IAAI,OAAO;IAIzC;;;;;;;OAOG;IACa,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAMhK;;;;;;;OAOG;IACa,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAMjK;;;;;;;OAOG;IACa,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAMjK;;;;;;;;OAQG;IACa,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO;IAMnN,8BAA8B;IACd,eAAe,IAAI,OAAO;IAI1C;;;;;;;;OAQG;IACa,eAAe,CAC7B,cAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EACnF,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO;IAU5E,8BAA8B;IACd,eAAe,IAAI,OAAO;IAI1C;;;;;;;;;;;OAWG;IACa,QAAQ,CACtB,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,EAAE,YAAY,EAAE,oBAAoB,GAAG,SAAS,EAChH,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAC1F,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO;IAU5E;;;;;;;;;;;OAWG;IACI,aAAa,CAClB,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,EAAE,YAAY,EAAE,oBAAoB,GAAG,SAAS,EACpH,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAC1F,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO;IAW5E,sBAAsB;IACN,QAAQ,IAAI,OAAO;IAInC;;;;;;;;OAQG;IACa,qBAAqB,CACnC,YAAY,EAAE,wBAAwB,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,WAAW,GAC/J,OAAO;IASV,yCAAyC;IACzB,sBAAsB,IAAI,OAAO;IAIjD;;;;;;;MAOE;IACc,UAAU,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO;IAUvJ,yCAAyC;IACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;CAgBvD"}