@itwin/appui-react 4.17.6 → 5.0.0-dev.3

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

@@ -0,0 +1,37 @@
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import type { ToolbarItem } from "../toolbar/ToolbarItem.js";
+import { ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem.js";
+import type { UiItemsProvider } from "./UiItemsProvider.js";
+/**
+ * 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;
+        setupWalkCamera?: boolean;
+    };
+}
+/** Provide standard view navigation items.
+ * @public
+ */
+export declare class StandardNavigationToolsUiItemsProvider implements UiItemsProvider {
+    private defaultNavigationTools?;
+    get id(): string;
+    constructor(defaultNavigationTools?: DefaultNavigationTools | undefined);
+    /** @deprecated in 4.17.0. Property of a deprecated interface {@link UiItemsProvider.provideToolbarItems}. */
+    provideToolbarItems(_stageId: string, _stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, _stageAppData?: any): ToolbarItem[];
+    getToolbarItems(): readonly ToolbarItem[];
+}
+//# sourceMappingURL=StandardNavigationToolsUiItemsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardNavigationToolsUiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-react/ui-items-provider/StandardNavigationToolsUiItemsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;;;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;QACvB,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;GAEG;AACH,qBAAa,sCAAuC,YAAW,eAAe;IAKhE,OAAO,CAAC,sBAAsB,CAAC;IAJ3C,IAAW,EAAE,IAAI,MAAM,CAEtB;gBAEmB,sBAAsB,CAAC,oCAAwB;IAEnE,6GAA6G;IACtG,mBAAmB,CACxB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,YAAY,EAC1B,kBAAkB,EAAE,kBAAkB,EACtC,aAAa,CAAC,EAAE,GAAG,GAClB,WAAW,EAAE;IAQT,eAAe,IAAI,SAAS,WAAW,EAAE;CAwHjD"}

package/lib/appui-react/ui-items-provider/StandardNavigationToolsUiItemsProvider.js

@@ -0,0 +1,105 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem.js";
+import { ToolbarItems } from "../tools/ToolbarItems.js";
+/** Provide standard view navigation items.
+ * @public
+ */
+export class StandardNavigationToolsUiItemsProvider {
+    get id() {
+        return "appui-react:StandardNavigationToolsUiItemsProvider";
+    }
+    constructor(defaultNavigationTools) {
+        this.defaultNavigationTools = defaultNavigationTools;
+    }
+    /** @deprecated in 4.17.0. Property of a deprecated interface {@link UiItemsProvider.provideToolbarItems}. */
+    provideToolbarItems(_stageId, _stageUsage, toolbarUsage, toolbarOrientation, _stageAppData) {
+        return this.getToolbarItems().filter((item) => item.layouts?.standard?.orientation === toolbarOrientation &&
+            item.layouts?.standard?.usage === toolbarUsage);
+    }
+    getToolbarItems() {
+        const items = [];
+        const horizontal = {
+            standard: {
+                orientation: ToolbarOrientation.Horizontal,
+                usage: ToolbarUsage.ViewNavigation,
+            },
+        };
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.horizontal ||
+            this.defaultNavigationTools.horizontal.rotateView)
+            items.push(ToolbarItems.createRotateView({
+                itemPriority: 10,
+                layouts: horizontal,
+            }));
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.horizontal ||
+            this.defaultNavigationTools.horizontal.panView)
+            items.push(ToolbarItems.createPanView({
+                itemPriority: 20,
+                layouts: horizontal,
+            }));
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.horizontal ||
+            this.defaultNavigationTools.horizontal.fitView) {
+            items.push(ToolbarItems.createFitView({
+                itemPriority: 30,
+                layouts: horizontal,
+            }));
+        }
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.horizontal ||
+            this.defaultNavigationTools.horizontal.windowArea) {
+            items.push(ToolbarItems.createWindowArea({
+                itemPriority: 40,
+                layouts: horizontal,
+            }));
+        }
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.horizontal ||
+            this.defaultNavigationTools.horizontal.viewUndoRedo) {
+            items.push(ToolbarItems.createViewUndo({
+                itemPriority: 50,
+                layouts: horizontal,
+            }));
+            items.push(ToolbarItems.createViewRedo({
+                itemPriority: 60,
+                layouts: horizontal,
+            }));
+        }
+        const vertical = {
+            standard: {
+                orientation: ToolbarOrientation.Vertical,
+                usage: ToolbarUsage.ViewNavigation,
+            },
+        };
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.vertical ||
+            this.defaultNavigationTools.vertical.setupWalkCamera)
+            items.push(ToolbarItems.createSetupWalkCamera({
+                itemPriority: 5,
+                layouts: vertical,
+            }));
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.vertical ||
+            this.defaultNavigationTools.vertical.walk)
+            items.push(ToolbarItems.createWalkView({
+                itemPriority: 10,
+                layouts: vertical,
+            }));
+        if (!this.defaultNavigationTools ||
+            !this.defaultNavigationTools.vertical ||
+            this.defaultNavigationTools.vertical.toggleCamera)
+            items.push(ToolbarItems.createToggleCameraView({
+                itemPriority: 20,
+                layouts: vertical,
+            }));
+        return items;
+    }
+}
+//# sourceMappingURL=StandardNavigationToolsUiItemsProvider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardNavigationToolsUiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-react/ui-items-provider/StandardNavigationToolsUiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAuBxD;;GAEG;AACH,MAAM,OAAO,sCAAsC;IACjD,IAAW,EAAE;QACX,OAAO,oDAAoD,CAAC;IAC9D,CAAC;IAED,YAAoB,sBAA+C;QAA/C,2BAAsB,GAAtB,sBAAsB,CAAyB;IAAG,CAAC;IAEvE,6GAA6G;IACtG,mBAAmB,CACxB,QAAgB,EAChB,WAAmB,EACnB,YAA0B,EAC1B,kBAAsC,EACtC,aAAmB;QAEnB,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC,MAAM,CAClC,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,KAAK,kBAAkB;YAC1D,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,KAAK,YAAY,CACjD,CAAC;IACJ,CAAC;IAEM,eAAe;QACpB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE;gBACR,WAAW,EAAE,kBAAkB,CAAC,UAAU;gBAC1C,KAAK,EAAE,YAAY,CAAC,cAAc;aACnC;SACF,CAAC;QACF,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU;YACvC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,UAAU;YAEjD,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,gBAAgB,CAAC;gBAC5B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,UAAU;aACpB,CAAC,CACH,CAAC;QAEJ,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU;YACvC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,OAAO;YAE9C,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,aAAa,CAAC;gBACzB,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,UAAU;aACpB,CAAC,CACH,CAAC;QAEJ,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU;YACvC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,OAAO,EAC9C,CAAC;YACD,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,aAAa,CAAC;gBACzB,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,UAAU;aACpB,CAAC,CACH,CAAC;QACJ,CAAC;QAED,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU;YACvC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,UAAU,EACjD,CAAC;YACD,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,gBAAgB,CAAC;gBAC5B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,UAAU;aACpB,CAAC,CACH,CAAC;QACJ,CAAC;QAED,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,UAAU;YACvC,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,YAAY,EACnD,CAAC;YACD,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,cAAc,CAAC;gBAC1B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,UAAU;aACpB,CAAC,CACH,CAAC;YACF,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,cAAc,CAAC;gBAC1B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,UAAU;aACpB,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,QAAQ,EAAE;gBACR,WAAW,EAAE,kBAAkB,CAAC,QAAQ;gBACxC,KAAK,EAAE,YAAY,CAAC,cAAc;aACnC;SACF,CAAC;QACF,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ;YACrC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,eAAe;YAEpD,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,qBAAqB,CAAC;gBACjC,YAAY,EAAE,CAAC;gBACf,OAAO,EAAE,QAAQ;aAClB,CAAC,CACH,CAAC;QAEJ,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ;YACrC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI;YAEzC,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,cAAc,CAAC;gBAC1B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,QAAQ;aAClB,CAAC,CACH,CAAC;QAEJ,IACE,CAAC,IAAI,CAAC,sBAAsB;YAC5B,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ;YACrC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY;YAEjD,KAAK,CAAC,IAAI,CACR,YAAY,CAAC,sBAAsB,CAAC;gBAClC,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,QAAQ;aAClB,CAAC,CACH,CAAC;QACJ,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module StandardUiItemsProvider\n */\n\nimport type { ToolbarItem } from \"../toolbar/ToolbarItem.js\";\nimport { ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem.js\";\nimport { ToolbarItems } from \"../tools/ToolbarItems.js\";\nimport type { UiItemsProvider } from \"./UiItemsProvider.js\";\n\n/**\n * Defines what tools to include from the provider. If any tools in the horizontal or vertical group are\n * specified then only those tools will be provided to stage.\n * @public\n */\nexport interface DefaultNavigationTools {\n  horizontal?: {\n    rotateView?: boolean;\n    panView?: boolean;\n    fitView?: boolean;\n    windowArea?: boolean;\n    viewUndoRedo?: boolean;\n  };\n  vertical?: {\n    walk?: boolean;\n    toggleCamera?: boolean;\n    setupWalkCamera?: boolean;\n  };\n}\n\n/** Provide standard view navigation items.\n * @public\n */\nexport class StandardNavigationToolsUiItemsProvider implements UiItemsProvider {\n  public get id(): string {\n    return \"appui-react:StandardNavigationToolsUiItemsProvider\";\n  }\n\n  constructor(private defaultNavigationTools?: DefaultNavigationTools) {}\n\n  /** @deprecated in 4.17.0. Property of a deprecated interface {@link UiItemsProvider.provideToolbarItems}. */\n  public provideToolbarItems(\n    _stageId: string,\n    _stageUsage: string,\n    toolbarUsage: ToolbarUsage,\n    toolbarOrientation: ToolbarOrientation,\n    _stageAppData?: any\n  ): ToolbarItem[] {\n    return this.getToolbarItems().filter(\n      (item) =>\n        item.layouts?.standard?.orientation === toolbarOrientation &&\n        item.layouts?.standard?.usage === toolbarUsage\n    );\n  }\n\n  public getToolbarItems(): readonly ToolbarItem[] {\n    const items: ToolbarItem[] = [];\n    const horizontal = {\n      standard: {\n        orientation: ToolbarOrientation.Horizontal,\n        usage: ToolbarUsage.ViewNavigation,\n      },\n    };\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.horizontal ||\n      this.defaultNavigationTools.horizontal.rotateView\n    )\n      items.push(\n        ToolbarItems.createRotateView({\n          itemPriority: 10,\n          layouts: horizontal,\n        })\n      );\n\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.horizontal ||\n      this.defaultNavigationTools.horizontal.panView\n    )\n      items.push(\n        ToolbarItems.createPanView({\n          itemPriority: 20,\n          layouts: horizontal,\n        })\n      );\n\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.horizontal ||\n      this.defaultNavigationTools.horizontal.fitView\n    ) {\n      items.push(\n        ToolbarItems.createFitView({\n          itemPriority: 30,\n          layouts: horizontal,\n        })\n      );\n    }\n\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.horizontal ||\n      this.defaultNavigationTools.horizontal.windowArea\n    ) {\n      items.push(\n        ToolbarItems.createWindowArea({\n          itemPriority: 40,\n          layouts: horizontal,\n        })\n      );\n    }\n\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.horizontal ||\n      this.defaultNavigationTools.horizontal.viewUndoRedo\n    ) {\n      items.push(\n        ToolbarItems.createViewUndo({\n          itemPriority: 50,\n          layouts: horizontal,\n        })\n      );\n      items.push(\n        ToolbarItems.createViewRedo({\n          itemPriority: 60,\n          layouts: horizontal,\n        })\n      );\n    }\n\n    const vertical = {\n      standard: {\n        orientation: ToolbarOrientation.Vertical,\n        usage: ToolbarUsage.ViewNavigation,\n      },\n    };\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.vertical ||\n      this.defaultNavigationTools.vertical.setupWalkCamera\n    )\n      items.push(\n        ToolbarItems.createSetupWalkCamera({\n          itemPriority: 5,\n          layouts: vertical,\n        })\n      );\n\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.vertical ||\n      this.defaultNavigationTools.vertical.walk\n    )\n      items.push(\n        ToolbarItems.createWalkView({\n          itemPriority: 10,\n          layouts: vertical,\n        })\n      );\n\n    if (\n      !this.defaultNavigationTools ||\n      !this.defaultNavigationTools.vertical ||\n      this.defaultNavigationTools.vertical.toggleCamera\n    )\n      items.push(\n        ToolbarItems.createToggleCameraView({\n          itemPriority: 20,\n          layouts: vertical,\n        })\n      );\n    return items;\n  }\n}\n"]}

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

