@itwin/appui-react 4.3.1 → 4.5.0

package/lib/esm/appui-react/toolbar/ToolbarWithOverflow.d.ts

@@ -10,7 +10,7 @@ import type { ToolbarItem } from "./ToolbarItem";
  * @beta
  */
 export interface ToolbarWithOverflowProps extends CommonProps, NoChildrenProps {
-    /** Describes to which direction the popup panels are expanded. Defaults to: [[Direction.Bottom]] */
+    /** Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar). Defaults to: [[Direction.Bottom]] */
     expandsTo?: Direction;
     /** Describes to which direction the overflow popup panels are expanded. Defaults to: [[Direction.Right]] */
     overflowExpandsTo?: Direction;
@@ -27,7 +27,8 @@ export interface ToolbarWithOverflowProps extends CommonProps, NoChildrenProps {
     /** Optional function to call on any KeyDown events processed by toolbar */
     onKeyDown?: (e: React.KeyboardEvent) => void;
 }
-/** Component that displays toolbar items.
+/** Component that displays toolbar items, displaying only the elements that can fit in the available space,
+ * and put the other items into a single panel.
  * @beta
  */
 export declare function ToolbarWithOverflow(props: ToolbarWithOverflowProps): JSX.Element;

package/lib/esm/appui-react/toolbar/ToolbarWithOverflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarWithOverflow.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarWithOverflow.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAGjD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,eAAe;IAC5E,oGAAoG;IACpG,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,4GAA4G;IAC5G,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,uGAAuG;IACvG,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,sDAAsD;IACtD,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,eAWlE"}
+{"version":3,"file":"ToolbarWithOverflow.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarWithOverflow.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAGjD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,eAAe;IAC5E,2OAA2O;IAC3O,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,4GAA4G;IAC5G,iBAAiB,CAAC,EAAE,SAAS,CAAC;IAC9B,uGAAuG;IACvG,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,sDAAsD;IACtD,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,eAGlE"}

package/lib/esm/appui-react/toolbar/ToolbarWithOverflow.js

@@ -6,17 +6,13 @@
  * @module Toolbar
  */
 import * as React from "react";
-import { ToolbarWithOverflow as CR_ToolbarWithOverflow } from "@itwin/components-react";
-import { toUIAToolbarItem } from "./toUIAToolbarItem";
-/** Component that displays toolbar items.
+import { Toolbar } from "./Toolbar";
+/** Component that displays toolbar items, displaying only the elements that can fit in the available space,
+ * and put the other items into a single panel.
  * @beta
  */
 export function ToolbarWithOverflow(props) {
-    const { items, ...other } = props;
-    const uiaItems = React.useMemo(() => {
-        return items.map((item) => toUIAToolbarItem(item));
-    }, [items]);
-    return (React.createElement(CR_ToolbarWithOverflow // eslint-disable-line deprecation/deprecation
-    , { items: uiaItems, ...other }));
+    const { overflowExpandsTo, ...toolbarProps } = props;
+    return React.createElement(Toolbar, { enableOverflow: { overflowExpandsTo }, ...toolbarProps });
 }
 //# sourceMappingURL=ToolbarWithOverflow.js.map

package/lib/esm/appui-react/toolbar/ToolbarWithOverflow.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarWithOverflow.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarWithOverflow.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAQ/B,OAAO,EAAE,mBAAmB,IAAI,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAExF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAwBtD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA+B;IACjE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,CACL,oBAAC,sBAAsB,CAAC,8CAA8C;QACpE,KAAK,EAAE,QAAQ,KACX,KAAK,GACT,CACH,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { OnItemExecutedFunc } from \"@itwin/appui-abstract\";\nimport type { CommonProps, NoChildrenProps } from \"@itwin/core-react\";\nimport type {\n  Direction,\n  ToolbarOpacitySetting,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport { ToolbarWithOverflow as CR_ToolbarWithOverflow } from \"@itwin/components-react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport { toUIAToolbarItem } from \"./toUIAToolbarItem\";\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport interface ToolbarWithOverflowProps extends CommonProps, NoChildrenProps {\n  /** Describes to which direction the popup panels are expanded. Defaults to: [[Direction.Bottom]] */\n  expandsTo?: Direction;\n  /** Describes to which direction the overflow popup panels are expanded. Defaults to: [[Direction.Right]] */\n  overflowExpandsTo?: Direction;\n  /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */\n  items: ToolbarItem[];\n  /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */\n  panelAlignment?: ToolbarPanelAlignment;\n  /** Use Drag Interaction to open popups with nest action buttons */\n  useDragInteraction?: boolean;\n  /** Determines whether to use mouse proximity to alter the opacity of the toolbar */\n  toolbarOpacitySetting?: ToolbarOpacitySetting;\n  /** Optional function to call on any item execution */\n  onItemExecuted?: OnItemExecutedFunc;\n  /** Optional function to call on any KeyDown events processed by toolbar */\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport function ToolbarWithOverflow(props: ToolbarWithOverflowProps) {\n  const { items, ...other } = props;\n  const uiaItems = React.useMemo(() => {\n    return items.map((item) => toUIAToolbarItem(item));\n  }, [items]);\n  return (\n    <CR_ToolbarWithOverflow // eslint-disable-line deprecation/deprecation\n      items={uiaItems}\n      {...other}\n    />\n  );\n}\n"]}
+{"version":3,"file":"ToolbarWithOverflow.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarWithOverflow.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAwBpC;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA+B;IACjE,MAAM,EAAE,iBAAiB,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,CAAC;IACrD,OAAO,oBAAC,OAAO,IAAC,cAAc,EAAE,EAAE,iBAAiB,EAAE,KAAM,YAAY,GAAI,CAAC;AAC9E,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { OnItemExecutedFunc } from \"@itwin/appui-abstract\";\nimport type { CommonProps, NoChildrenProps } from \"@itwin/core-react\";\nimport type {\n  Direction,\n  ToolbarOpacitySetting,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport { Toolbar } from \"./Toolbar\";\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport interface ToolbarWithOverflowProps extends CommonProps, NoChildrenProps {\n  /** Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar). Defaults to: [[Direction.Bottom]] */\n  expandsTo?: Direction;\n  /** Describes to which direction the overflow popup panels are expanded. Defaults to: [[Direction.Right]] */\n  overflowExpandsTo?: Direction;\n  /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */\n  items: ToolbarItem[];\n  /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */\n  panelAlignment?: ToolbarPanelAlignment;\n  /** Use Drag Interaction to open popups with nest action buttons */\n  useDragInteraction?: boolean;\n  /** Determines whether to use mouse proximity to alter the opacity of the toolbar */\n  toolbarOpacitySetting?: ToolbarOpacitySetting;\n  /** Optional function to call on any item execution */\n  onItemExecuted?: OnItemExecutedFunc;\n  /** Optional function to call on any KeyDown events processed by toolbar */\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\n/** Component that displays toolbar items, displaying only the elements that can fit in the available space,\n * and put the other items into a single panel.\n * @beta\n */\nexport function ToolbarWithOverflow(props: ToolbarWithOverflowProps) {\n  const { overflowExpandsTo, ...toolbarProps } = props;\n  return <Toolbar enableOverflow={{ overflowExpandsTo }} {...toolbarProps} />;\n}\n"]}

