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

package/lib/appui-react/toolbar/ToolbarComposer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarComposer.js","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarComposer.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACL,SAAS,EACT,WAAW,EACX,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAMrE,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,kCAAkC,EAAE,MAAM,yCAAyC,CAAC;AAE7F,SAAS,6BAA6B,CACpC,KAAmB,EACnB,aAA0D;IAE1D,MAAM,QAAQ,GAAQ,EAAE,CAAC;IACzB,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACrC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC3B,SAAS;QACX,CAAC;QAED,MAAM,WAAW,GAAG,6BAA6B,CAC/C,WAAW,CAAC,KAAK,EACjB,aAAa,CACd,CAAC;QACF,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrC,IAAI,KAAK,CAAC,iBAAiB,KAAK,WAAW,CAAC,EAAE,EAAE,CAAC;gBAC/C,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACxB,8EAA8E;YAC9E,YAAY;iBACT,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;iBACrB,OAAO,EAAE;iBACT,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtB,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC5C,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACP,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,UAAU,CAAC,OAAyB;IAC3C,MAAM,UAAU,GAAgD,EAAE,CAAC;IACnE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,IAAI,kBAAkB,CAAC,IAAI,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;;YAC3D,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;IACtD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAiB;IACzC,MAAM,UAAU,GAAG,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;IAC7E,OAAO,UAAU,GAAG,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;AAChD,CAAC;AAED,SAAS,SAAS,CAAC,KAAiC;IAClD,OAAO,CAAC,GAAG,KAAK,CAAC;SACd,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;SACzD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,IAAI,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7C,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CACxB,KAAoB,EACpB,aAAuD;IAEvD,OAAO,CAAC,OAAoB,EAAE,EAAE;QAC9B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YAC7D,sGAAsG;YACtG,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC;gBAC7C,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;gBACrB,CAAC,CAAC,OAAO,CAAC;YACZ,IACE,CAAC,kBAAkB,CAAC,WAAW,CAAC,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;gBACrE,WAAW,CAAC,iBAAiB;gBAE7B,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;;gBAC7B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,SAAS,YAAY,CACnB,YAAwC,EACxC,UAAsC;IAEtC,IAAI,KAAK,GAAkB,EAAE,CAAC;IAC9B,MAAM,aAAa,GAAgD,EAAE,CAAC;IAEtE,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAC9D,UAAU,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5D,2IAA2I;IAC3I,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;QACzB,KAAK,GAAG,6BAA6B,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAE5D,aAAa,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACpC,MAAM,CAAC,UAAU,CACf,iBAAiB,EACjB,2BAA2B,WAAW,CAAC,iBAAkB,yBACvD,WAAW,CAAC,EACd,iCAAiC,CAClC,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,0BAA0B,GAAG,GAAG,EAAE;IACtC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC5D,WAAW,CAAC,UAAU,CAAC,mBAAmB,CAAC,8CAA8C;KAC1F,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,WAAW,CAAC,qBAAqB,CAAC,WAAW,CAC3C,GAAG,EAAE,CAAC,mBAAmB,CAAC,WAAW,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,8CAA8C;SACrH,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,GAAG,EAAE;IACvC,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC9D,WAAW,CAAC,UAAU,CAAC,iBAAiB,CACzC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,WAAW,CAAC,qBAAqB,CAAC,WAAW,CAAC,GAAG,EAAE,CACjD,oBAAoB,CAAC,WAAW,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAC/D,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAeF;;;;GAIG;AACH,mDAAmD;AACnD,MAAM,UAAU,eAAe,CAAC,KAA6B;IAC3D,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAErC,wCAAwC;IACxC,MAAM,UAAU,GAAG,kCAAkC,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAE1E,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;IAE9B,MAAM,KAAK,GAAG,2BAA2B,CAAC,QAAQ,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IAE7E,MAAM,kBAAkB,GACtB,WAAW,KAAK,kBAAkB,CAAC,UAAU;QAC3C,CAAC,CAAC,WAAW,CAAC,UAAU;QACxB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC;IAC3B,MAAM,SAAS,GACb,kBAAkB,KAAK,WAAW,CAAC,UAAU;QAC3C,CAAC,CAAC,SAAS,CAAC,MAAM;QAClB,CAAC,CAAC,KAAK,KAAK,YAAY,CAAC,cAAc;YACvC,CAAC,CAAC,SAAS,CAAC,IAAI;YAChB,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC;IACtB,MAAM,cAAc,GAClB,kBAAkB,KAAK,WAAW,CAAC,UAAU;QAC7C,KAAK,KAAK,YAAY,CAAC,cAAc;QACnC,CAAC,CAAC,qBAAqB,CAAC,GAAG;QAC3B,CAAC,CAAC,qBAAqB,CAAC,KAAK,CAAC;IAClC,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;IACtE,MAAM,mBAAmB,GAAG,0BAA0B,EAAE,CAAC;IACzD,MAAM,iBAAiB,GAAG,2BAA2B,EAAE,CAAC;IAExD,OAAO,CACL,oBAAC,OAAO,IACN,cAAc,EAAE,IAAI,EACpB,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,EACZ,kBAAkB,EAAE,aAAa,EACjC,qBAAqB,EACnB,CAAC,mBAAmB,IAAI,iBAAiB,CAAC;YAC1C,CAAC,eAAe,CAAC,eAAe;YAC9B,CAAC,CAAC,qBAAqB,CAAC,SAAS;YACjC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,GAEpC,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 {\n  Direction,\n  Orientation,\n  ToolbarOpacitySetting,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport { Logger, ProcessDetector } from \"@itwin/core-bentley\";\nimport { UiFramework } from \"../UiFramework.js\";\nimport { ToolbarDragInteractionContext } from \"./DragInteraction.js\";\nimport type {\n  ToolbarActionItem,\n  ToolbarGroupItem,\n  ToolbarItem,\n} from \"./ToolbarItem.js\";\nimport {\n  isToolbarActionItem,\n  isToolbarGroupItem,\n  ToolbarOrientation,\n  ToolbarUsage,\n} from \"./ToolbarItem.js\";\nimport { Toolbar } from \"./Toolbar.js\";\nimport { useActiveToolIdSynchedItems } from \"./useActiveToolIdSynchedItems.js\";\nimport { useActiveStageProvidedToolbarItems } from \"./useActiveStageProvidedToolbarItems.js\";\n\nfunction addItemToSpecifiedParentGroup<T extends ToolbarItem>(\n  items: readonly T[],\n  groupChildren: Array<ToolbarActionItem | ToolbarGroupItem>\n): T[] {\n  const outItems: T[] = [];\n  for (const toolbarItem of items) {\n    if (!isToolbarGroupItem(toolbarItem)) {\n      outItems.push(toolbarItem);\n      continue;\n    }\n\n    const newChildren = addItemToSpecifiedParentGroup(\n      toolbarItem.items,\n      groupChildren\n    );\n    const foundIndices: number[] = [];\n\n    groupChildren.forEach((entry, index) => {\n      if (entry.parentGroupItemId === toolbarItem.id) {\n        foundIndices.push(index);\n      }\n    });\n\n    if (foundIndices.length) {\n      // process in reverse order so groupChildren can be reduced as we find matches\n      foundIndices\n        .sort((a, b) => a - b)\n        .reverse()\n        .forEach((foundIndex) => {\n          newChildren.push(groupChildren[foundIndex]);\n          groupChildren.splice(foundIndex);\n        });\n    }\n\n    outItems.push({ ...toolbarItem, items: newChildren });\n  }\n  return outItems;\n}\n\nfunction cloneGroup(inGroup: ToolbarGroupItem): ToolbarGroupItem {\n  const childItems: Array<ToolbarActionItem | ToolbarGroupItem> = [];\n  inGroup.items.forEach((item) => {\n    if (isToolbarGroupItem(item)) childItems.push(cloneGroup(item));\n    else childItems.push(item);\n  });\n\n  const clonedGroup = { ...inGroup, items: childItems };\n  return clonedGroup;\n}\n\nfunction getItemSortValue(item: ToolbarItem) {\n  const groupValue = undefined === item.groupPriority ? 0 : item.groupPriority;\n  return groupValue * 10000 + item.itemPriority;\n}\n\nfunction sortItems(items: ReadonlyArray<ToolbarItem>): ToolbarItem[] {\n  return [...items]\n    .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))\n    .map((i) => {\n      if (isToolbarGroupItem(i)) {\n        return { ...i, items: sortItems(i.items) };\n      }\n      return i;\n    });\n}\n\n/**\n * Create a forEach handler that will add every element of an array of ToolbarItems\n * to a list of items that can then be replaced in its proper place, ensuring that\n * the same item, from different list, is not added multiple times.\n * @param items Output list of items\n * @param groupChildren Output list of group children to redistribute.\n * @returns Array<ToolbarItem>.forEach handler.\n */\nfunction addIfNotDuplicate(\n  items: ToolbarItem[],\n  groupChildren: (ToolbarActionItem | ToolbarGroupItem)[]\n): (value: ToolbarItem) => void {\n  return (srcItem: ToolbarItem) => {\n    if (-1 === items.findIndex((item) => item.id === srcItem.id)) {\n      // if the default item is a group that an addon may insert into copy it so we don't mess with original\n      const toolbarItem = isToolbarGroupItem(srcItem)\n        ? cloneGroup(srcItem)\n        : srcItem;\n      if (\n        (isToolbarGroupItem(toolbarItem) || isToolbarActionItem(toolbarItem)) &&\n        toolbarItem.parentGroupItemId\n      )\n        groupChildren.push(toolbarItem);\n      else items.push(toolbarItem);\n    }\n  };\n}\n\n/** local function to combine items from Stage and from Extensions */\nfunction combineItems(\n  defaultItems: ReadonlyArray<ToolbarItem>,\n  addonItems: ReadonlyArray<ToolbarItem>\n): ToolbarItem[] {\n  let items: ToolbarItem[] = [];\n  const groupChildren: Array<ToolbarActionItem | ToolbarGroupItem> = [];\n\n  defaultItems.forEach(addIfNotDuplicate(items, groupChildren));\n  addonItems.forEach(addIfNotDuplicate(items, groupChildren));\n\n  // if an item from an addon has specified a parent group then try to find it and insert it.  If no parent is found, add item at root level.\n  if (groupChildren.length) {\n    items = addItemToSpecifiedParentGroup(items, groupChildren);\n\n    groupChildren.forEach((toolbarItem) => {\n      Logger.logWarning(\n        \"ToolbarComposer\",\n        `Requested Parent Group [${toolbarItem.parentGroupItemId!}] not found, so item [${\n          toolbarItem.id\n        }] is added directly to toolbar.`\n      );\n      items.push(toolbarItem);\n    });\n  }\n\n  return sortItems(items);\n}\n\nconst useProximityOpacitySetting = () => {\n  const [proximityOpacity, setProximityOpacity] = React.useState(\n    UiFramework.visibility.useProximityOpacity // eslint-disable-line deprecation/deprecation\n  );\n\n  React.useEffect(() => {\n    UiFramework.onUiVisibilityChanged.addListener(\n      () => setProximityOpacity(UiFramework.visibility.useProximityOpacity) // eslint-disable-line deprecation/deprecation\n    );\n  }, []);\n\n  return proximityOpacity;\n};\n\nconst useSnapWidgetOpacitySetting = () => {\n  const [snapWidgetOpacity, setSnapWidgetOpacity] = React.useState(\n    UiFramework.visibility.snapWidgetOpacity\n  );\n\n  React.useEffect(() => {\n    UiFramework.onUiVisibilityChanged.addListener(() =>\n      setSnapWidgetOpacity(UiFramework.visibility.snapWidgetOpacity)\n    );\n  }, []);\n\n  return snapWidgetOpacity;\n};\n\n/** Properties for the [[ToolbarComposer]] React components\n * @public\n * @deprecated in 4.17.0. Use `React.ComponentProps<typeof ToolbarComposer>`\n */\nexport interface ExtensibleToolbarProps {\n  /** Toolbar items. */\n  items: ToolbarItem[];\n  /** Toolbar usage based on which additional toolbar items are added from UI item providers. */\n  usage: ToolbarUsage;\n  /** Toolbar orientation. */\n  orientation: ToolbarOrientation;\n}\n\n/**\n * Toolbar that is populated and maintained by UI item providers.\n * @note Overrides `isActive` property based on the active tool id.\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport function ToolbarComposer(props: ExtensibleToolbarProps) {\n  const { usage, orientation } = props;\n\n  // process items from addon UI providers\n  const addonItems = useActiveStageProvidedToolbarItems(usage, orientation);\n\n  const allItems = React.useMemo(() => {\n    return combineItems(props.items, addonItems);\n  }, [props.items, addonItems]);\n\n  const items = useActiveToolIdSynchedItems(allItems, UiFramework.frontstages);\n\n  const toolbarOrientation =\n    orientation === ToolbarOrientation.Horizontal\n      ? Orientation.Horizontal\n      : Orientation.Vertical;\n  const expandsTo =\n    toolbarOrientation === Orientation.Horizontal\n      ? Direction.Bottom\n      : usage === ToolbarUsage.ViewNavigation\n      ? Direction.Left\n      : Direction.Right;\n  const panelAlignment =\n    toolbarOrientation === Orientation.Horizontal &&\n    usage === ToolbarUsage.ViewNavigation\n      ? ToolbarPanelAlignment.End\n      : ToolbarPanelAlignment.Start;\n  const isDragEnabled = React.useContext(ToolbarDragInteractionContext);\n  const useProximityOpacity = useProximityOpacitySetting();\n  const snapWidgetOpacity = useSnapWidgetOpacitySetting();\n\n  return (\n    <Toolbar\n      enableOverflow={true}\n      expandsTo={expandsTo}\n      panelAlignment={panelAlignment}\n      items={items}\n      useDragInteraction={isDragEnabled}\n      toolbarOpacitySetting={\n        (useProximityOpacity || snapWidgetOpacity) &&\n        !ProcessDetector.isMobileBrowser\n          ? ToolbarOpacitySetting.Proximity\n          : ToolbarOpacitySetting.Defaults\n      }\n    />\n  );\n}\n"]}