@@ -0,0 +1,26 @@
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import type { DefaultStatusbarItems } from "./StandardStatusbarUiItemsProvider.js";
+import type { StatusBarItem } from "../statusbar/StatusBarItem.js";
+import { BaseUiItemsProvider } from "./BaseUiItemsProvider.js";
+/** Provide standard status bar fields.
+ * @public
+ * @deprecated in 4.17.0. Use {@link StandardStatusbarUiItemsProvider} instead. Supported frontstages can be specified when registering the provider.
+ */
+export declare class StandardStatusbarItemsProvider extends BaseUiItemsProvider {
+    private uiItemsProvider;
+    constructor(providerId: string, _defaultItems?: DefaultStatusbarItems | undefined, isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean);
+    /**
+     * static function to register the StandardStatusbarItemsProvider
+     * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want
+     * to set up custom stage with their own subset of standard status bar items.
+     * @param defaultItems - if undefined all available item are provided to stage except for activityCenter. 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(providerId: string, defaultItems?: DefaultStatusbarItems, isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean): StandardStatusbarItemsProvider;
+    provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): StatusBarItem[];
+}
+//# sourceMappingURL=StandardStatusbarItemsProvider.d.ts.map

package/lib/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;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAEnF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AAEH,qBAAa,8BAA+B,SAAQ,mBAAmB;IACrE,OAAO,CAAC,eAAe,CAAmC;gBAExD,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,qBAAqB,GAAG,SAAS,EACjD,gBAAgB,CAAC,EAAE,CACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,GAAG,KACf,OAAO;IAMd;;;;;;;;OAQG;WACW,QAAQ,CACpB,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,qBAAqB,EACpC,gBAAgB,CAAC,EAAE,CACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,GAAG,KACf,OAAO;IAYE,6BAA6B,CAC3C,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,GAAG,GAClB,aAAa,EAAE;CAQnB"}

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

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { StandardStatusbarUiItemsProvider } from "./StandardStatusbarUiItemsProvider.js";
+import { UiItemsManager } from "./UiItemsManager.js";
+import { BaseUiItemsProvider } from "./BaseUiItemsProvider.js";
+/** Provide standard status bar fields.
+ * @public
+ * @deprecated in 4.17.0. Use {@link StandardStatusbarUiItemsProvider} instead. Supported frontstages can be specified when registering the provider.
+ */
+// eslint-disable-next-line deprecation/deprecation
+export class StandardStatusbarItemsProvider extends BaseUiItemsProvider {
+    constructor(providerId, _defaultItems, isSupportedStage) {
+        super(providerId, isSupportedStage);
+        this.uiItemsProvider = new StandardStatusbarUiItemsProvider(_defaultItems);
+    }
+    /**
+     * static function to register the StandardStatusbarItemsProvider
+     * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want
+     * to set up custom stage with their own subset of standard status bar items.
+     * @param defaultItems - if undefined all available item are provided to stage except for activityCenter. 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(providerId, defaultItems, isSupportedStage) {
+        // eslint-disable-next-line deprecation/deprecation
+        const provider = new StandardStatusbarItemsProvider(providerId, defaultItems, isSupportedStage);
+        UiItemsManager.register(provider);
+        return provider;
+    }
+    provideStatusBarItemsInternal(_stageId, _stageUsage, _stageAppData) {
+        // eslint-disable-next-line deprecation/deprecation
+        return this.uiItemsProvider.provideStatusBarItems(_stageId, _stageUsage, _stageAppData);
+    }
+}
+//# sourceMappingURL=StandardStatusbarItemsProvider.js.map

package/lib/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;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AAEzF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;GAGG;AACH,mDAAmD;AACnD,MAAM,OAAO,8BAA+B,SAAQ,mBAAmB;IAErE,YACE,UAAkB,EAClB,aAAiD,EACjD,gBAIY;QAEZ,KAAK,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,IAAI,gCAAgC,CAAC,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,QAAQ,CACpB,UAAkB,EAClB,YAAoC,EACpC,gBAIY;QAEZ,mDAAmD;QACnD,MAAM,QAAQ,GAAG,IAAI,8BAA8B,CACjD,UAAU,EACV,YAAY,EACZ,gBAAgB,CACjB,CAAC;QACF,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEe,6BAA6B,CAC3C,QAAgB,EAChB,WAAmB,EACnB,aAAmB;QAEnB,mDAAmD;QACnD,OAAO,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAC/C,QAAQ,EACR,WAAW,EACX,aAAa,CACd,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module StandardUiItemsProvider\n */\n\nimport type { DefaultStatusbarItems } from \"./StandardStatusbarUiItemsProvider.js\";\nimport { StandardStatusbarUiItemsProvider } from \"./StandardStatusbarUiItemsProvider.js\";\nimport type { StatusBarItem } from \"../statusbar/StatusBarItem.js\";\nimport { UiItemsManager } from \"./UiItemsManager.js\";\nimport { BaseUiItemsProvider } from \"./BaseUiItemsProvider.js\";\n\n/** Provide standard status bar fields.\n * @public\n * @deprecated in 4.17.0. Use {@link StandardStatusbarUiItemsProvider} instead. Supported frontstages can be specified when registering the provider.\n */\n// eslint-disable-next-line deprecation/deprecation\nexport class StandardStatusbarItemsProvider extends BaseUiItemsProvider {\n  private uiItemsProvider: StandardStatusbarUiItemsProvider;\n  constructor(\n    providerId: string,\n    _defaultItems?: DefaultStatusbarItems | undefined,\n    isSupportedStage?: (\n      stageId: string,\n      stageUsage: string,\n      stageAppData?: any\n    ) => boolean\n  ) {\n    super(providerId, isSupportedStage);\n    this.uiItemsProvider = new StandardStatusbarUiItemsProvider(_defaultItems);\n  }\n\n  /**\n   * static function to register the StandardStatusbarItemsProvider\n   * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want\n   * to set up custom stage with their own subset of standard status bar items.\n   * @param defaultItems - if undefined all available item are provided to stage except for activityCenter. If defined only those\n   * specific tool buttons are shown.\n   * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\n   * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\n   */\n  public static register(\n    providerId: string,\n    defaultItems?: DefaultStatusbarItems,\n    isSupportedStage?: (\n      stageId: string,\n      stageUsage: string,\n      stageAppData?: any\n    ) => boolean\n  ) {\n    // eslint-disable-next-line deprecation/deprecation\n    const provider = new StandardStatusbarItemsProvider(\n      providerId,\n      defaultItems,\n      isSupportedStage\n    );\n    UiItemsManager.register(provider);\n    return provider;\n  }\n\n  public override provideStatusBarItemsInternal(\n    _stageId: string,\n    _stageUsage: string,\n    _stageAppData?: any\n  ): StatusBarItem[] {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.uiItemsProvider.provideStatusBarItems(\n      _stageId,\n      _stageUsage,\n      _stageAppData\n    );\n  }\n}\n"]}

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