package/lib/esm/appui-react/toolbar/useActiveStageProvidedToolbarItems.d.ts

@@ -0,0 +1,11 @@
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import type { ToolbarItem, ToolbarOrientation, ToolbarUsage } from "./ToolbarItem";
+/**
+ * Collects the currently registered items providers toolbar item
+ * for the active stage and provided toolbar usage and orientation.
+ * @internal
+ */
+export declare const useActiveStageProvidedToolbarItems: (toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => readonly ToolbarItem[];
+//# sourceMappingURL=useActiveStageProvidedToolbarItems.d.ts.map

package/lib/esm/appui-react/toolbar/useActiveStageProvidedToolbarItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useActiveStageProvidedToolbarItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useActiveStageProvidedToolbarItems.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACb,MAAM,eAAe,CAAC;AAGvB;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,iBAC/B,YAAY,sBACN,kBAAkB,KACrC,SAAS,WAAW,EA+BtB,CAAC"}

package/lib/esm/appui-react/toolbar/useActiveStageProvidedToolbarItems.js

@@ -0,0 +1,42 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import * as React from "react";
+import { useActiveStageId } from "../hooks/useActiveStageId";
+import { useAvailableUiItemsProviders } from "../hooks/useAvailableUiItemsProviders";
+import { UiFramework } from "../UiFramework";
+import { UiItemsManager } from "../ui-items-provider/UiItemsManager";
+/**
+ * Collects the currently registered items providers toolbar item
+ * for the active stage and provided toolbar usage and orientation.
+ * @internal
+ */
+export const useActiveStageProvidedToolbarItems = (toolbarUsage, toolbarOrientation) => {
+    const uiItemsProviderIds = useAvailableUiItemsProviders();
+    const stageId = useActiveStageId();
+    const [items, setItems] = React.useState([]);
+    const providersRef = React.useRef("");
+    const currentStageRef = React.useRef("");
+    // gathers items from registered extensions - dependent on when a uiItemsProvider is register or unregistered and if the
+    // current stage's composer allows entries from extensions.
+    React.useEffect(() => {
+        const uiProviders = uiItemsProviderIds.join("-");
+        if (providersRef.current !== uiProviders ||
+            currentStageRef.current !== stageId) {
+            const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
+            if (frontstageDef) {
+                const usage = frontstageDef.usage;
+                currentStageRef.current = stageId;
+                providersRef.current = uiProviders;
+                const toolbarItems = UiItemsManager.getToolbarButtonItems(stageId, usage, toolbarUsage, toolbarOrientation);
+                setItems(toolbarItems);
+            }
+        }
+    }, [uiItemsProviderIds, stageId, toolbarUsage, toolbarOrientation]);
+    return items;
+};
+//# sourceMappingURL=useActiveStageProvidedToolbarItems.js.map

package/lib/esm/appui-react/toolbar/useActiveStageProvidedToolbarItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useActiveStageProvidedToolbarItems.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useActiveStageProvidedToolbarItems.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAM7C,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAErE;;;;GAIG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAChD,YAA0B,EAC1B,kBAAsC,EACd,EAAE;IAC1B,MAAM,kBAAkB,GAAG,4BAA4B,EAAE,CAAC;IAC1D,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAyB,EAAE,CAAC,CAAC;IACrE,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtC,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzC,wHAAwH;IACxH,2DAA2D;IAC3D,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,WAAW,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjD,IACE,YAAY,CAAC,OAAO,KAAK,WAAW;YACpC,eAAe,CAAC,OAAO,KAAK,OAAO,EACnC;YACA,MAAM,aAAa,GAAG,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC;YAClE,IAAI,aAAa,EAAE;gBACjB,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;gBAClC,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;gBAClC,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC;gBACnC,MAAM,YAAY,GAAG,cAAc,CAAC,qBAAqB,CACvD,OAAO,EACP,KAAK,EACL,YAAY,EACZ,kBAAkB,CACnB,CAAC;gBACF,QAAQ,CAAC,YAAY,CAAC,CAAC;aACxB;SACF;IACH,CAAC,EAAE,CAAC,kBAAkB,EAAE,OAAO,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC;IACpE,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport { useActiveStageId } from \"../hooks/useActiveStageId\";\nimport { useAvailableUiItemsProviders } from \"../hooks/useAvailableUiItemsProviders\";\nimport { UiFramework } from \"../UiFramework\";\nimport type {\n  ToolbarItem,\n  ToolbarOrientation,\n  ToolbarUsage,\n} from \"./ToolbarItem\";\nimport { UiItemsManager } from \"../ui-items-provider/UiItemsManager\";\n\n/**\n * Collects the currently registered items providers toolbar item\n * for the active stage and provided toolbar usage and orientation.\n * @internal\n */\nexport const useActiveStageProvidedToolbarItems = (\n  toolbarUsage: ToolbarUsage,\n  toolbarOrientation: ToolbarOrientation\n): readonly ToolbarItem[] => {\n  const uiItemsProviderIds = useAvailableUiItemsProviders();\n  const stageId = useActiveStageId();\n  const [items, setItems] = React.useState<readonly ToolbarItem[]>([]);\n  const providersRef = React.useRef(\"\");\n  const currentStageRef = React.useRef(\"\");\n  // gathers items from registered extensions - dependent on when a uiItemsProvider is register or unregistered and if the\n  // current stage's composer allows entries from extensions.\n  React.useEffect(() => {\n    const uiProviders = uiItemsProviderIds.join(\"-\");\n\n    if (\n      providersRef.current !== uiProviders ||\n      currentStageRef.current !== stageId\n    ) {\n      const frontstageDef = UiFramework.frontstages.activeFrontstageDef;\n      if (frontstageDef) {\n        const usage = frontstageDef.usage;\n        currentStageRef.current = stageId;\n        providersRef.current = uiProviders;\n        const toolbarItems = UiItemsManager.getToolbarButtonItems(\n          stageId,\n          usage,\n          toolbarUsage,\n          toolbarOrientation\n        );\n        setItems(toolbarItems);\n      }\n    }\n  }, [uiItemsProviderIds, stageId, toolbarUsage, toolbarOrientation]);\n  return items;\n};\n"]}