package/lib/appui-react/toolbar/ToolbarHelper.d.ts

@@ -0,0 +1,45 @@
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import type * as React from "react";
+import type { ActionButton, CustomButtonDefinition, GroupButton } from "@itwin/appui-abstract";
+import type { BadgeKind } from "@itwin/core-react/internal";
+import type { AnyItemDef } from "../shared/AnyItemDef.js";
+import { CommandItemDef } from "../shared/CommandItemDef.js";
+import { CustomItemDef } from "../shared/CustomItemDef.js";
+import { ToolItemDef } from "../shared/ToolItemDef.js";
+import { GroupItemDef } from "./GroupItem.js";
+import type { ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem, ToolbarItem } from "./ToolbarItem.js";
+import type { CommonToolbarItemWithBadgeKind } from "@itwin/components-react/internal";
+/** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.
+ * @public
+ * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+ */
+export declare class ToolbarHelper {
+    /** Construct ToolbarCustomItem definitions given a CustomItemDef.
+     * @deprecated in 4.15.0. Use `ToolbarItemUtilities.createCustomItem` instead.
+     */
+    static createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition & {
+        badgeKind?: BadgeKind;
+    }>): ToolbarCustomItem;
+    /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
+    static constructChildToolbarItems(itemDefs: AnyItemDef[]): Array<ToolbarActionItem | ToolbarGroupItem>;
+    private static getStringOrConditionalString;
+    /** @deprecated in 4.15.0. Use {@link @itwin/core-react#IconHelper} instead. */
+    static getIconReactNode(item: ActionButton | GroupButton): React.ReactNode;
+    /** Helper method to creates a generic toolbar item entry.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
+    static createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<CommonToolbarItemWithBadgeKind>): ToolbarItem;
+    /** Helper method to creates a generic toolbar item entry list.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
+    static createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority?: number, overrides?: Partial<CommonToolbarItemWithBadgeKind>): ToolbarItem[];
+}
+/** @internal */
+export declare function itemDefToToolbarActionItem(itemDef: ToolItemDef | CommandItemDef, overrides?: Partial<ToolbarActionItem>): ToolbarActionItem;
+/** @internal */
+export declare function itemDefToToolbarGroupItem(itemDef: GroupItemDef, overrides?: Partial<ToolbarGroupItem>): ToolbarGroupItem;
+//# sourceMappingURL=ToolbarHelper.d.ts.map

