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

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

@@ -1,32 +1,33 @@
-/** @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;
-    /** Activity center field is hidden by default. */
-    activityCenter?: boolean;
-    accuSnapModePicker?: boolean;
-    tileLoadIndicator?: boolean;
-    selectionScope?: boolean;
-    selectionInfo?: boolean;
-}
-/**
- * Provide standard statusbar fields for the SimpleStatusbarWidget
- * @beta
- */
-export declare class StandardStatusbarUiItemsProvider implements UiItemsProvider {
-    private _defaultItems?;
-    get id(): string;
-    constructor(_defaultItems?: DefaultStatusbarItems | undefined);
-    provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[];
-}
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import { UiItemsProvider } from "./UiItemsProvider";
+import { StatusBarItem } from "../statusbar/StatusBarItem";
+/**
+ * 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;
+    /** Activity center field is hidden by default. */
+    activityCenter?: boolean;
+    accuSnapModePicker?: boolean;
+    tileLoadIndicator?: boolean;
+    selectionScope?: boolean;
+    selectionInfo?: boolean;
+}
+/**
+ * Provide standard statusbar fields for the SimpleStatusbarWidget
+ * @beta
+ */
+export declare class StandardStatusbarUiItemsProvider implements UiItemsProvider {
+    private _defaultItems?;
+    get id(): string;
+    constructor(_defaultItems?: DefaultStatusbarItems | undefined);
+    provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): StatusBarItem[];
+}
 //# sourceMappingURL=StandardStatusbarUiItemsProvider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"StandardStatusbarUiItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAoB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAa/F;;;;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,kDAAkD;IAClD,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,gCAAiC,YAAW,eAAe;IAG1D,OAAO,CAAC,aAAa,CAAC;IAFlC,IAAW,EAAE,IAAI,MAAM,CAA2D;gBAE9D,aAAa,CAAC,mCAAuB;IAElD,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;CA0ChH"}
+{"version":3,"file":"StandardStatusbarUiItemsProvider.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAYH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAoB,MAAM,4BAA4B,CAAC;AAE7E;;;;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,kDAAkD;IAClD,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,gCAAiC,YAAW,eAAe;IAG1D,OAAO,CAAC,aAAa,CAAC;IAFlC,IAAW,EAAE,IAAI,MAAM,CAA2D;gBAE9D,aAAa,CAAC,mCAAuB;IAElD,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,aAAa,EAAE;CAmC1G"}

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