package/lib/esm/appui-react/toolbar/useActiveToolIdSynchedItems.d.ts

@@ -0,0 +1,25 @@
+import type { BeEvent } from "@itwin/core-bentley";
+type ActiveToolIdSynchedItem<T> = {
+    id: string;
+    isActive?: boolean;
+} | {
+    id: string;
+    items: T[];
+};
+interface ActiveToolIdSynchedHost {
+    activeToolId: string;
+    onToolActivatedEvent: BeEvent<(args: {
+        toolId: string;
+    }) => void>;
+}
+/**
+ * Synch the provided items to only show the item with id === activeToolId to be
+ * active, as determined by the UiFramework.frontstages.activeToolId.
+ * @param itemsToSynch List of items to keep in synch.
+ * @param syncHost Source of information to synch to (UiFramework.frontstages)
+ * @returns Up to date itemsToSynch.
+ * @internal
+ */
+export declare function useActiveToolIdSynchedItems<T extends ActiveToolIdSynchedItem<T>>(itemsToSynch: readonly T[], syncHost: ActiveToolIdSynchedHost): T[];
+export {};
+//# sourceMappingURL=useActiveToolIdSynchedItems.d.ts.map

package/lib/esm/appui-react/toolbar/useActiveToolIdSynchedItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useActiveToolIdSynchedItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useActiveToolIdSynchedItems.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,KAAK,uBAAuB,CAAC,CAAC,IAC1B;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,GAClC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC;AAE/B,UAAU,uBAAuB;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC,CAAC;CACnE;AAiDD;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,CAAC,SAAS,uBAAuB,CAAC,CAAC,CAAC,EACpC,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,uBAAuB,GAAG,CAAC,EAAE,CAWpE"}