package/lib/appui-react/toolbar/ToolbarHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarHelper.d.ts","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EACV,YAAY,EACZ,sBAAsB,EACtB,WAAW,EAEZ,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACZ,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAmCvF;;;GAGG;AACH,qBAAa,aAAa;IACxB;;OAEG;WACW,iCAAiC,CAC7C,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,aAAa,EACtB,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,GAAG;QAAE,SAAS,CAAC,EAAE,SAAS,CAAA;KAAE,CAAC,GACtE,iBAAiB;IAIpB;;OAEG;WACW,0BAA0B,CACtC,QAAQ,EAAE,UAAU,EAAE,GACrB,KAAK,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAI9C,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAY3C,+EAA+E;WACjE,gBAAgB,CAC5B,IAAI,EAAE,YAAY,GAAG,WAAW,GAC/B,KAAK,CAAC,SAAS;IAKlB;;OAEG;WACW,4BAA4B,CACxC,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,UAAU,EACnB,SAAS,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,GAClD,WAAW;IAmDd;;OAEG;WACW,8BAA8B,CAC1C,QAAQ,EAAE,UAAU,EAAE,EACtB,oBAAoB,SAAK,EACzB,SAAS,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,GAClD,WAAW,EAAE;CAQjB;AAED,gBAAgB;AAChB,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,WAAW,GAAG,cAAc,EACrC,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,iBAAiB,CAOnB;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,YAAY,EACrB,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,GACpC,gBAAgB,CAOlB"}

package/lib/appui-react/toolbar/ToolbarHelper.js

@@ -0,0 +1,129 @@
+import { ConditionalStringValue } from "@itwin/appui-abstract";
+import { assert } from "@itwin/core-bentley";
+import { IconHelper } from "@itwin/core-react";
+import { CommandItemDef } from "../shared/CommandItemDef.js";
+import { CustomItemDef } from "../shared/CustomItemDef.js";
+import { ToolItemDef } from "../shared/ToolItemDef.js";
+import { GroupItemDef } from "./GroupItem.js";
+import { isToolbarActionItem, isToolbarGroupItem } from "./ToolbarItem.js";
+/* eslint-disable deprecation/deprecation */
+/**
+ * Common implementation for `constructChildToolbarItems` and `createToolbarItemsFromItemDefs`.
+ * @param itemDefs List of itemDefs to convert.
+ * @param allowCustom false if we are building children and don't support custom items.
+ * @param startingItemPriority defaults to 10.
+ * @param overrides Single override to apply to each itemDefs.
+ * @returns ToolbarItem[] or (ToolbarActionItem | ToolbarGroupItem) if allowCustom is false.
+ */
+function constructToolbarItemArray(itemDefs, allowCustom, startingItemPriority = 10, overrides) {
+    let priority = startingItemPriority;
+    const items = [];
+    for (const itemDef of itemDefs) {
+        const item = ToolbarHelper.createToolbarItemFromItemDef(priority, itemDef, overrides);
+        priority = priority + 10;
+        if (allowCustom || isToolbarActionItem(item) || isToolbarGroupItem(item))
+            items.push(item);
+    }
+    return items;
+}
+/** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.
+ * @public
+ * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+ */
+export class ToolbarHelper {
+    /** Construct ToolbarCustomItem definitions given a CustomItemDef.
+     * @deprecated in 4.15.0. Use `ToolbarItemUtilities.createCustomItem` instead.
+     */
+    static createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides) {
+        return this.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);
+    }
+    /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
+    static constructChildToolbarItems(itemDefs) {
+        return constructToolbarItemArray(itemDefs, false);
+    }
+    static getStringOrConditionalString(inString) {
+        if (inString instanceof ConditionalStringValue ||
+            typeof inString === "string")
+            return inString;
+        return inString();
+    }
+    /** @deprecated in 4.15.0. Use {@link @itwin/core-react#IconHelper} instead. */
+    static getIconReactNode(item) {
+        // eslint-disable-next-line deprecation/deprecation
+        return IconHelper.getIconReactNode(item.icon, item.internalData);
+    }
+    /** Helper method to creates a generic toolbar item entry.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
+    static createToolbarItemFromItemDef(itemPriority, itemDef, overrides) {
+        const { badgeType, badgeKind, description, icon, internalData, ...itemOverrides } = overrides ?? {};
+        const itemBase = {
+            id: itemDef.id,
+            itemPriority,
+            isActive: itemDef.isActive,
+            isHidden: itemDef.isHidden,
+            isDisabled: itemDef.isDisabled,
+            icon: internalData?.get(IconHelper.reactIconKey) ?? // eslint-disable-line deprecation/deprecation
+                internalData?.get(IconHelper.conditionalIconItemKey) ?? // eslint-disable-line deprecation/deprecation
+                icon ??
+                itemDef.iconSpec,
+            label: this.getStringOrConditionalString(itemDef.rawLabel),
+            badge: badgeType ?? itemDef.badgeType,
+            badgeKind: badgeKind ?? itemDef.badgeKind,
+            description: description ?? itemDef.description,
+        };
+        if (itemDef instanceof CommandItemDef || itemDef instanceof ToolItemDef) {
+            return {
+                ...itemBase,
+                execute: itemDef.execute,
+                ...itemOverrides,
+            };
+        }
+        else if (itemDef instanceof CustomItemDef) {
+            return {
+                ...itemBase,
+                panelContent: itemDef.popupPanelNode,
+                ...itemOverrides,
+            };
+        }
+        else if (itemDef instanceof GroupItemDef) {
+            return {
+                ...itemBase,
+                panelLabel: itemDef.panelLabel,
+                items: this.constructChildToolbarItems(itemDef.items),
+                isActive: false,
+                ...itemOverrides,
+            };
+        }
+        else {
+            throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);
+        }
+    }
+    /** Helper method to creates a generic toolbar item entry list.
+     * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.
+     */
+    static createToolbarItemsFromItemDefs(itemDefs, startingItemPriority = 10, overrides) {
+        return constructToolbarItemArray(itemDefs, true, startingItemPriority, overrides);
+    }
+}
+/** @internal */
+export function itemDefToToolbarActionItem(itemDef, overrides) {
+    const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);
+    assert(isToolbarActionItem(item));
+    return {
+        ...item,
+        ...overrides,
+    };
+}
+/** @internal */
+export function itemDefToToolbarGroupItem(itemDef, overrides) {
+    const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);
+    assert(isToolbarGroupItem(item));
+    return {
+        ...item,
+        ...overrides,
+    };
+}
+//# sourceMappingURL=ToolbarHelper.js.map