@@ -0,0 +1,34 @@
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import type { UiItemsProvider } from "./UiItemsProvider.js";
+import type { StatusBarItem } from "../statusbar/StatusBarItem.js";
+/** Defines what items to include from the provider.
+ * @note When this object is used, only explicitly enabled items will be added to the status bar. I.e. `{ messageCenter: true }` will only add message center field to the 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;
+}
+/** Provides standard status bar items.
+ * @public
+ */
+export declare class StandardStatusbarUiItemsProvider implements UiItemsProvider {
+    private _defaultItems?;
+    get id(): string;
+    /** Creates a provider. If the `defaultItems` argument is not set, all default fields are added. Otherwise, only the fields that are set to `true` are added. */
+    constructor(_defaultItems?: DefaultStatusbarItems | undefined);
+    /** @deprecated in 4.17.0. Property of a deprecated interface {@link UiItemsProvider.provideStatusBarItems}. */
+    provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): StatusBarItem[];
+    getStatusBarItems(): readonly StatusBarItem[];
+}
+//# sourceMappingURL=StandardStatusbarUiItemsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardStatusbarUiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAYH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAGnE;;;GAGG;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;;GAEG;AACH,qBAAa,gCAAiC,YAAW,eAAe;IAM1D,OAAO,CAAC,aAAa,CAAC;IALlC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,gKAAgK;gBAC5I,aAAa,CAAC,mCAAuB;IAEzD,+GAA+G;IACxG,qBAAqB,CAC1B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,GAAG,GAClB,aAAa,EAAE;IAIX,iBAAiB,IAAI,SAAS,aAAa,EAAE;CAmGrD"}

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