package/lib/esm/appui-react/toolbar/useActiveToolIdSynchedItems.js

@@ -0,0 +1,59 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import * as React from "react";
+/**
+ * Recursively checks if the item with the current id of "toolId" is
+ * the only active tool.
+ * @param items list of items to validate
+ * @param toolId toolId to check
+ * @returns true if any item "isActive" must change.
+ */
+function mustRefresh(items, toolId) {
+    return items.some((item) => {
+        if ("items" in item) {
+            return mustRefresh(item.items, toolId);
+        }
+        return ((item.isActive && item.id !== toolId) ||
+            (!item.isActive && item.id === toolId));
+    });
+}
+/**
+ * Recursively updates the isActive for the tools and only activate
+ * the one with the id equal to toolId.
+ * @param items list of items to update
+ * @param toolId toolId to check
+ * @returns updated list of items
+ */
+function refreshItems(items, toolId) {
+    return items.map((item) => "items" in item
+        ? {
+            ...item,
+            isActive: item.id === toolId,
+            items: refreshItems(item.items, toolId),
+        }
+        : {
+            ...item,
+            isActive: item.id === toolId,
+        });
+}
+/**
+ * Synch the provided items to only show the item with id === activeToolId to be
+ * active, as determined by the UiFramework.frontstages.activeToolId.
+ * @param itemsToSynch List of items to keep in synch.
+ * @param syncHost Source of information to synch to (UiFramework.frontstages)
+ * @returns Up to date itemsToSynch.
+ * @internal
+ */
+export function useActiveToolIdSynchedItems(itemsToSynch, syncHost) {
+    const [items, setItems] = React.useState([]);
+    React.useEffect(() => {
+        setItems(refreshItems(itemsToSynch, syncHost.activeToolId));
+        return syncHost.onToolActivatedEvent.addListener(({ toolId }) => {
+            setItems((current) => mustRefresh(current, toolId) ? refreshItems(current, toolId) : current);
+        });
+    }, [itemsToSynch, syncHost.activeToolId, syncHost.onToolActivatedEvent]);
+    return items;
+}
+//# sourceMappingURL=useActiveToolIdSynchedItems.js.map

package/lib/esm/appui-react/toolbar/useActiveToolIdSynchedItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useActiveToolIdSynchedItems.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useActiveToolIdSynchedItems.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAY/B;;;;;;GAMG;AACH,SAAS,WAAW,CAClB,KAAmB,EACnB,MAAc;IAEd,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;SACxC;QACD,OAAO,CACL,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CACvC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CACnB,KAAmB,EACnB,MAAc;IAEd,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACxB,OAAO,IAAI,IAAI;QACb,CAAC,CAAC;YACE,GAAG,IAAI;YACP,QAAQ,EAAE,IAAI,CAAC,EAAE,KAAK,MAAM;YAC5B,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;SACxC;QACH,CAAC,CAAC;YACE,GAAG,IAAI;YACP,QAAQ,EAAE,IAAI,CAAC,EAAE,KAAK,MAAM;SAC7B,CACN,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CAEzC,YAA0B,EAAE,QAAiC;IAC7D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAM,EAAE,CAAC,CAAC;IAClD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,QAAQ,CAAC,YAAY,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;QAC5D,OAAO,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;YAC9D,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CACnB,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CACvE,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACzE,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\nimport * as React from \"react\";\nimport type { BeEvent } from \"@itwin/core-bentley\";\n\ntype ActiveToolIdSynchedItem<T> =\n  | { id: string; isActive?: boolean }\n  | { id: string; items: T[] };\n\ninterface ActiveToolIdSynchedHost {\n  activeToolId: string;\n  onToolActivatedEvent: BeEvent<(args: { toolId: string }) => void>;\n}\n\n/**\n * Recursively checks if the item with the current id of \"toolId\" is\n * the only active tool.\n * @param items list of items to validate\n * @param toolId toolId to check\n * @returns true if any item \"isActive\" must change.\n */\nfunction mustRefresh<T extends ActiveToolIdSynchedItem<T>>(\n  items: readonly T[],\n  toolId: string\n): boolean {\n  return items.some((item) => {\n    if (\"items\" in item) {\n      return mustRefresh(item.items, toolId);\n    }\n    return (\n      (item.isActive && item.id !== toolId) ||\n      (!item.isActive && item.id === toolId)\n    );\n  });\n}\n\n/**\n * Recursively updates the isActive for the tools and only activate\n * the one with the id equal to toolId.\n * @param items list of items to update\n * @param toolId toolId to check\n * @returns updated list of items\n */\nfunction refreshItems<T extends ActiveToolIdSynchedItem<T>>(\n  items: readonly T[],\n  toolId: string\n): T[] {\n  return items.map((item) =>\n    \"items\" in item\n      ? {\n          ...item,\n          isActive: item.id === toolId,\n          items: refreshItems(item.items, toolId),\n        }\n      : {\n          ...item,\n          isActive: item.id === toolId,\n        }\n  );\n}\n\n/**\n * Synch the provided items to only show the item with id === activeToolId to be\n * active, as determined by the UiFramework.frontstages.activeToolId.\n * @param itemsToSynch List of items to keep in synch.\n * @param syncHost Source of information to synch to (UiFramework.frontstages)\n * @returns Up to date itemsToSynch.\n * @internal\n */\nexport function useActiveToolIdSynchedItems<\n  T extends ActiveToolIdSynchedItem<T>\n>(itemsToSynch: readonly T[], syncHost: ActiveToolIdSynchedHost): T[] {\n  const [items, setItems] = React.useState<T[]>([]);\n  React.useEffect(() => {\n    setItems(refreshItems(itemsToSynch, syncHost.activeToolId));\n    return syncHost.onToolActivatedEvent.addListener(({ toolId }) => {\n      setItems((current) =>\n        mustRefresh(current, toolId) ? refreshItems(current, toolId) : current\n      );\n    });\n  }, [itemsToSynch, syncHost.activeToolId, syncHost.onToolActivatedEvent]);\n  return items;\n}\n"]}