package/lib/appui-react/toolbar/ToolbarHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarHelper.js","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAO9C,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAI3E,4CAA4C;AAE5C;;;;;;;GAOG;AACH,SAAS,yBAAyB,CAChC,QAAsB,EACtB,WAAc,EACd,oBAAoB,GAAG,EAAE,EACzB,SAAmD;IAEnD,IAAI,QAAQ,GAAG,oBAAoB,CAAC;IACpC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CACrD,QAAQ,EACR,OAAO,EACP,SAAS,CACV,CAAC;QACF,QAAQ,GAAG,QAAQ,GAAG,EAAE,CAAC;QACzB,IAAI,WAAW,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC;YACtE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,KAEwC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,aAAa;IACxB;;OAEG;IACI,MAAM,CAAC,iCAAiC,CAC7C,YAAoB,EACpB,OAAsB,EACtB,SAAuE;QAEvE,OAAO,IAAI,CAAC,4BAA4B,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CACtC,QAAsB;QAEtB,OAAO,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEO,MAAM,CAAC,4BAA4B,CACzC,QAAwD;QAExD,IACE,QAAQ,YAAY,sBAAsB;YAC1C,OAAO,QAAQ,KAAK,QAAQ;YAE5B,OAAO,QAAQ,CAAC;QAElB,OAAO,QAAQ,EAAE,CAAC;IACpB,CAAC;IAED,+EAA+E;IACxE,MAAM,CAAC,gBAAgB,CAC5B,IAAgC;QAEhC,mDAAmD;QACnD,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,4BAA4B,CACxC,YAAoB,EACpB,OAAmB,EACnB,SAAmD;QAEnD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,WAAW,EACX,IAAI,EACJ,YAAY,EACZ,GAAG,aAAa,EACjB,GAAG,SAAS,IAAI,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAgB;YAC5B,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,YAAY;YACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,IAAI,EACF,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,8CAA8C;gBAC5F,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,sBAAsB,CAAC,IAAI,8CAA8C;gBACtG,IAAI;gBACJ,OAAO,CAAC,QAAQ;YAClB,KAAK,EAAE,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC1D,KAAK,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;YACrC,SAAS,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS;YACzC,WAAW,EAAE,WAAW,IAAI,OAAO,CAAC,WAAW;SAChD,CAAC;QAEF,IAAI,OAAO,YAAY,cAAc,IAAI,OAAO,YAAY,WAAW,EAAE,CAAC;YACxE,OAAO;gBACL,GAAG,QAAQ;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE,CAAC;YAC5C,OAAO;gBACL,GAAG,QAAQ;gBACX,YAAY,EAAE,OAAO,CAAC,cAAc;gBACpC,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,YAAY,YAAY,EAAE,CAAC;YAC3C,OAAO;gBACL,GAAG,QAAQ;gBACX,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,KAAK,EAAE,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,KAAK,CAAC;gBACrD,QAAQ,EAAE,KAAK;gBACf,GAAG,aAAa;aACjB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0CAA0C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,8BAA8B,CAC1C,QAAsB,EACtB,oBAAoB,GAAG,EAAE,EACzB,SAAmD;QAEnD,OAAO,yBAAyB,CAC9B,QAAQ,EACR,IAAI,EACJ,oBAAoB,EACpB,SAAS,CACV,CAAC;IACJ,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,UAAU,0BAA0B,CACxC,OAAqC,EACrC,SAAsC;IAEtC,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;IAClC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,SAAS;KACb,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,yBAAyB,CACvC,OAAqB,EACrB,SAAqC;IAErC,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,OAAO;QACL,GAAG,IAAI;QACP,GAAG,SAAS;KACb,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 */\nimport type * as React from \"react\";\nimport type {\n  ActionButton,\n  CustomButtonDefinition,\n  GroupButton,\n  StringGetter,\n} from \"@itwin/appui-abstract\";\nimport { ConditionalStringValue } from \"@itwin/appui-abstract\";\nimport { assert } from \"@itwin/core-bentley\";\nimport type { BadgeKind } from \"@itwin/core-react/internal\";\nimport { IconHelper } from \"@itwin/core-react\";\nimport type { AnyItemDef } from \"../shared/AnyItemDef.js\";\nimport { CommandItemDef } from \"../shared/CommandItemDef.js\";\nimport { CustomItemDef } from \"../shared/CustomItemDef.js\";\nimport { ToolItemDef } from \"../shared/ToolItemDef.js\";\nimport { GroupItemDef } from \"./GroupItem.js\";\nimport type {\n  ToolbarActionItem,\n  ToolbarCustomItem,\n  ToolbarGroupItem,\n  ToolbarItem,\n} from \"./ToolbarItem.js\";\nimport { isToolbarActionItem, isToolbarGroupItem } from \"./ToolbarItem.js\";\nimport type { ToolbarItemUtilities } from \"./ToolbarItemUtilities.js\";\nimport type { CommonToolbarItemWithBadgeKind } from \"@itwin/components-react/internal\";\n\n/* eslint-disable deprecation/deprecation */\n\n/**\n * Common implementation for `constructChildToolbarItems` and `createToolbarItemsFromItemDefs`.\n * @param itemDefs List of itemDefs to convert.\n * @param allowCustom false if we are building children and don't support custom items.\n * @param startingItemPriority defaults to 10.\n * @param overrides Single override to apply to each itemDefs.\n * @returns ToolbarItem[] or (ToolbarActionItem | ToolbarGroupItem) if allowCustom is false.\n */\nfunction constructToolbarItemArray<T extends boolean>(\n  itemDefs: AnyItemDef[],\n  allowCustom: T,\n  startingItemPriority = 10,\n  overrides?: Partial<CommonToolbarItemWithBadgeKind>\n) {\n  let priority = startingItemPriority;\n  const items = [];\n  for (const itemDef of itemDefs) {\n    const item = ToolbarHelper.createToolbarItemFromItemDef(\n      priority,\n      itemDef,\n      overrides\n    );\n    priority = priority + 10;\n    if (allowCustom || isToolbarActionItem(item) || isToolbarGroupItem(item))\n      items.push(item);\n  }\n  return items as T extends true\n    ? Array<ToolbarItem>\n    : Array<ToolbarActionItem | ToolbarGroupItem>;\n}\n\n/** Helper functions for defining a Toolbar items used in `Toolbar`, `ToolbarComposer` and `UiItemsProvider`.\n * @public\n * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n */\nexport class ToolbarHelper {\n  /** Construct ToolbarCustomItem definitions given a CustomItemDef.\n   * @deprecated in 4.15.0. Use `ToolbarItemUtilities.createCustomItem` instead.\n   */\n  public static createCustomDefinitionToolbarItem(\n    itemPriority: number,\n    itemDef: CustomItemDef,\n    overrides?: Partial<CustomButtonDefinition & { badgeKind?: BadgeKind }>\n  ): ToolbarCustomItem {\n    return this.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);\n  }\n\n  /** Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n   */\n  public static constructChildToolbarItems(\n    itemDefs: AnyItemDef[]\n  ): Array<ToolbarActionItem | ToolbarGroupItem> {\n    return constructToolbarItemArray(itemDefs, false);\n  }\n\n  private static getStringOrConditionalString(\n    inString: string | StringGetter | ConditionalStringValue\n  ): string | ConditionalStringValue {\n    if (\n      inString instanceof ConditionalStringValue ||\n      typeof inString === \"string\"\n    )\n      return inString;\n\n    return inString();\n  }\n\n  /** @deprecated in 4.15.0. Use {@link @itwin/core-react#IconHelper} instead. */\n  public static getIconReactNode(\n    item: ActionButton | GroupButton\n  ): React.ReactNode {\n    // eslint-disable-next-line deprecation/deprecation\n    return IconHelper.getIconReactNode(item.icon, item.internalData);\n  }\n\n  /** Helper method to creates a generic toolbar item entry.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n   */\n  public static createToolbarItemFromItemDef(\n    itemPriority: number,\n    itemDef: AnyItemDef,\n    overrides?: Partial<CommonToolbarItemWithBadgeKind>\n  ): ToolbarItem {\n    const {\n      badgeType,\n      badgeKind,\n      description,\n      icon,\n      internalData,\n      ...itemOverrides\n    } = overrides ?? {};\n    const itemBase: ToolbarItem = {\n      id: itemDef.id,\n      itemPriority,\n      isActive: itemDef.isActive,\n      isHidden: itemDef.isHidden,\n      isDisabled: itemDef.isDisabled,\n      icon:\n        internalData?.get(IconHelper.reactIconKey) ?? // eslint-disable-line deprecation/deprecation\n        internalData?.get(IconHelper.conditionalIconItemKey) ?? // eslint-disable-line deprecation/deprecation\n        icon ??\n        itemDef.iconSpec,\n      label: this.getStringOrConditionalString(itemDef.rawLabel),\n      badge: badgeType ?? itemDef.badgeType,\n      badgeKind: badgeKind ?? itemDef.badgeKind,\n      description: description ?? itemDef.description,\n    };\n\n    if (itemDef instanceof CommandItemDef || itemDef instanceof ToolItemDef) {\n      return {\n        ...itemBase,\n        execute: itemDef.execute,\n        ...itemOverrides,\n      };\n    } else if (itemDef instanceof CustomItemDef) {\n      return {\n        ...itemBase,\n        panelContent: itemDef.popupPanelNode,\n        ...itemOverrides,\n      };\n    } else if (itemDef instanceof GroupItemDef) {\n      return {\n        ...itemBase,\n        panelLabel: itemDef.panelLabel,\n        items: this.constructChildToolbarItems(itemDef.items),\n        isActive: false,\n        ...itemOverrides,\n      };\n    } else {\n      throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);\n    }\n  }\n\n  /** Helper method to creates a generic toolbar item entry list.\n   * @deprecated in 4.15.0. Use {@link ToolbarItemUtilities} instead.\n   */\n  public static createToolbarItemsFromItemDefs(\n    itemDefs: AnyItemDef[],\n    startingItemPriority = 10,\n    overrides?: Partial<CommonToolbarItemWithBadgeKind>\n  ): ToolbarItem[] {\n    return constructToolbarItemArray(\n      itemDefs,\n      true,\n      startingItemPriority,\n      overrides\n    );\n  }\n}\n\n/** @internal */\nexport function itemDefToToolbarActionItem(\n  itemDef: ToolItemDef | CommandItemDef,\n  overrides?: Partial<ToolbarActionItem>\n): ToolbarActionItem {\n  const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);\n  assert(isToolbarActionItem(item));\n  return {\n    ...item,\n    ...overrides,\n  };\n}\n\n/** @internal */\nexport function itemDefToToolbarGroupItem(\n  itemDef: GroupItemDef,\n  overrides?: Partial<ToolbarGroupItem>\n): ToolbarGroupItem {\n  const item = ToolbarHelper.createToolbarItemFromItemDef(0, itemDef);\n  assert(isToolbarGroupItem(item));\n  return {\n    ...item,\n    ...overrides,\n  };\n}\n"]}