@@ -0,0 +1,110 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { StatusBarItemUtilities } from "../statusbar/StatusBarItemUtilities.js";
+import { ToolAssistanceField } from "../statusfields/toolassistance/ToolAssistanceField.js";
+import { MessageCenterField } from "../statusfields/message-center/MessageCenterField.js";
+import { ActivityCenterField } from "../statusfields/ActivityCenter.js";
+import { SnapModeField } from "../statusfields/SnapMode.js";
+import { SelectionInfoField } from "../statusfields/SelectionInfo.js";
+import { TileLoadingIndicator } from "../statusfields/tileloading/TileLoadingIndicator.js";
+import { SelectionScopeField } from "../statusfields/SelectionScope.js";
+import { StatusBarSeparator } from "../statusbar/Separator.js";
+import { StatusBarSection } from "../statusbar/StatusBarItem.js";
+/** Provides standard status bar items.
+ * @public
+ */
+export class StandardStatusbarUiItemsProvider {
+    get id() {
+        return "appui-react:StandardStatusbarUiItemsProvider";
+    }
+    /** Creates a provider. If the `defaultItems` argument is not set, all default fields are added. Otherwise, only the fields that are set to `true` are added. */
+    constructor(_defaultItems) {
+        this._defaultItems = _defaultItems;
+    }
+    /** @deprecated in 4.17.0. Property of a deprecated interface {@link UiItemsProvider.provideStatusBarItems}. */
+    provideStatusBarItems(_stageId, _stageUsage, _stageAppData) {
+        return this.getStatusBarItems();
+    }
+    getStatusBarItems() {
+        const statusBarItems = [];
+        if (!this._defaultItems || this._defaultItems.messageCenter) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.MessageCenter",
+                section: StatusBarSection.Left,
+                itemPriority: 10,
+                content: React.createElement(MessageCenterField, null),
+            }));
+        }
+        if (!this._defaultItems || this._defaultItems.toolAssistance) {
+            if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)
+                statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                    id: "uifw.PreToolAssistance",
+                    section: StatusBarSection.Left,
+                    itemPriority: 15,
+                    content: React.createElement(StatusBarSeparator, null),
+                }));
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.ToolAssistance",
+                section: StatusBarSection.Left,
+                itemPriority: 20,
+                content: React.createElement(ToolAssistanceField, null),
+            }));
+            if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)
+                statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                    id: "uifw.PostToolAssistance",
+                    section: StatusBarSection.Left,
+                    itemPriority: 25,
+                    content: React.createElement(StatusBarSeparator, null),
+                }));
+        }
+        if (this._defaultItems?.activityCenter) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.ActivityCenter",
+                section: StatusBarSection.Left,
+                itemPriority: 30,
+                content: React.createElement(ActivityCenterField, null),
+            }));
+        }
+        if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.SnapMode",
+                section: StatusBarSection.Center,
+                itemPriority: 10,
+                content: React.createElement(SnapModeField, null),
+            }));
+        }
+        if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.TileLoadIndicator",
+                section: StatusBarSection.Right,
+                itemPriority: 10,
+                content: React.createElement(TileLoadingIndicator, null),
+            }));
+        }
+        if (!this._defaultItems || this._defaultItems.selectionScope) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.SelectionScope",
+                section: StatusBarSection.Right,
+                itemPriority: 20,
+                content: React.createElement(SelectionScopeField, null),
+            }));
+        }
+        if (!this._defaultItems || this._defaultItems.selectionInfo) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem({
+                id: "uifw.SelectionInfo",
+                section: StatusBarSection.Right,
+                itemPriority: 30,
+                // eslint-disable-next-line deprecation/deprecation
+                content: React.createElement(SelectionInfoField, null),
+            }));
+        }
+        return statusBarItems;
+    }
+}
+//# sourceMappingURL=StandardStatusbarUiItemsProvider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StandardStatusbarUiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uDAAuD,CAAC;AAC5F,OAAO,EAAE,kBAAkB,EAAE,MAAM,sDAAsD,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qDAAqD,CAAC;AAC3F,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAG/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAmBjE;;GAEG;AACH,MAAM,OAAO,gCAAgC;IAC3C,IAAW,EAAE;QACX,OAAO,8CAA8C,CAAC;IACxD,CAAC;IAED,gKAAgK;IAChK,YAAoB,aAAqC;QAArC,kBAAa,GAAb,aAAa,CAAwB;IAAG,CAAC;IAE7D,+GAA+G;IACxG,qBAAqB,CAC1B,QAAgB,EAChB,WAAmB,EACnB,aAAmB;QAEnB,OAAO,IAAI,CAAC,iBAAiB,EAAqB,CAAC;IACrD,CAAC;IAEM,iBAAiB;QACtB,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;YAC5D,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,oBAAoB;gBACxB,OAAO,EAAE,gBAAgB,CAAC,IAAI;gBAC9B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,oBAAC,kBAAkB,OAAG;aAChC,CAAC,CACH,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;YAC7D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B;gBACtE,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;oBACtC,EAAE,EAAE,wBAAwB;oBAC5B,OAAO,EAAE,gBAAgB,CAAC,IAAI;oBAC9B,YAAY,EAAE,EAAE;oBAChB,OAAO,EAAE,oBAAC,kBAAkB,OAAG;iBAChC,CAAC,CACH,CAAC;YAEJ,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,qBAAqB;gBACzB,OAAO,EAAE,gBAAgB,CAAC,IAAI;gBAC9B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,oBAAC,mBAAmB,OAAG;aACjC,CAAC,CACH,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,2BAA2B;gBACvE,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;oBACtC,EAAE,EAAE,yBAAyB;oBAC7B,OAAO,EAAE,gBAAgB,CAAC,IAAI;oBAC9B,YAAY,EAAE,EAAE;oBAChB,OAAO,EAAE,oBAAC,kBAAkB,OAAG;iBAChC,CAAC,CACH,CAAC;QACN,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC;YACvC,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,qBAAqB;gBACzB,OAAO,EAAE,gBAAgB,CAAC,IAAI;gBAC9B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,oBAAC,mBAAmB,OAAG;aACjC,CAAC,CACH,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,CAAC;YACjE,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,eAAe;gBACnB,OAAO,EAAE,gBAAgB,CAAC,MAAM;gBAChC,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,oBAAC,aAAa,OAAG;aAC3B,CAAC,CACH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC;YAChE,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,wBAAwB;gBAC5B,OAAO,EAAE,gBAAgB,CAAC,KAAK;gBAC/B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,oBAAC,oBAAoB,OAAG;aAClC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;YAC7D,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,qBAAqB;gBACzB,OAAO,EAAE,gBAAgB,CAAC,KAAK;gBAC/B,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,oBAAC,mBAAmB,OAAG;aACjC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;YAC5D,cAAc,CAAC,IAAI,CACjB,sBAAsB,CAAC,gBAAgB,CAAC;gBACtC,EAAE,EAAE,oBAAoB;gBACxB,OAAO,EAAE,gBAAgB,CAAC,KAAK;gBAC/B,YAAY,EAAE,EAAE;gBAChB,mDAAmD;gBACnD,OAAO,EAAE,oBAAC,kBAAkB,OAAG;aAChC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module StandardUiItemsProvider\n */\n\nimport * as React from \"react\";\nimport { StatusBarItemUtilities } from \"../statusbar/StatusBarItemUtilities.js\";\nimport { ToolAssistanceField } from \"../statusfields/toolassistance/ToolAssistanceField.js\";\nimport { MessageCenterField } from \"../statusfields/message-center/MessageCenterField.js\";\nimport { ActivityCenterField } from \"../statusfields/ActivityCenter.js\";\nimport { SnapModeField } from \"../statusfields/SnapMode.js\";\nimport { SelectionInfoField } from \"../statusfields/SelectionInfo.js\";\nimport { TileLoadingIndicator } from \"../statusfields/tileloading/TileLoadingIndicator.js\";\nimport { SelectionScopeField } from \"../statusfields/SelectionScope.js\";\nimport { StatusBarSeparator } from \"../statusbar/Separator.js\";\nimport type { UiItemsProvider } from \"./UiItemsProvider.js\";\nimport type { StatusBarItem } from \"../statusbar/StatusBarItem.js\";\nimport { StatusBarSection } from \"../statusbar/StatusBarItem.js\";\n\n/** Defines what items to include from the provider.\n * @note When this object is used, only explicitly enabled items will be added to the status bar. I.e. `{ messageCenter: true }` will only add message center field to the statusbar.\n * @public\n */\nexport interface DefaultStatusbarItems {\n  messageCenter?: boolean;\n  preToolAssistanceSeparator?: boolean;\n  toolAssistance?: boolean;\n  postToolAssistanceSeparator?: boolean;\n  /** Activity center field is hidden by default. */\n  activityCenter?: boolean;\n  accuSnapModePicker?: boolean;\n  tileLoadIndicator?: boolean;\n  selectionScope?: boolean;\n  selectionInfo?: boolean;\n}\n\n/** Provides standard status bar items.\n * @public\n */\nexport class StandardStatusbarUiItemsProvider implements UiItemsProvider {\n  public get id(): string {\n    return \"appui-react:StandardStatusbarUiItemsProvider\";\n  }\n\n  /** Creates a provider. If the `defaultItems` argument is not set, all default fields are added. Otherwise, only the fields that are set to `true` are added. */\n  constructor(private _defaultItems?: DefaultStatusbarItems) {}\n\n  /** @deprecated in 4.17.0. Property of a deprecated interface {@link UiItemsProvider.provideStatusBarItems}. */\n  public provideStatusBarItems(\n    _stageId: string,\n    _stageUsage: string,\n    _stageAppData?: any\n  ): StatusBarItem[] {\n    return this.getStatusBarItems() as StatusBarItem[];\n  }\n\n  public getStatusBarItems(): readonly StatusBarItem[] {\n    const statusBarItems: StatusBarItem[] = [];\n    if (!this._defaultItems || this._defaultItems.messageCenter) {\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.MessageCenter\",\n          section: StatusBarSection.Left,\n          itemPriority: 10,\n          content: <MessageCenterField />,\n        })\n      );\n    }\n    if (!this._defaultItems || this._defaultItems.toolAssistance) {\n      if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)\n        statusBarItems.push(\n          StatusBarItemUtilities.createCustomItem({\n            id: \"uifw.PreToolAssistance\",\n            section: StatusBarSection.Left,\n            itemPriority: 15,\n            content: <StatusBarSeparator />,\n          })\n        );\n\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.ToolAssistance\",\n          section: StatusBarSection.Left,\n          itemPriority: 20,\n          content: <ToolAssistanceField />,\n        })\n      );\n\n      if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)\n        statusBarItems.push(\n          StatusBarItemUtilities.createCustomItem({\n            id: \"uifw.PostToolAssistance\",\n            section: StatusBarSection.Left,\n            itemPriority: 25,\n            content: <StatusBarSeparator />,\n          })\n        );\n    }\n    if (this._defaultItems?.activityCenter) {\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.ActivityCenter\",\n          section: StatusBarSection.Left,\n          itemPriority: 30,\n          content: <ActivityCenterField />,\n        })\n      );\n    }\n    if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.SnapMode\",\n          section: StatusBarSection.Center,\n          itemPriority: 10,\n          content: <SnapModeField />,\n        })\n      );\n    }\n\n    if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.TileLoadIndicator\",\n          section: StatusBarSection.Right,\n          itemPriority: 10,\n          content: <TileLoadingIndicator />,\n        })\n      );\n    }\n\n    if (!this._defaultItems || this._defaultItems.selectionScope) {\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.SelectionScope\",\n          section: StatusBarSection.Right,\n          itemPriority: 20,\n          content: <SelectionScopeField />,\n        })\n      );\n    }\n\n    if (!this._defaultItems || this._defaultItems.selectionInfo) {\n      statusBarItems.push(\n        StatusBarItemUtilities.createCustomItem({\n          id: \"uifw.SelectionInfo\",\n          section: StatusBarSection.Right,\n          itemPriority: 30,\n          // eslint-disable-next-line deprecation/deprecation\n          content: <SelectionInfoField />,\n        })\n      );\n    }\n\n    return statusBarItems;\n  }\n}\n"]}

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