package/lib/esm/appui-react/toolbar/useDefaultToolbarItems.d.ts

@@ -5,6 +5,7 @@ import type { ToolbarItem } from "./ToolbarItem";
 import type { ToolbarItemsManager } from "./ToolbarItemsManager";
 /** Hook that returns items from [[ToolbarItemsManager]].
  * @public
+ * @deprecated in 4.4.0. Use [[Toolbar]] component instead of this hooks, ToolbarItemsManager is internal and should not be used here.
  */
 export declare const useDefaultToolbarItems: (manager: ToolbarItemsManager) => readonly ToolbarItem[];
 //# sourceMappingURL=useDefaultToolbarItems.d.ts.map

package/lib/esm/appui-react/toolbar/useDefaultToolbarItems.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDefaultToolbarItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useDefaultToolbarItems.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,sBAAsB,YACxB,mBAAmB,KAC3B,SAAS,WAAW,EAetB,CAAC"}
+{"version":3,"file":"useDefaultToolbarItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useDefaultToolbarItems.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,sBAAsB,YAExB,mBAAmB,KAC3B,SAAS,WAAW,EAetB,CAAC"}

package/lib/esm/appui-react/toolbar/useDefaultToolbarItems.js

@@ -8,8 +8,11 @@
 import * as React from "react";
 /** Hook that returns items from [[ToolbarItemsManager]].
  * @public
+ * @deprecated in 4.4.0. Use [[Toolbar]] component instead of this hooks, ToolbarItemsManager is internal and should not be used here.
  */