package/lib/appui-react/toolbar/ToolbarItem.d.ts

@@ -0,0 +1,136 @@
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import type { ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import type { BadgeType, IconSpec } from "@itwin/core-react";
+import type { BadgeKind } from "@itwin/core-react/internal";
+/** Used to specify the usage of the toolbar which determine the toolbar position.
+ * @public
+ */
+export declare enum ToolbarUsage {
+    /** Contains tools to Create Update and Delete content - in AppUI this is in top left of content area. */
+    ContentManipulation = 0,
+    /** Manipulate view/camera - in AppUI this is in top right of content area. */
+    ViewNavigation = 1
+}
+/** Used to specify the orientation of the toolbar.
+ * @public
+ */
+export declare enum ToolbarOrientation {
+    /** Horizontal toolbar. */
+    Horizontal = 0,
+    /** Vertical toolbar. */
+    Vertical = 1
+}
+/** Describes the data needed to insert a UI items into an existing set of UI items.
+ * @public
+ */
+export interface CommonToolbarItem {
+    /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
+    readonly id: string;
+    /** Icon of a toolbar item. */
+    readonly iconNode?: React.ReactNode;
+    /** Describes badge. Renders no badge if not specified.
+     * @deprecated in 4.16.0. Use `badgeKind` property instead.
+     */
+    readonly badge?: BadgeType;
+    /** Specifies the kind of badge, if any, to be rendered. */
+    readonly badgeKind?: BadgeKind;
+    /** Optional description */
+    readonly description?: string | ConditionalStringValue;
+    /** Defines if the item is active (shown with an active stripe/bar). */
+    readonly isActive?: boolean;
+    /** Describes if the item is visible or hidden. The default is for the item to be visible. */
+    readonly isHidden?: boolean | ConditionalBooleanValue;
+    /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
+    readonly isDisabled?: boolean | ConditionalBooleanValue;
+    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
+     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
+     * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.
+     */
+    readonly groupPriority?: number;
+    /** Priority within a toolbar or group. */
+    readonly itemPriority: number;
+    /** Describes layout specific configuration of a toolbar item.
+     * @note Only used by {@link UiItemsProvider.getToolbarItems}.
+     */
+    readonly layouts?: ToolbarItemLayouts;
+}
+/** Describes the data needed to insert an action button into a toolbar.
+ * @public
+ */
+export interface ToolbarActionItem extends CommonToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id.
+     * @deprecated in 4.16.0. Use {@link CommonToolbarItem.iconNode} instead and specify `undefined` for this property. This will be made optional in 5.0.0.
+     */
+    readonly icon: IconSpec;
+    /** label, shown as tool tip on a button or an item label in a group. */
+    readonly label: string | ConditionalStringValue;
+    /** function to run when the button is pressed. */
+    readonly execute: () => void;
+    /** Optional parent tool group to add the tool to. */
+    readonly parentGroupItemId?: string;
+}
+/** Describes the data needed to insert a group button into a toolbar.
+ * @public
+ */
+export interface ToolbarGroupItem extends CommonToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id.
+     * @deprecated in 4.16.0. Use {@link CommonToolbarItem.iconNode} instead.
+     */
+    readonly icon: IconSpec;
+    /** label, shown as tool tip on group button or a group button label in a group panel. */
+    readonly label: string | ConditionalStringValue;
+    /** label shown as the title in at top of group panel. */
+    readonly panelLabel?: string | ConditionalStringValue;
+    /** children of the group */
+    readonly items: ReadonlyArray<ToolbarActionItem | ToolbarGroupItem>;
+    /** Optional parent tool group to add the tool to. */
+    readonly parentGroupItemId?: string;
+}
+/** Describes the data needed to insert a custom button into a toolbar.
+ * @public
+ */
+export interface ToolbarCustomItem extends CommonToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id.
+     * @deprecated in 4.16.0. Use {@link CommonToolbarItem.iconNode} instead.
+     */
+    readonly icon?: IconSpec;
+    /** label, shown as tool tip on group button or a group button label in a group panel. */
+    readonly label?: string | ConditionalStringValue;
+    /** defines the content to display in popup panel */
+    readonly panelContent?: React.ReactNode;
+}
+/** Any Button Type that can be inserted into a toolbar.
+ * @public
+ */
+export type ToolbarItem = ToolbarActionItem | ToolbarGroupItem | ToolbarCustomItem;
+/** ToolbarActionItem type guard.
+ * @public
+ */
+export declare function isToolbarActionItem(item: ToolbarItem): item is ToolbarActionItem;
+/** ToolbarGroupItem type guard.
+ * @public
+ */
+export declare function isToolbarGroupItem(item: ToolbarItem): item is ToolbarGroupItem;
+/** ToolbarCustomItem type guard.
+ * @public
+ */
+export declare function isToolbarCustomItem(item: ToolbarItem): item is ToolbarCustomItem;
+/** Describes toolbar item configuration specific for each layout.
+ * @public
+ */
+export interface ToolbarItemLayouts {
+    /** Toolbar item configuration in a standard layout. */
+    readonly standard?: StandardLayoutToolbarItem;
+}
+/** Describes toolbar item configuration specific to a standard layout.
+ * @public
+ */
+export interface StandardLayoutToolbarItem {
+    /** Describes toolbar usage. */
+    readonly usage: ToolbarUsage;
+    /** Describes toolbar orientation. */
+    readonly orientation: ToolbarOrientation;
+}
+//# sourceMappingURL=ToolbarItem.d.ts.map

package/lib/appui-react/toolbar/ToolbarItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAG5D;;GAEG;AACH,oBAAY,YAAY;IACtB,yGAAyG;IACzG,mBAAmB,IAAI;IACvB,8EAA8E;IAC9E,cAAc,IAAI;CACnB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,UAAU,IAAI;IACd,wBAAwB;IACxB,QAAQ,IAAI;CACb;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC;;OAEG;IAEH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D;;OAEG;IAEH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD;;OAEG;IAEH,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yDAAyD;IACzD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACtD,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,CAAC;IACpE,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D;;OAEG;IAEH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,CAAC;AAEtB;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,iBAAiB,CAE3B;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,gBAAgB,CAE1B;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,WAAW,GAChB,IAAI,IAAI,iBAAiB,CAE3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;CAC1C"}