@@ -1,70 +1,63 @@
-"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 StandardUiItemsProvider
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StandardStatusbarUiItemsProvider = void 0;
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const StatusBarItemUtilities_1 = require("../statusbar/StatusBarItemUtilities");
-const ToolAssistanceField_1 = require("../statusfields/toolassistance/ToolAssistanceField");
-const MessageCenter_1 = require("../statusfields/MessageCenter");
-const ActivityCenter_1 = require("../statusfields/ActivityCenter");
-const SnapMode_1 = require("../statusfields/SnapMode");
-const SelectionInfo_1 = require("../statusfields/SelectionInfo");
-const TileLoadingIndicator_1 = require("../statusfields/tileloading/TileLoadingIndicator");
-const SelectionScope_1 = require("../statusfields/SelectionScope");
-const Separator_1 = require("../statusbar/Separator");
-/**
- * Provide standard statusbar fields for the SimpleStatusbarWidget
- * @beta
- */
-class StandardStatusbarUiItemsProvider {
-    constructor(_defaultItems) {
-        this._defaultItems = _defaultItems;
-    }
-    get id() { return "appui-react:StandardStatusbarUiItemsProvider"; }
-    provideStatusBarItems(_stageId, _stageUsage, _stageAppData) {
-        var _a;
-        const statusBarItems = [];
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.messageCenter) {
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.MessageCenter", appui_abstract_1.StatusBarSection.Left, 10, React.createElement(MessageCenter_1.MessageCenterField, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.toolAssistance) {
-            if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)
-                statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.PreToolAssistance", appui_abstract_1.StatusBarSection.Left, 15, React.createElement(Separator_1.StatusBarSeparator, null)));
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.ToolAssistance", appui_abstract_1.StatusBarSection.Left, 20, React.createElement(ToolAssistanceField_1.ToolAssistanceField, null)));
-            if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)
-                statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.PostToolAssistance", appui_abstract_1.StatusBarSection.Left, 25, React.createElement(Separator_1.StatusBarSeparator, null)));
-        }
-        // istanbul ignore else
-        if ((_a = this._defaultItems) === null || _a === void 0 ? void 0 : _a.activityCenter) {
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.ActivityCenter", appui_abstract_1.StatusBarSection.Left, 30, React.createElement(ActivityCenter_1.ActivityCenterField, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.SnapMode", appui_abstract_1.StatusBarSection.Center, 10, React.createElement(SnapMode_1.SnapModeField, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.TileLoadIndicator", appui_abstract_1.StatusBarSection.Right, 10, React.createElement(TileLoadingIndicator_1.TileLoadingIndicator, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.selectionScope) {
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.SelectionScope", appui_abstract_1.StatusBarSection.Right, 20, React.createElement(SelectionScope_1.SelectionScopeField, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.selectionInfo) {
-            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createStatusBarItem("uifw.SelectionInfo", appui_abstract_1.StatusBarSection.Right, 30, React.createElement(SelectionInfo_1.SelectionInfoField, null)));
-        }
-        return statusBarItems;
-    }
-}
-exports.StandardStatusbarUiItemsProvider = StandardStatusbarUiItemsProvider;
+"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 StandardUiItemsProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardStatusbarUiItemsProvider = void 0;
+const React = require("react");
+const StatusBarItemUtilities_1 = require("../statusbar/StatusBarItemUtilities");
+const ToolAssistanceField_1 = require("../statusfields/toolassistance/ToolAssistanceField");
+const MessageCenter_1 = require("../statusfields/MessageCenter");
+const ActivityCenter_1 = require("../statusfields/ActivityCenter");
+const SnapMode_1 = require("../statusfields/SnapMode");
+const SelectionInfo_1 = require("../statusfields/SelectionInfo");
+const TileLoadingIndicator_1 = require("../statusfields/tileloading/TileLoadingIndicator");
+const SelectionScope_1 = require("../statusfields/SelectionScope");
+const Separator_1 = require("../statusbar/Separator");
+const StatusBarItem_1 = require("../statusbar/StatusBarItem");
+/**
+ * Provide standard statusbar fields for the SimpleStatusbarWidget
+ * @beta
+ */
+class StandardStatusbarUiItemsProvider {
+    get id() { return "appui-react:StandardStatusbarUiItemsProvider"; }
+    constructor(_defaultItems) {
+        this._defaultItems = _defaultItems;
+    }
+    provideStatusBarItems(_stageId, _stageUsage, _stageAppData) {
+        var _a;
+        const statusBarItems = [];
+        if (!this._defaultItems || this._defaultItems.messageCenter) {
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.MessageCenter", StatusBarItem_1.StatusBarSection.Left, 10, React.createElement(MessageCenter_1.MessageCenterField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.toolAssistance) {
+            if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)
+                statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.PreToolAssistance", StatusBarItem_1.StatusBarSection.Left, 15, React.createElement(Separator_1.StatusBarSeparator, null)));
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.ToolAssistance", StatusBarItem_1.StatusBarSection.Left, 20, React.createElement(ToolAssistanceField_1.ToolAssistanceField, null)));
+            if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)
+                statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.PostToolAssistance", StatusBarItem_1.StatusBarSection.Left, 25, React.createElement(Separator_1.StatusBarSeparator, null)));
+        }
+        if ((_a = this._defaultItems) === null || _a === void 0 ? void 0 : _a.activityCenter) {
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.ActivityCenter", StatusBarItem_1.StatusBarSection.Left, 30, React.createElement(ActivityCenter_1.ActivityCenterField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.SnapMode", StatusBarItem_1.StatusBarSection.Center, 10, React.createElement(SnapMode_1.SnapModeField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.TileLoadIndicator", StatusBarItem_1.StatusBarSection.Right, 10, React.createElement(TileLoadingIndicator_1.TileLoadingIndicator, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.selectionScope) {
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.SelectionScope", StatusBarItem_1.StatusBarSection.Right, 20, React.createElement(SelectionScope_1.SelectionScopeField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.selectionInfo) {
+            statusBarItems.push(StatusBarItemUtilities_1.StatusBarItemUtilities.createCustomItem("uifw.SelectionInfo", StatusBarItem_1.StatusBarSection.Right, 30, React.createElement(SelectionInfo_1.SelectionInfoField, null)));
+        }
+        return statusBarItems;
+    }
+}
+exports.StandardStatusbarUiItemsProvider = StandardStatusbarUiItemsProvider;
 //# sourceMappingURL=StandardStatusbarUiItemsProvider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"StandardStatusbarUiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,0DAA+F;AAC/F,gFAA6E;AAC7E,4FAAyF;AACzF,iEAAmE;AACnE,mEAAqE;AACrE,uDAAyD;AACzD,iEAAmE;AACnE,2FAAwF;AACxF,mEAAqE;AACrE,sDAA4D;AAsB5D;;;GAGG;AACH,MAAa,gCAAgC;IAG3C,YAAoB,aAAqC;QAArC,kBAAa,GAAb,aAAa,CAAwB;IAAI,CAAC;IAF9D,IAAW,EAAE,KAAa,OAAO,8CAA8C,CAAC,CAAC,CAAC;IAI3E,qBAAqB,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QACjD,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,iCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kCAAkB,OAAG,CAAC,CAAC,CAAC;SAC1I;QACD,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B;gBACtE,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,iCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,8BAAkB,OAAG,CAAC,CAAC,CAAC;YAE/I,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,iCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,yCAAmB,OAAG,CAAC,CAAC,CAAC;YAE3I,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,2BAA2B;gBACvE,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,yBAAyB,EAAE,iCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,8BAAkB,OAAG,CAAC,CAAC,CAAC;SACjJ;QACD,uBAAuB;QACvB,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,cAAc,EAAE;YACtC,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,iCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,oCAAmB,OAAG,CAAC,CAAC,CAAC;SAC5I;QACD,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;YAChE,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,eAAe,EAAE,iCAAgB,CAAC,MAAM,EAAE,EAAE,EAAE,oBAAC,wBAAa,OAAG,CAAC,CAAC,CAAC;SAClI;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;YAC/D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,iCAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,2CAAoB,OAAG,CAAC,CAAC,CAAC;SACjJ;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,iCAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,oCAAmB,OAAG,CAAC,CAAC,CAAC;SAC7I;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,iCAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,kCAAkB,OAAG,CAAC,CAAC,CAAC;SAC3I;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF;AA/CD,4EA+CC","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, StatusBarSection, UiItemsProvider } from \"@itwin/appui-abstract\";\r\nimport { StatusBarItemUtilities } from \"../statusbar/StatusBarItemUtilities\";\r\nimport { ToolAssistanceField } from \"../statusfields/toolassistance/ToolAssistanceField\";\r\nimport { MessageCenterField } from \"../statusfields/MessageCenter\";\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\nimport { StatusBarSeparator } from \"../statusbar/Separator\";\r\n\r\n/* eslint-disable deprecation/deprecation */\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  /** Activity center field is hidden by default. */\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 statusbar fields for the SimpleStatusbarWidget\r\n * @beta\r\n */\r\nexport class StandardStatusbarUiItemsProvider implements UiItemsProvider {\r\n  public get id(): string { return \"appui-react:StandardStatusbarUiItemsProvider\"; }\r\n\r\n  constructor(private _defaultItems?: DefaultStatusbarItems) { }\r\n\r\n  public provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.messageCenter) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.MessageCenter\", StatusBarSection.Left, 10, <MessageCenterField />));\r\n    }\r\n    // istanbul ignore else\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, <StatusBarSeparator />));\r\n\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.ToolAssistance\", StatusBarSection.Left, 20, <ToolAssistanceField />));\r\n\r\n      if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.PostToolAssistance\", StatusBarSection.Left, 25, <StatusBarSeparator />));\r\n    }\r\n    // istanbul ignore else\r\n    if (this._defaultItems?.activityCenter) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.ActivityCenter\", StatusBarSection.Left, 30, <ActivityCenterField />));\r\n    }\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SnapMode\", StatusBarSection.Center, 10, <SnapModeField />));\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.TileLoadIndicator\", StatusBarSection.Right, 10, <TileLoadingIndicator />));\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.selectionScope) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SelectionScope\", StatusBarSection.Right, 20, <SelectionScopeField />));\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.selectionInfo) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SelectionInfo\", StatusBarSection.Right, 30, <SelectionInfoField />));\r\n    }\r\n\r\n    return statusBarItems;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StandardStatusbarUiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,gFAA6E;AAC7E,4FAAyF;AACzF,iEAAmE;AACnE,mEAAqE;AACrE,uDAAyD;AACzD,iEAAmE;AACnE,2FAAwF;AACxF,mEAAqE;AACrE,sDAA4D;AAE5D,8DAA6E;AAoB7E;;;GAGG;AACH,MAAa,gCAAgC;IAC3C,IAAW,EAAE,KAAa,OAAO,8CAA8C,CAAC,CAAC,CAAC;IAElF,YAAoB,aAAqC;QAArC,kBAAa,GAAb,aAAa,CAAwB;IAAI,CAAC;IAEvD,qBAAqB,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;;QACrF,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,gCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kCAAkB,OAAG,CAAC,CAAC,CAAC;SACvI;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B;gBACtE,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,wBAAwB,EAAE,gCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,8BAAkB,OAAG,CAAC,CAAC,CAAC;YAE5I,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,gCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,yCAAmB,OAAG,CAAC,CAAC,CAAC;YAExI,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,2BAA2B;gBACvE,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,yBAAyB,EAAE,gCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,8BAAkB,OAAG,CAAC,CAAC,CAAC;SAC9I;QACD,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,cAAc,EAAE;YACtC,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,gCAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,oCAAmB,OAAG,CAAC,CAAC,CAAC;SACzI;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;YAChE,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,eAAe,EAAE,gCAAgB,CAAC,MAAM,EAAE,EAAE,EAAE,oBAAC,wBAAa,OAAG,CAAC,CAAC,CAAC;SAC/H;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;YAC/D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,wBAAwB,EAAE,gCAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,2CAAoB,OAAG,CAAC,CAAC,CAAC;SAC9I;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,gCAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,oCAAmB,OAAG,CAAC,CAAC,CAAC;SAC1I;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,cAAc,CAAC,IAAI,CAAC,+CAAsB,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,gCAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,kCAAkB,OAAG,CAAC,CAAC,CAAC;SACxI;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF;AAxCD,4EAwCC","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 { StatusBarItemUtilities } from \"../statusbar/StatusBarItemUtilities\";\r\nimport { ToolAssistanceField } from \"../statusfields/toolassistance/ToolAssistanceField\";\r\nimport { MessageCenterField } from \"../statusfields/MessageCenter\";\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\nimport { StatusBarSeparator } from \"../statusbar/Separator\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\nimport { StatusBarItem, StatusBarSection } from \"../statusbar/StatusBarItem\";\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  /** Activity center field is hidden by default. */\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 statusbar fields for the SimpleStatusbarWidget\r\n * @beta\r\n */\r\nexport class StandardStatusbarUiItemsProvider implements UiItemsProvider {\r\n  public get id(): string { return \"appui-react:StandardStatusbarUiItemsProvider\"; }\r\n\r\n  constructor(private _defaultItems?: DefaultStatusbarItems) { }\r\n\r\n  public provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): StatusBarItem[] {\r\n    const statusBarItems: StatusBarItem[] = [];\r\n    if (!this._defaultItems || this._defaultItems.messageCenter) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.MessageCenter\", StatusBarSection.Left, 10, <MessageCenterField />));\r\n    }\r\n    if (!this._defaultItems || this._defaultItems.toolAssistance) {\r\n      if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.PreToolAssistance\", StatusBarSection.Left, 15, <StatusBarSeparator />));\r\n\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.ToolAssistance\", StatusBarSection.Left, 20, <ToolAssistanceField />));\r\n\r\n      if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.PostToolAssistance\", StatusBarSection.Left, 25, <StatusBarSeparator />));\r\n    }\r\n    if (this._defaultItems?.activityCenter) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.ActivityCenter\", StatusBarSection.Left, 30, <ActivityCenterField />));\r\n    }\r\n    if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.SnapMode\", StatusBarSection.Center, 10, <SnapModeField />));\r\n    }\r\n\r\n    if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.TileLoadIndicator\", StatusBarSection.Right, 10, <TileLoadingIndicator />));\r\n    }\r\n\r\n    if (!this._defaultItems || this._defaultItems.selectionScope) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.SelectionScope\", StatusBarSection.Right, 20, <SelectionScopeField />));\r\n    }\r\n\r\n    if (!this._defaultItems || this._defaultItems.selectionInfo) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.SelectionInfo\", StatusBarSection.Right, 30, <SelectionInfoField />));\r\n    }\r\n\r\n    return statusBarItems;\r\n  }\r\n}\r\n"]}

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