-export const useDefaultToolbarItems = (manager) => {
+export const useDefaultToolbarItems = (
+// eslint-disable-next-line deprecation/deprecation
+manager) => {
     const [items, setItems] = React.useState(() => manager.items);
     const isInitialMount = React.useRef(true);
     React.useEffect(() => {

package/lib/esm/appui-react/toolbar/useDefaultToolbarItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDefaultToolbarItems.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useDefaultToolbarItems.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAA4B,EACJ,EAAE;IAC1B,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,cAAc,CAAC,OAAO;YAAE,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;aACtD;YACH,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACzB;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7B,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YACjD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport type { ToolbarItemsManager } from \"./ToolbarItemsManager\";\n\n/** Hook that returns items from [[ToolbarItemsManager]].\n * @public\n */\nexport const useDefaultToolbarItems = (\n  manager: ToolbarItemsManager\n): readonly ToolbarItem[] => {\n  const [items, setItems] = React.useState(() => manager.items);\n  const isInitialMount = React.useRef(true);\n  React.useEffect(() => {\n    if (isInitialMount.current) isInitialMount.current = false;\n    else {\n      setItems(manager.items);\n    }\n  }, [manager, manager.items]);\n  React.useEffect(() => {\n    return manager.onItemsChanged.addListener((args) => {\n      setItems(args.items);\n    });\n  }, [manager]);\n  return items;\n};\n"]}
+{"version":3,"file":"useDefaultToolbarItems.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useDefaultToolbarItems.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;AACpC,mDAAmD;AACnD,OAA4B,EACJ,EAAE;IAC1B,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,cAAc,CAAC,OAAO;YAAE,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;aACtD;YACH,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACzB;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7B,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YACjD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport type { ToolbarItemsManager } from \"./ToolbarItemsManager\";\n\n/** Hook that returns items from [[ToolbarItemsManager]].\n * @public\n * @deprecated in 4.4.0. Use [[Toolbar]] component instead of this hooks, ToolbarItemsManager is internal and should not be used here.\n */\nexport const useDefaultToolbarItems = (\n  // eslint-disable-next-line deprecation/deprecation\n  manager: ToolbarItemsManager\n): readonly ToolbarItem[] => {\n  const [items, setItems] = React.useState(() => manager.items);\n  const isInitialMount = React.useRef(true);\n  React.useEffect(() => {\n    if (isInitialMount.current) isInitialMount.current = false;\n    else {\n      setItems(manager.items);\n    }\n  }, [manager, manager.items]);\n  React.useEffect(() => {\n    return manager.onItemsChanged.addListener((args) => {\n      setItems(args.items);\n    });\n  }, [manager]);\n  return items;\n};\n"]}

package/lib/esm/appui-react/toolbar/useUiItemsProviderToolbarItems.d.ts

@@ -3,8 +3,9 @@
  */
 import type { ToolbarItem, ToolbarOrientation, ToolbarUsage } from "./ToolbarItem";
 import type { ToolbarItemsManager } from "./ToolbarItemsManager";
-/** Hook that returns items from [[ToolbarItemsManager]].
+/** Hook that retrieves active frontstage toolbar items from UiItemsProviders and manage them through [[ToolbarItemsManager]].
  * @public
+ * @deprecated in 4.4.0. This uses ToolbarItemsManager which is internal, directly use [[ToolbarComposer]] instead.
  */
 export declare const useUiItemsProviderToolbarItems: (manager: ToolbarItemsManager, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => readonly ToolbarItem[];
 //# sourceMappingURL=useUiItemsProviderToolbarItems.d.ts.map

package/lib/esm/appui-react/toolbar/useUiItemsProviderToolbarItems.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useUiItemsProviderToolbarItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useUiItemsProviderToolbarItems.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAMH,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACb,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;GAEG;AACH,eAAO,MAAM,8BAA8B,YAChC,mBAAmB,gBACd,YAAY,sBACN,kBAAkB,KACrC,SAAS,WAAW,EAqCtB,CAAC"}
+{"version":3,"file":"useUiItemsProviderToolbarItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useUiItemsProviderToolbarItems.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACb,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAGjE;;;GAGG;AACH,eAAO,MAAM,8BAA8B,YAEhC,mBAAmB,gBACd,YAAY,sBACN,kBAAkB,KACrC,SAAS,WAAW,EAetB,CAAC"}

package/lib/esm/appui-react/toolbar/useUiItemsProviderToolbarItems.js

@@ -6,41 +6,23 @@
  * @module Toolbar
  */
 import * as React from "react";
-import { useActiveStageId } from "../hooks/useActiveStageId";
-import { useAvailableUiItemsProviders } from "../hooks/useAvailableUiItemsProviders";
-import { UiFramework } from "../UiFramework";
-import { UiItemsManager } from "../ui-items-provider/UiItemsManager";
-/** Hook that returns items from [[ToolbarItemsManager]].
+import { useActiveStageProvidedToolbarItems } from "./useActiveStageProvidedToolbarItems";
+/** Hook that retrieves active frontstage toolbar items from UiItemsProviders and manage them through [[ToolbarItemsManager]].
  * @public
+ * @deprecated in 4.4.0. This uses ToolbarItemsManager which is internal, directly use [[ToolbarComposer]] instead.
  */
-export const useUiItemsProviderToolbarItems = (manager, toolbarUsage, toolbarOrientation) => {
-    const uiItemsProviderIds = useAvailableUiItemsProviders();
-    const stageId = useActiveStageId();
-    const [items, setItems] = React.useState(manager.items);
-    const providersRef = React.useRef("");
-    const currentStageRef = React.useRef("");
-    // gathers items from registered extensions - dependent on when a uiItemsProvider is register or unregistered and if the
-    // current stage's composer allows entries from extensions.
+export const useUiItemsProviderToolbarItems = (
+// eslint-disable-next-line deprecation/deprecation
+manager, toolbarUsage, toolbarOrientation) => {
+    const providedItems = useActiveStageProvidedToolbarItems(toolbarUsage, toolbarOrientation);
+    const [items, setItems] = React.useState(providedItems);
     React.useEffect(() => {
-        const uiProviders = uiItemsProviderIds.join("-");
-        // istanbul ignore else
-        if (providersRef.current !== uiProviders ||
-            currentStageRef.current !== stageId) {
-            const frontstageDef = UiFramework.frontstages.activeFrontstageDef;
-            // istanbul ignore else
-            if (frontstageDef) {
-                const usage = frontstageDef.usage;
-                currentStageRef.current = stageId;
-                providersRef.current = uiProviders;
-                const toolbarItems = UiItemsManager.getToolbarButtonItems(stageId, usage, toolbarUsage, toolbarOrientation);
-                manager.loadItems(toolbarItems);
-                setItems(manager.items);
-            }
-        }
-        return manager.onItemsChanged.addListener((args) => {
+        manager?.loadItems(providedItems);
+        setItems(manager?.items ?? providedItems);
+        return manager?.onItemsChanged.addListener((args) => {
             setItems(args.items);
         });
-    }, [uiItemsProviderIds, stageId, manager, toolbarUsage, toolbarOrientation]);
+    }, [manager, providedItems]);
     return items;
 };
 //# sourceMappingURL=useUiItemsProviderToolbarItems.js.map

package/lib/esm/appui-react/toolbar/useUiItemsProviderToolbarItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"useUiItemsProviderToolbarItems.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useUiItemsProviderToolbarItems.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAM7C,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAGrE;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,OAA4B,EAC5B,YAA0B,EAC1B,kBAAsC,EACd,EAAE;IAC1B,MAAM,kBAAkB,GAAG,4BAA4B,EAAE,CAAC;IAC1D,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtC,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzC,wHAAwH;IACxH,2DAA2D;IAC3D,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,WAAW,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjD,uBAAuB;QACvB,IACE,YAAY,CAAC,OAAO,KAAK,WAAW;YACpC,eAAe,CAAC,OAAO,KAAK,OAAO,EACnC;YACA,MAAM,aAAa,GAAG,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC;YAClE,uBAAuB;YACvB,IAAI,aAAa,EAAE;gBACjB,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;gBAClC,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;gBAClC,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC;gBACnC,MAAM,YAAY,GAAG,cAAc,CAAC,qBAAqB,CACvD,OAAO,EACP,KAAK,EACL,YAAY,EACZ,kBAAkB,CACnB,CAAC;gBACF,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAChC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aACzB;SACF;QACD,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YACjD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,kBAAkB,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC7E,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport { useActiveStageId } from \"../hooks/useActiveStageId\";\nimport { useAvailableUiItemsProviders } from \"../hooks/useAvailableUiItemsProviders\";\nimport { UiFramework } from \"../UiFramework\";\nimport type {\n  ToolbarItem,\n  ToolbarOrientation,\n  ToolbarUsage,\n} from \"./ToolbarItem\";\nimport { UiItemsManager } from \"../ui-items-provider/UiItemsManager\";\nimport type { ToolbarItemsManager } from \"./ToolbarItemsManager\";\n\n/** Hook that returns items from [[ToolbarItemsManager]].\n * @public\n */\nexport const useUiItemsProviderToolbarItems = (\n  manager: ToolbarItemsManager,\n  toolbarUsage: ToolbarUsage,\n  toolbarOrientation: ToolbarOrientation\n): readonly ToolbarItem[] => {\n  const uiItemsProviderIds = useAvailableUiItemsProviders();\n  const stageId = useActiveStageId();\n  const [items, setItems] = React.useState(manager.items);\n  const providersRef = React.useRef(\"\");\n  const currentStageRef = React.useRef(\"\");\n  // gathers items from registered extensions - dependent on when a uiItemsProvider is register or unregistered and if the\n  // current stage's composer allows entries from extensions.\n  React.useEffect(() => {\n    const uiProviders = uiItemsProviderIds.join(\"-\");\n\n    // istanbul ignore else\n    if (\n      providersRef.current !== uiProviders ||\n      currentStageRef.current !== stageId\n    ) {\n      const frontstageDef = UiFramework.frontstages.activeFrontstageDef;\n      // istanbul ignore else\n      if (frontstageDef) {\n        const usage = frontstageDef.usage;\n        currentStageRef.current = stageId;\n        providersRef.current = uiProviders;\n        const toolbarItems = UiItemsManager.getToolbarButtonItems(\n          stageId,\n          usage,\n          toolbarUsage,\n          toolbarOrientation\n        );\n        manager.loadItems(toolbarItems);\n        setItems(manager.items);\n      }\n    }\n    return manager.onItemsChanged.addListener((args) => {\n      setItems(args.items);\n    });\n  }, [uiItemsProviderIds, stageId, manager, toolbarUsage, toolbarOrientation]);\n  return items;\n};\n"]}
+{"version":3,"file":"useUiItemsProviderToolbarItems.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/useUiItemsProviderToolbarItems.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAO/B,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAE1F;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG;AAC5C,mDAAmD;AACnD,OAA4B,EAC5B,YAA0B,EAC1B,kBAAsC,EACd,EAAE;IAC1B,MAAM,aAAa,GAAG,kCAAkC,CACtD,YAAY,EACZ,kBAAkB,CACnB,CAAC;IACF,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IACxD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;QAClC,QAAQ,CAAC,OAAO,EAAE,KAAK,IAAI,aAAa,CAAC,CAAC;QAE1C,OAAO,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YAClD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;IAC7B,OAAO,KAAK,CAAC;AACf,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type {\n  ToolbarItem,\n  ToolbarOrientation,\n  ToolbarUsage,\n} from \"./ToolbarItem\";\nimport type { ToolbarItemsManager } from \"./ToolbarItemsManager\";\nimport { useActiveStageProvidedToolbarItems } from \"./useActiveStageProvidedToolbarItems\";\n\n/** Hook that retrieves active frontstage toolbar items from UiItemsProviders and manage them through [[ToolbarItemsManager]].\n * @public\n * @deprecated in 4.4.0. This uses ToolbarItemsManager which is internal, directly use [[ToolbarComposer]] instead.\n */\nexport const useUiItemsProviderToolbarItems = (\n  // eslint-disable-next-line deprecation/deprecation\n  manager: ToolbarItemsManager,\n  toolbarUsage: ToolbarUsage,\n  toolbarOrientation: ToolbarOrientation\n): readonly ToolbarItem[] => {\n  const providedItems = useActiveStageProvidedToolbarItems(\n    toolbarUsage,\n    toolbarOrientation\n  );\n  const [items, setItems] = React.useState(providedItems);\n  React.useEffect(() => {\n    manager?.loadItems(providedItems);\n    setItems(manager?.items ?? providedItems);\n\n    return manager?.onItemsChanged.addListener((args) => {\n      setItems(args.items);\n    });\n  }, [manager, providedItems]);\n  return items;\n};\n"]}