package/lib/appui-react/toolbar/ToolbarItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAUH;;GAEG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,yGAAyG;IACzG,6EAAuB,CAAA;IACvB,8EAA8E;IAC9E,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAiGD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAiB;IAEjB,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAiB;IAEjB,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAiB;IAEjB,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACjE,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 type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"@itwin/appui-abstract\";\nimport type { BadgeType, IconSpec } from \"@itwin/core-react\";\nimport type { BadgeKind } from \"@itwin/core-react/internal\";\nimport { UiItemsProvider } from \"../ui-items-provider/UiItemsProvider.js\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in AppUI this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in AppUI this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @public\n */\nexport enum ToolbarOrientation {\n  /** Horizontal toolbar. */\n  Horizontal = 0,\n  /** Vertical toolbar. */\n  Vertical = 1,\n}\n\n/** Describes the data needed to insert a UI items into an existing set of UI items.\n * @public\n */\nexport interface CommonToolbarItem {\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** Icon of a toolbar item. */\n  readonly iconNode?: React.ReactNode;\n  /** Describes badge. Renders no badge if not specified.\n   * @deprecated in 4.16.0. Use `badgeKind` property instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly badge?: BadgeType;\n  /** Specifies the kind of badge, if any, to be rendered. */\n  readonly badgeKind?: BadgeKind;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\n  /** Defines if the item is active (shown with an active stripe/bar). */\n  readonly isActive?: boolean;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\n   */\n  readonly groupPriority?: number;\n  /** Priority within a toolbar or group. */\n  readonly itemPriority: number;\n  /** Describes layout specific configuration of a toolbar item.\n   * @note Only used by {@link UiItemsProvider.getToolbarItems}.\n   */\n  readonly layouts?: ToolbarItemLayouts;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ToolbarActionItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id.\n   * @deprecated in 4.16.0. Use {@link CommonToolbarItem.iconNode} instead and specify `undefined` for this property. This will be made optional in 5.0.0.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly icon: IconSpec;\n  /** label, shown as tool tip on a button or an item label in a group. */\n  readonly label: string | ConditionalStringValue;\n  /** function to run when the button is pressed. */\n  readonly execute: () => void;\n  /** Optional parent tool group to add the tool to. */\n  readonly parentGroupItemId?: string;\n}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface ToolbarGroupItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id.\n   * @deprecated in 4.16.0. Use {@link CommonToolbarItem.iconNode} instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly icon: IconSpec;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label: string | ConditionalStringValue;\n  /** label shown as the title in at top of group panel. */\n  readonly panelLabel?: string | ConditionalStringValue;\n  /** children of the group */\n  readonly items: ReadonlyArray<ToolbarActionItem | ToolbarGroupItem>;\n  /** Optional parent tool group to add the tool to. */\n  readonly parentGroupItemId?: string;\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface ToolbarCustomItem extends CommonToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id.\n   * @deprecated in 4.16.0. Use {@link CommonToolbarItem.iconNode} instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  readonly icon?: IconSpec;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** defines the content to display in popup panel */\n  readonly panelContent?: React.ReactNode;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type ToolbarItem =\n  | ToolbarActionItem\n  | ToolbarGroupItem\n  | ToolbarCustomItem;\n\n/** ToolbarActionItem type guard.\n * @public\n */\nexport function isToolbarActionItem(\n  item: ToolbarItem\n): item is ToolbarActionItem {\n  return \"execute\" in item;\n}\n\n/** ToolbarGroupItem type guard.\n * @public\n */\nexport function isToolbarGroupItem(\n  item: ToolbarItem\n): item is ToolbarGroupItem {\n  return \"items\" in item;\n}\n\n/** ToolbarCustomItem type guard.\n * @public\n */\nexport function isToolbarCustomItem(\n  item: ToolbarItem\n): item is ToolbarCustomItem {\n  return !isToolbarActionItem(item) && !isToolbarGroupItem(item);\n}\n\n/** Describes toolbar item configuration specific for each layout.\n * @public\n */\nexport interface ToolbarItemLayouts {\n  /** Toolbar item configuration in a standard layout. */\n  readonly standard?: StandardLayoutToolbarItem;\n}\n\n/** Describes toolbar item configuration specific to a standard layout.\n * @public\n */\nexport interface StandardLayoutToolbarItem {\n  /** Describes toolbar usage. */\n  readonly usage: ToolbarUsage;\n  /** Describes toolbar orientation. */\n  readonly orientation: ToolbarOrientation;\n}\n"]}

package/lib/appui-react/toolbar/ToolbarItemUtilities.d.ts

@@ -0,0 +1,65 @@
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import { type ToolType } from "@itwin/core-frontend";
+import type { ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem } from "./ToolbarItem.js";
+/** Helper namespace to create toolbar items.
+ * @public
+ */
+export declare namespace ToolbarItemUtilities {
+    interface CreateActionItemArgs extends Partial<Omit<ToolbarActionItem, "icon" | "iconNode" | "id">>, Pick<ToolbarActionItem, "id"> {
+        icon?: ToolbarActionItem["iconNode"];
+    }
+    type DeprecatedActionItemArgs = [
+        id: ToolbarActionItem["id"],
+        itemPriority: ToolbarActionItem["itemPriority"],
+        icon: ToolbarActionItem["icon"],
+        label: ToolbarActionItem["label"],
+        execute: ToolbarActionItem["execute"],
+        overrides?: Partial<ToolbarActionItem>
+    ];
+    /** Creates an action item. */
+    export function createActionItem(args: CreateActionItemArgs): ToolbarActionItem;
+    /** Creates an action item.
+     * @deprecated in 4.16.0. Uses a deprecated {@link @itwin/core-react#IconSpec} type. Use an overload instead.
+     */
+    export function createActionItem(...args: DeprecatedActionItemArgs): ToolbarActionItem;
+    interface CreateGroupItemArgs extends Partial<Omit<ToolbarGroupItem, "icon" | "iconNode" | "id">>, Pick<ToolbarGroupItem, "id"> {
+        icon?: ToolbarGroupItem["iconNode"];
+    }
+    type DeprecatedGroupItemArgs = [
+        id: string,
+        itemPriority: number,
+        icon: ToolbarGroupItem["icon"],
+        label: ToolbarGroupItem["label"],
+        items: ToolbarGroupItem["items"],
+        overrides?: Partial<ToolbarGroupItem>
+    ];
+    /** Creates a group item. */
+    export function createGroupItem(args: CreateGroupItemArgs): ToolbarGroupItem;
+    /** Creates a group item.
+     * @deprecated in 4.16.0. Uses a deprecated {@link @itwin/core-react#IconSpec} type. Use an overload instead.
+     */
+    export function createGroupItem(...args: DeprecatedGroupItemArgs): ToolbarGroupItem;
+    interface CreateCustomItemArgs extends Partial<Omit<ToolbarCustomItem, "icon" | "iconNode" | "id">>, Pick<ToolbarCustomItem, "id"> {
+        icon?: ToolbarCustomItem["iconNode"];
+    }
+    type DeprecatedCustomItemArgs = [
+        id: string,
+        itemPriority: number,
+        icon: ToolbarCustomItem["icon"],
+        label: ToolbarCustomItem["label"],
+        panelContent?: ToolbarCustomItem["panelContent"],
+        overrides?: Partial<ToolbarCustomItem>
+    ];
+    /** Creates a custom item. */
+    export function createCustomItem(args: CreateCustomItemArgs): ToolbarCustomItem;
+    /** Creates a custom item.
+     * @deprecated in 4.16.0. Uses a deprecated {@link @itwin/core-react#IconSpec} type. Use an overload instead.
+     */
+    export function createCustomItem(...args: DeprecatedCustomItemArgs): ToolbarCustomItem;
+    /** Creates an action item from the specified tool type. */
+    export function createForTool(toolType: ToolType, overrides?: Partial<ToolbarActionItem>): ToolbarActionItem;
+    export {};
+}
+//# sourceMappingURL=ToolbarItemUtilities.d.ts.map