@@ -1,24 +1,94 @@
-/** @packageDocumentation
- * @module UiProvider
- */
-import { AllowedUiItemProviderOverrides as UIA_AllowedUiItemProviderOverrides, UiItemProviderOverrides as UIA_UiItemProviderOverrides, UiItemProviderRegisteredEventArgs as UIA_UiItemProviderRegisteredEventArgs, UiItemsManager as UIA_UiItemsManager } from "@itwin/appui-abstract";
-/** UiItemsProvider register event args.
- * @beta
- */
-export declare type UiItemsProviderRegisteredEventArgs = UIA_UiItemProviderRegisteredEventArgs;
-/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items
- * @beta
- */
-export declare type AllowedUiItemsProviderOverrides = UIA_AllowedUiItemProviderOverrides;
-/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
- * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
- * items are allowed.
- * @beta
- */
-export declare type UiItemsProviderOverrides = UIA_UiItemProviderOverrides;
-/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
- * @beta
- */
-export declare class UiItemsManager extends UIA_UiItemsManager {
-}
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { BeUiEvent, MarkRequired } from "@itwin/core-bentley";
+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";
+import { ProviderItem } from "./ProviderItem";
+import { UiItemsProvider } from "./UiItemsProvider";
+/** UiItemsProvider register event args.
+ * @public
+ */
+export interface UiItemsProviderRegisteredEventArgs {
+    providerId: string;
+}
+/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items
+ * @public
+ */
+export interface AllowedUiItemsProviderOverrides {
+    /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */
+    providerId?: string;
+    /** if specified then the current stage's Usage will be compared before allowing any items to be provided */
+    stageUsages?: string[];
+    /** if specified then the current stage's Id will be compared before allowing any items to be provided */
+    stageIds?: string[];
+}
+/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
+ * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
+ * items are allowed.
+ * @public
+ */
+export type UiItemsProviderOverrides = MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @public
+ */
+export declare class UiItemsManager {
+    private static _registeredUiItemsProviders;
+    private static _onUiProviderRegisteredEvent;
+    private static _abstractAdapter;
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders(): void;
+    /** Event raised any time a UiProvider is registered or unregistered. */
+    static get onUiProviderRegisteredEvent(): BeUiEvent<UiItemsProviderRegisteredEventArgs>;
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds(): string[];
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders(): boolean;
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
+    private static sendRegisteredEvent;
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void;
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(providerId: string): void;
+    private static allowItemsFromProvider;
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param usage usage of the toolbar
+     * @param orientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId: string, stageUsage: string, usage: ToolbarUsage, orientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>>;
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>>;
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems(): ReadonlyArray<ProviderItem<BackstageItem>>;
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of widgets.
+     */
+    static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>>;
+}
 //# sourceMappingURL=UiItemsManager.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EACL,8BAA8B,IAAI,kCAAkC,EACpE,uBAAuB,IAAI,2BAA2B,EACtD,iCAAiC,IAAI,qCAAqC,EAC1E,cAAc,IAAI,kBAAkB,EACrC,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,oBAAY,kCAAkC,GAAG,qCAAqC,CAAC;AAEvF;;GAEG;AACH,oBAAY,+BAA+B,GAAG,kCAAkC,CAAC;AAEjF;;;;GAIG;AACH,oBAAY,wBAAwB,GAAG,2BAA2B,CAAC;AAEnE;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;CACrD"}
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAU,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACtE,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;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,uJAAuJ;IACvJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAClC,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,CAAC,GAC3E,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,UAAU,CAAC,GACxE,YAAY,CAAC,+BAA+B,EAAE,UAAU,CAAC,GACzD,YAAY,CAAC,+BAA+B,EAAE,aAAa,CAAC,GAC5D,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC;AAQ3F;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA4E;IACtH,OAAO,CAAC,MAAM,CAAC,4BAA4B,CAAuD;IAClG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAyC;IAExE;mBACe;WACD,iBAAiB;IAO/B,wEAAwE;IACxE,WAAkB,2BAA2B,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAK7F;IAED,8CAA8C;IAC9C,WAAkB,qBAAqB,IAAI,MAAM,EAAE,CAMlD;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAKlD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAOjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAgB/F,8EAA8E;WAChE,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAiBlD,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAUrC;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,GAAG,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAuBxK;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAwBhH;;OAEG;WACW,iBAAiB,IAAI,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAwB7E;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;CAwB9J"}

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