package/lib/esm/appui-react/tools/CoreToolDefinitions.js

@@ -77,9 +77,8 @@ export class CoreTools {
         return new ToolItemDef({
             toolId: RotateViewTool.toolId,
             iconSpec: new ConditionalStringValue(() => {
-                var _a;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                if ((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is2d())
+                if (activeContentControl?.viewport?.view.is2d())
                     return IconSpecUtilities.createWebComponentIconSpec(svgRotateLeft);
                 return IconSpecUtilities.createWebComponentIconSpec(svgGyroscope);
             }, [
@@ -99,9 +98,8 @@ export class CoreTools {
             label: WalkViewTool.flyover,
             description: WalkViewTool.description,
             isHidden: new ConditionalBooleanValue(() => {
-                var _a;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                return !!((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is2d());
+                return !!activeContentControl?.viewport?.view.is2d();
             }, [
                 SyncUiEventId.ActiveContentChanged,
                 SyncUiEventId.ActiveViewportChanged,
@@ -132,10 +130,9 @@ export class CoreTools {
         return new ToolItemDef({
             toolId: ViewToggleCameraTool.toolId,
             iconSpec: new ConditionalStringValue(() => {
-                var _a, _b;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                if (((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is3d()) &&
-                    ((_b = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _b === void 0 ? void 0 : _b.isCameraOn)) {
+                if (activeContentControl?.viewport?.view.is3d() &&
+                    activeContentControl?.viewport?.isCameraOn) {
                     return IconSpecUtilities.createWebComponentIconSpec(cameraAnimationIcon);
                 }
                 return IconSpecUtilities.createWebComponentIconSpec(cameraAnimationDisabledIcon);
@@ -145,10 +142,9 @@ export class CoreTools {
                 SyncUiEventId.ViewStateChanged,
             ]),
             label: new ConditionalStringValue(() => {
-                var _a, _b;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                if (((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is3d()) &&
-                    ((_b = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _b === void 0 ? void 0 : _b.isCameraOn)) {
+                if (activeContentControl?.viewport?.view.is3d() &&
+                    activeContentControl?.viewport?.isCameraOn) {
                     return UiFramework.translate("tools.View.ToggleCamera.turnOffFlyover");
                 }
                 return UiFramework.translate("tools.View.ToggleCamera.turnOnFlyover");
@@ -159,10 +155,9 @@ export class CoreTools {
             ]),
             description: ViewToggleCameraTool.description,
             isHidden: new ConditionalBooleanValue(() => {
-                var _a, _b;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                return !(((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is3d()) &&
-                    ((_b = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _b === void 0 ? void 0 : _b.view.supportsCamera()));
+                return !(activeContentControl?.viewport?.view.is3d() &&
+                    activeContentControl?.viewport?.view.supportsCamera());
             }, [
                 SyncUiEventId.ActiveContentChanged,
                 SyncUiEventId.ActiveViewportChanged,
@@ -289,9 +284,8 @@ export class CoreTools {
             labelKey: "UiFramework:tools.sectionTools",
             iconSpec: IconSpecUtilities.createWebComponentIconSpec(svgSectionTool),
             isHidden: new ConditionalBooleanValue(() => {
-                var _a;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                return !!((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is2d());
+                return !!activeContentControl?.viewport?.view.is2d();
             }, [
                 SyncUiEventId.ActiveContentChanged,
                 SyncUiEventId.ActiveViewportChanged,
@@ -317,9 +311,8 @@ export class CoreTools {
             panelLabelKey: "UiFramework:tools.sectionPanelLabel",
             iconSpec: IconSpecUtilities.createWebComponentIconSpec(svgSectionTool),
             isHidden: new ConditionalBooleanValue(() => {
-                var _a;
                 const activeContentControl = UiFramework.content.getActiveContentControl();
-                return !!((_a = activeContentControl === null || activeContentControl === void 0 ? void 0 : activeContentControl.viewport) === null || _a === void 0 ? void 0 : _a.view.is2d());
+                return !!activeContentControl?.viewport?.view.is2d();
             }, [
                 SyncUiEventId.ActiveContentChanged,
                 SyncUiEventId.ActiveViewportChanged,