package/lib/appui-react/toolbar/ToolbarItemUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarItemUtilities.d.ts","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarItemUtilities.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAa,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAG1B;;GAEG;AACH,yBAAiB,oBAAoB,CAAC;IACpC,UAAU,oBACR,SAAQ,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC,EAClE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC;QAC/B,IAAI,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;KACtC;IAED,KAAK,wBAAwB,GAAG;QAC9B,EAAE,EAAE,iBAAiB,CAAC,IAAI,CAAC;QAC3B,YAAY,EAAE,iBAAiB,CAAC,cAAc,CAAC;QAC/C,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC;QAC/B,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC;QACjC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC;QACrC,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;KACvC,CAAC;IAsBF,8BAA8B;IAC9B,MAAM,UAAU,gBAAgB,CAC9B,IAAI,EAAE,oBAAoB,GACzB,iBAAiB,CAAC;IACrB;;OAEG;IACH,MAAM,UAAU,gBAAgB,CAC9B,GAAG,IAAI,EAAE,wBAAwB,GAChC,iBAAiB,CAAC;IAyBrB,UAAU,mBACR,SAAQ,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC,EACjE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC;QAC9B,IAAI,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAC;KACrC;IAED,KAAK,uBAAuB,GAAG;QAC7B,EAAE,EAAE,MAAM;QACV,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;QAC9B,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC;QAChC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC;QAChC,SAAS,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC;KACtC,CAAC;IAsBF,4BAA4B;IAC5B,MAAM,UAAU,eAAe,CAAC,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,CAAC;IAC7E;;OAEG;IACH,MAAM,UAAU,eAAe,CAC7B,GAAG,IAAI,EAAE,uBAAuB,GAC/B,gBAAgB,CAAC;IAyBpB,UAAU,oBACR,SAAQ,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC,EAClE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC;QAC/B,IAAI,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;KACtC;IAED,KAAK,wBAAwB,GAAG;QAC9B,EAAE,EAAE,MAAM;QACV,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC;QAC/B,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC;QACjC,YAAY,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC;QAChD,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;KACvC,CAAC;IAsBF,6BAA6B;IAC7B,MAAM,UAAU,gBAAgB,CAC9B,IAAI,EAAE,oBAAoB,GACzB,iBAAiB,CAAC;IACrB;;OAEG;IACH,MAAM,UAAU,gBAAgB,CAC9B,GAAG,IAAI,EAAE,wBAAwB,GAChC,iBAAiB,CAAC;IAiBrB,2DAA2D;IAC3D,MAAM,UAAU,aAAa,CAC3B,QAAQ,EAAE,QAAQ,EAClB,SAAS,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GACrC,iBAAiB,CAenB;;CACF"}

package/lib/appui-react/toolbar/ToolbarItemUtilities.js

@@ -0,0 +1,104 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { IModelApp } from "@itwin/core-frontend";
+import { isArgsUtil } from "../backstage/BackstageItemUtilities.js";
+/** Helper namespace to create toolbar items.
+ * @public
+ */
+export var ToolbarItemUtilities;
+(function (ToolbarItemUtilities) {
+    function createDeprecatedActionItem(...[id, itemPriority, icon, label, execute, overrides,]) {
+        return {
+            id,
+            itemPriority,
+            icon,
+            label,
+            execute,
+            ...overrides,
+        };
+    }
+    /** Creates an action item. */
+    function createActionItem(...args) {
+        if (isArgsUtil(args)) {
+            const { execute = () => { }, icon, itemPriority = 0, label = "", ...other } = args[0];
+            return {
+                execute,
+                itemPriority,
+                iconNode: icon,
+                icon: icon ? React.createElement(React.Fragment, null, icon) : undefined,
+                label,
+                ...other,
+            };
+        }
+        return createDeprecatedActionItem(...args);
+    }
+    ToolbarItemUtilities.createActionItem = createActionItem;
+    function createDeprecatedGroupItem(...[id, itemPriority, icon, label, items, overrides,]) {
+        return {
+            id,
+            itemPriority,
+            icon,
+            label,
+            items,
+            ...overrides,
+        };
+    }
+    /** Creates a group item. */
+    function createGroupItem(...args) {
+        if (isArgsUtil(args)) {
+            const { icon, itemPriority = 0, items = [], label = "", ...other } = args[0];
+            return {
+                itemPriority,
+                items,
+                iconNode: icon,
+                icon: icon ? React.createElement(React.Fragment, null, icon) : undefined,
+                label,
+                ...other,
+            };
+        }
+        return createDeprecatedGroupItem(...args);
+    }
+    ToolbarItemUtilities.createGroupItem = createGroupItem;
+    function createDeprecatedCustomItem(...[id, itemPriority, icon, label, panelContent, overrides,]) {
+        return {
+            id,
+            itemPriority,
+            icon,
+            label,
+            panelContent,
+            ...overrides,
+        };
+    }
+    /** Creates a custom item. */
+    function createCustomItem(...args) {
+        if (isArgsUtil(args)) {
+            const { icon, itemPriority = 0, ...other } = args[0];
+            return {
+                itemPriority,
+                iconNode: icon,
+                icon: icon ? React.createElement(React.Fragment, null, icon) : undefined,
+                ...other,
+            };
+        }
+        return createDeprecatedCustomItem(...args);
+    }
+    ToolbarItemUtilities.createCustomItem = createCustomItem;
+    /** Creates an action item from the specified tool type. */
+    function createForTool(toolType, overrides) {
+        // eslint-disable-next-line deprecation/deprecation
+        return ToolbarItemUtilities.createActionItem(toolType.toolId, 0, toolType.iconSpec, toolType.flyover, () => {
+            void IModelApp.tools.run(toolType.toolId);
+        }, {
+            description: toolType.description,
+            ...overrides,
+        });
+    }
+    ToolbarItemUtilities.createForTool = createForTool;
+})(ToolbarItemUtilities || (ToolbarItemUtilities = {}));
+//# sourceMappingURL=ToolbarItemUtilities.js.map