@@ -0,0 +1,102 @@
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import type { MarkRequired } from "@itwin/core-bentley";
+import { BeUiEvent } from "@itwin/core-bentley";
+import type { BackstageItem } from "../backstage/BackstageItem.js";
+import type { StagePanelLocation } from "../stagepanels/StagePanelLocation.js";
+import type { StagePanelSection } from "../stagepanels/StagePanelSection.js";
+import type { StatusBarItem } from "../statusbar/StatusBarItem.js";
+import type { ToolbarItem } from "../toolbar/ToolbarItem.js";
+import type { ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem.js";
+import type { Widget } from "../widgets/Widget.js";
+import type { ProviderItem } from "./ProviderItem.js";
+import type { UiItemsProvider } from "./UiItemsProvider.js";
+/** UiItemsProvider register event args.
+ * @public
+ * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
+ */
+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 useAbstractAdapter(useAbstractAdapter: boolean): void;
+    /** 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.
+     * @param overrides 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 of the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param usage usage of the toolbar
+     * @param orientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId: 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 of the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId: 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 of the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of widgets.
+     */
+    static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>>;
+}
+//# sourceMappingURL=UiItemsManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAU,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACb,MAAM,2BAA2B,CAAC;AAEnC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAM5D;;;GAGG;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,GAChC,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,CACV,+BAA+B,EAC/B,YAAY,GAAG,aAAa,GAAG,UAAU,CAC1C,CAAC;AAQN;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CACD;IACzC,OAAO,CAAC,MAAM,CAAC,4BAA4B,CACW;IACtD,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAyC;IAExE;;OAEG;WACW,kBAAkB,CAAC,kBAAkB,EAAE,OAAO;IAQ5D;mBACe;WACD,iBAAiB;IAM/B,wEAAwE;IAExE,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,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,GAAG,SAAS;IAQ9B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;;OAIG;WACW,QAAQ,CACpB,UAAU,EAAE,eAAe,EAC3B,SAAS,CAAC,EAAE,wBAAwB,GACnC,IAAI;IAyBP,8EAA8E;WAChE,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAmBlD,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAqBrC;;;;;;;OAOG;WACW,qBAAqB,CACjC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,YAAY,EACnB,WAAW,EAAE,kBAAkB,GAC9B,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IA6B3C;;;;OAIG;WACW,iBAAiB,CAC7B,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAyB7C;;OAEG;WACW,iBAAiB,IAAI,aAAa,CAC9C,YAAY,CAAC,aAAa,CAAC,CAC5B;IAsBD;;;;;;OAMG;WACW,UAAU,CACtB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,CAAC,EAAE,iBAAiB,GAC1B,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;CA6BvC"}