@@ -1,19 +1,205 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/* eslint-disable deprecation/deprecation */
-/** @packageDocumentation
- * @module UiProvider
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UiItemsManager = void 0;
-const appui_abstract_1 = require("@itwin/appui-abstract");
-/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
- * @beta
- */
-class UiItemsManager extends appui_abstract_1.UiItemsManager {
-}
-exports.UiItemsManager = UiItemsManager;
+"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.UiItemsManager = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const UiFramework_1 = require("../UiFramework");
+const AbstractUiItemsManager_1 = require("./AbstractUiItemsManager");
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @public
+ */
+class UiItemsManager {
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.clearAllProviders();
+        UiItemsManager._registeredUiItemsProviders.clear();
+    }
+    /** Event raised any time a UiProvider is registered or unregistered. */
+    static get onUiProviderRegisteredEvent() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.onUiProviderRegisteredEvent;
+        return this._onUiProviderRegisteredEvent;
+    }
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.registeredProviderIds;
+        const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];
+        return ids;
+    }
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.hasRegisteredProviders;
+        return this._registeredUiItemsProviders.size > 0;
+    }
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId) {
+        var _a;
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getUiItemsProvider(providerId);
+        return (_a = UiItemsManager._registeredUiItemsProviders.get(providerId)) === null || _a === void 0 ? void 0 : _a.provider;
+    }
+    static sendRegisteredEvent(args) {
+        UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);
+    }
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider, overrides) {
+        var _a;
+        if (this._abstractAdapter)
+            return this._abstractAdapter.register(uiProvider, overrides);
+        const providerId = (_a = overrides === null || overrides === void 0 ? void 0 : overrides.providerId) !== null && _a !== void 0 ? _a : uiProvider.id;
+        if (UiItemsManager.getUiItemsProvider(providerId)) {
+            core_bentley_1.Logger.logInfo(UiFramework_1.UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
+        }
+        else {
+            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
+            core_bentley_1.Logger.logInfo(UiFramework_1.UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
+            UiItemsManager.sendRegisteredEvent({ providerId });
+        }
+    }
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(providerId) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.unregister(providerId);
+        const provider = UiItemsManager.getUiItemsProvider(providerId);
+        if (!provider)
+            return;
+        provider.onUnregister && provider.onUnregister();
+        UiItemsManager._registeredUiItemsProviders.delete(providerId);
+        core_bentley_1.Logger.logInfo(UiFramework_1.UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);
+        // trigger a refresh of the ui
+        UiItemsManager.sendRegisteredEvent({ providerId });
+    }
+    static allowItemsFromProvider(entry, stageId, stageUsage) {
+        // istanbul ignore else
+        const overrides = entry.overrides;
+        if (undefined !== stageId && (overrides === null || overrides === void 0 ? void 0 : overrides.stageIds) && !(overrides.stageIds.some((value) => value === stageId)))
+            return false;
+        if (undefined !== stageUsage && (overrides === null || overrides === void 0 ? void 0 : overrides.stageUsages) && !(overrides.stageUsages.some((value) => value === stageUsage)))
+            return false;
+        return true;
+    }
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param usage usage of the toolbar
+     * @param orientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId, stageUsage, usage, orientation) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getToolbarButtonItems(stageId, stageUsage, usage, orientation);
+        const buttonItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideToolbarItems(stageId, stageUsage, usage, orientation)
+                    .forEach((spec) => {
+                    // ignore duplicate ids
+                    if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
+                        buttonItems.push({ ...spec, providerId });
+                });
+            }
+        });
+        return buttonItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId, stageUsage) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);
+        const statusBarItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideStatusBarItems(stageId, stageUsage)
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
+                        statusBarItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return statusBarItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getBackstageItems();
+        const backstageItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items
+                uiProvider.provideBackstageItems() //       should not be considered stage specific. If they need to be hidden
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))
+                        backstageItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return backstageItems;
+    }
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of widgets.
+     */
+    static getWidgets(stageId, stageUsage, location, section) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getWidgets(stageId, stageUsage, location, section);
+        const widgets = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideWidgets(stageId, stageUsage, location, section)
+                    .forEach((widget) => {
+                    // ignore duplicate ids
+                    if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))
+                        widgets.push({ ...widget, providerId });
+                });
+            }
+        });
+        return widgets;
+    }
+}
+UiItemsManager._registeredUiItemsProviders = new Map();
+UiItemsManager._onUiProviderRegisteredEvent = new core_bentley_1.BeUiEvent();
+UiItemsManager._abstractAdapter = (0, AbstractUiItemsManager_1.createAbstractUiItemsManagerAdapter)();
+exports.UiItemsManager = UiItemsManager;
 //# sourceMappingURL=UiItemsManager.js.map