package/lib/appui-react/toolbar/ToolbarItemUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToolbarItemUtilities.js","sourceRoot":"","sources":["../../../src/appui-react/toolbar/ToolbarItemUtilities.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAiB,MAAM,sBAAsB,CAAC;AAMhE,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAEpE;;GAEG;AACH,MAAM,KAAW,oBAAoB,CA0NpC;AA1ND,WAAiB,oBAAoB;IAgBnC,SAAS,0BAA0B,CACjC,GAAG,CACD,EAAE,EACF,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,OAAO,EACP,SAAS,EACgB;QAE3B,OAAO;YACL,EAAE;YACF,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,OAAO;YACP,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAYD,8BAA8B;IAC9B,SAAgB,gBAAgB,CAC9B,GAAG,IAAuD;QAE1D,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,MAAM,EACJ,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,EAClB,IAAI,EACJ,YAAY,GAAG,CAAC,EAChB,KAAK,GAAG,EAAE,EACV,GAAG,KAAK,EACT,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACZ,OAAO;gBACL,OAAO;gBACP,YAAY;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,0CAAG,IAAI,CAAI,CAAC,CAAC,CAAC,SAAS;gBACpC,KAAK;gBACL,GAAG,KAAK;aACT,CAAC;QACJ,CAAC;QACD,OAAO,0BAA0B,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IArBe,qCAAgB,mBAqB/B,CAAA;IAiBD,SAAS,yBAAyB,CAChC,GAAG,CACD,EAAE,EACF,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,KAAK,EACL,SAAS,EACe;QAE1B,OAAO;YACL,EAAE;YACF,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,KAAK;YACL,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAUD,4BAA4B;IAC5B,SAAgB,eAAe,CAC7B,GAAG,IAAqD;QAExD,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,MAAM,EACJ,IAAI,EACJ,YAAY,GAAG,CAAC,EAChB,KAAK,GAAG,EAAE,EACV,KAAK,GAAG,EAAE,EACV,GAAG,KAAK,EACT,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACZ,OAAO;gBACL,YAAY;gBACZ,KAAK;gBACL,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,0CAAG,IAAI,CAAI,CAAC,CAAC,CAAC,SAAS;gBACpC,KAAK;gBACL,GAAG,KAAK;aACT,CAAC;QACJ,CAAC;QACD,OAAO,yBAAyB,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;IArBe,oCAAe,kBAqB9B,CAAA;IAiBD,SAAS,0BAA0B,CACjC,GAAG,CACD,EAAE,EACF,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,YAAY,EACZ,SAAS,EACgB;QAE3B,OAAO;YACL,EAAE;YACF,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,YAAY;YACZ,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAYD,6BAA6B;IAC7B,SAAgB,gBAAgB,CAC9B,GAAG,IAAuD;QAE1D,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACrD,OAAO;gBACL,YAAY;gBACZ,QAAQ,EAAE,IAAI;gBACd,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,0CAAG,IAAI,CAAI,CAAC,CAAC,CAAC,SAAS;gBACpC,GAAG,KAAK;aACT,CAAC;QACJ,CAAC;QACD,OAAO,0BAA0B,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;IAbe,qCAAgB,mBAa/B,CAAA;IAED,2DAA2D;IAC3D,SAAgB,aAAa,CAC3B,QAAkB,EAClB,SAAsC;QAEtC,mDAAmD;QACnD,OAAO,oBAAoB,CAAC,gBAAgB,CAC1C,QAAQ,CAAC,MAAM,EACf,CAAC,EACD,QAAQ,CAAC,QAAQ,EACjB,QAAQ,CAAC,OAAO,EAChB,GAAG,EAAE;YACH,KAAK,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC,EACD;YACE,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,GAAG,SAAS;SACb,CACF,CAAC;IACJ,CAAC;IAlBe,kCAAa,gBAkB5B,CAAA;AACH,CAAC,EA1NgB,oBAAoB,KAApB,oBAAoB,QA0NpC","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 { IModelApp, type ToolType } from \"@itwin/core-frontend\";\nimport type {\n  ToolbarActionItem,\n  ToolbarCustomItem,\n  ToolbarGroupItem,\n} from \"./ToolbarItem.js\";\nimport { isArgsUtil } from \"../backstage/BackstageItemUtilities.js\";\n\n/** Helper namespace to create toolbar items.\n * @public\n */\nexport namespace ToolbarItemUtilities {\n  interface CreateActionItemArgs\n    extends Partial<Omit<ToolbarActionItem, \"icon\" | \"iconNode\" | \"id\">>,\n      Pick<ToolbarActionItem, \"id\"> {\n    icon?: ToolbarActionItem[\"iconNode\"];\n  }\n\n  type DeprecatedActionItemArgs = [\n    id: ToolbarActionItem[\"id\"],\n    itemPriority: ToolbarActionItem[\"itemPriority\"],\n    icon: ToolbarActionItem[\"icon\"],\n    label: ToolbarActionItem[\"label\"],\n    execute: ToolbarActionItem[\"execute\"],\n    overrides?: Partial<ToolbarActionItem>\n  ];\n\n  function createDeprecatedActionItem(\n    ...[\n      id,\n      itemPriority,\n      icon,\n      label,\n      execute,\n      overrides,\n    ]: DeprecatedActionItemArgs\n  ): ToolbarActionItem {\n    return {\n      id,\n      itemPriority,\n      icon,\n      label,\n      execute,\n      ...overrides,\n    };\n  }\n\n  /** Creates an action item. */\n  export function createActionItem(\n    args: CreateActionItemArgs\n  ): ToolbarActionItem;\n  /** Creates an action item.\n   * @deprecated in 4.16.0. Uses a deprecated {@link @itwin/core-react#IconSpec} type. Use an overload instead.\n   */\n  export function createActionItem(\n    ...args: DeprecatedActionItemArgs\n  ): ToolbarActionItem;\n  /** Creates an action item. */\n  export function createActionItem(\n    ...args: DeprecatedActionItemArgs | [CreateActionItemArgs]\n  ): ToolbarActionItem {\n    if (isArgsUtil(args)) {\n      const {\n        execute = () => {},\n        icon,\n        itemPriority = 0,\n        label = \"\",\n        ...other\n      } = args[0];\n      return {\n        execute,\n        itemPriority,\n        iconNode: icon,\n        icon: icon ? <>{icon}</> : undefined,\n        label,\n        ...other,\n      };\n    }\n    return createDeprecatedActionItem(...args);\n  }\n\n  interface CreateGroupItemArgs\n    extends Partial<Omit<ToolbarGroupItem, \"icon\" | \"iconNode\" | \"id\">>,\n      Pick<ToolbarGroupItem, \"id\"> {\n    icon?: ToolbarGroupItem[\"iconNode\"];\n  }\n\n  type DeprecatedGroupItemArgs = [\n    id: string,\n    itemPriority: number,\n    icon: ToolbarGroupItem[\"icon\"],\n    label: ToolbarGroupItem[\"label\"],\n    items: ToolbarGroupItem[\"items\"],\n    overrides?: Partial<ToolbarGroupItem>\n  ];\n\n  function createDeprecatedGroupItem(\n    ...[\n      id,\n      itemPriority,\n      icon,\n      label,\n      items,\n      overrides,\n    ]: DeprecatedGroupItemArgs\n  ): ToolbarGroupItem {\n    return {\n      id,\n      itemPriority,\n      icon,\n      label,\n      items,\n      ...overrides,\n    };\n  }\n\n  /** Creates a group item. */\n  export function createGroupItem(args: CreateGroupItemArgs): ToolbarGroupItem;\n  /** Creates a group item.\n   * @deprecated in 4.16.0. Uses a deprecated {@link @itwin/core-react#IconSpec} type. Use an overload instead.\n   */\n  export function createGroupItem(\n    ...args: DeprecatedGroupItemArgs\n  ): ToolbarGroupItem;\n  /** Creates a group item. */\n  export function createGroupItem(\n    ...args: DeprecatedGroupItemArgs | [CreateGroupItemArgs]\n  ): ToolbarGroupItem {\n    if (isArgsUtil(args)) {\n      const {\n        icon,\n        itemPriority = 0,\n        items = [],\n        label = \"\",\n        ...other\n      } = args[0];\n      return {\n        itemPriority,\n        items,\n        iconNode: icon,\n        icon: icon ? <>{icon}</> : undefined,\n        label,\n        ...other,\n      };\n    }\n    return createDeprecatedGroupItem(...args);\n  }\n\n  interface CreateCustomItemArgs\n    extends Partial<Omit<ToolbarCustomItem, \"icon\" | \"iconNode\" | \"id\">>,\n      Pick<ToolbarCustomItem, \"id\"> {\n    icon?: ToolbarCustomItem[\"iconNode\"];\n  }\n\n  type DeprecatedCustomItemArgs = [\n    id: string,\n    itemPriority: number,\n    icon: ToolbarCustomItem[\"icon\"],\n    label: ToolbarCustomItem[\"label\"],\n    panelContent?: ToolbarCustomItem[\"panelContent\"],\n    overrides?: Partial<ToolbarCustomItem>\n  ];\n\n  function createDeprecatedCustomItem(\n    ...[\n      id,\n      itemPriority,\n      icon,\n      label,\n      panelContent,\n      overrides,\n    ]: DeprecatedCustomItemArgs\n  ): ToolbarCustomItem {\n    return {\n      id,\n      itemPriority,\n      icon,\n      label,\n      panelContent,\n      ...overrides,\n    };\n  }\n\n  /** Creates a custom item. */\n  export function createCustomItem(\n    args: CreateCustomItemArgs\n  ): ToolbarCustomItem;\n  /** Creates a custom item.\n   * @deprecated in 4.16.0. Uses a deprecated {@link @itwin/core-react#IconSpec} type. Use an overload instead.\n   */\n  export function createCustomItem(\n    ...args: DeprecatedCustomItemArgs\n  ): ToolbarCustomItem;\n  /** Creates a custom item. */\n  export function createCustomItem(\n    ...args: DeprecatedCustomItemArgs | [CreateCustomItemArgs]\n  ): ToolbarCustomItem {\n    if (isArgsUtil(args)) {\n      const { icon, itemPriority = 0, ...other } = args[0];\n      return {\n        itemPriority,\n        iconNode: icon,\n        icon: icon ? <>{icon}</> : undefined,\n        ...other,\n      };\n    }\n    return createDeprecatedCustomItem(...args);\n  }\n\n  /** Creates an action item from the specified tool type. */\n  export function createForTool(\n    toolType: ToolType,\n    overrides?: Partial<ToolbarActionItem>\n  ): ToolbarActionItem {\n    // eslint-disable-next-line deprecation/deprecation\n    return ToolbarItemUtilities.createActionItem(\n      toolType.toolId,\n      0,\n      toolType.iconSpec,\n      toolType.flyover,\n      () => {\n        void IModelApp.tools.run(toolType.toolId);\n      },\n      {\n        description: toolType.description,\n        ...overrides,\n      }\n    );\n  }\n}\n"]}