@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

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

@@ -1,222 +1,222 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Toolbar
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolbarComposer = void 0;
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const components_react_1 = require("@itwin/components-react");
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_react_1 = require("@itwin/core-react");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
-const UiFramework_1 = require("../UiFramework");
-const DragInteraction_1 = require("./DragInteraction");
-const useDefaultToolbarItems_1 = require("./useDefaultToolbarItems");
-const useUiItemsProviderToolbarItems_1 = require("./useUiItemsProviderToolbarItems");
-const ToolbarItem_1 = require("./ToolbarItem");
-const ToolbarItemsManager_1 = require("./ToolbarItemsManager");
-const toUIAToolbarItem_1 = require("./toUIAToolbarItem");
-/** Private function to set up sync event monitoring of toolbar items */
-function useToolbarItemSyncEffect(uiDataProvider, syncIdsOfInterest) {
-    React.useEffect(() => {
-        return SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
-            if (0 === syncIdsOfInterest.length)
-                return;
-            // istanbul ignore else
-            if (syncIdsOfInterest.some((value) => args.eventIds.has(value.toLowerCase()))) {
-                // process each item that has interest
-                uiDataProvider.refreshAffectedItems(args.eventIds);
-            }
-        });
-    }, [uiDataProvider, syncIdsOfInterest, uiDataProvider.items]);
-    React.useEffect(() => {
-        return UiFramework_1.UiFramework.frontstages.onToolActivatedEvent.addListener(({ toolId }) => {
-            uiDataProvider.setActiveToolId(toolId);
-        });
-    }, [uiDataProvider, uiDataProvider.items]);
-}
-function nestedAddItemToSpecifiedParentGroup(items, groupChildren) {
-    const outItems = [];
-    for (const toolbarItem of items) {
-        if (!(0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem)) {
-            outItems.push(toolbarItem);
-            continue;
-        }
-        const newChildren = nestedAddItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
-        const foundIndices = [];
-        groupChildren.forEach((entry, index) => {
-            if (entry.parentGroupItemId === toolbarItem.id) {
-                foundIndices.push(index);
-            }
-        });
-        // istanbul ignore else
-        if (foundIndices.length) {
-            // process in reverse order so groupChildren can be reduced as we find matches
-            foundIndices.sort(
-            // istanbul ignore next
-            (a, b) => a - b).reverse().forEach((foundIndex) => {
-                newChildren.push(groupChildren[foundIndex]);
-                groupChildren.splice(foundIndex);
-            });
-        }
-        outItems.push({ ...toolbarItem, items: newChildren });
-    }
-    return outItems;
-}
-function addItemToSpecifiedParentGroup(items, groupChildren) {
-    const outItems = [];
-    for (const toolbarItem of items) {
-        if (!(0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem)) {
-            outItems.push(toolbarItem);
-            continue;
-        }
-        const newChildren = nestedAddItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
-        const foundIndices = [];
-        groupChildren.forEach((entry, index) => {
-            if (entry.parentGroupItemId === toolbarItem.id) {
-                foundIndices.push(index);
-            }
-        });
-        // istanbul ignore else
-        if (foundIndices.length) {
-            // process in reverse order so groupChildren can be reduced as we find matches
-            foundIndices.sort(
-            // istanbul ignore next
-            (a, b) => a - b).reverse().forEach((foundIndex) => {
-                newChildren.push(groupChildren[foundIndex]);
-                groupChildren.splice(foundIndex);
-            });
-        }
-        outItems.push({ ...toolbarItem, items: newChildren });
-    }
-    return outItems;
-}
-function cloneGroup(inGroup) {
-    const childItems = [];
-    inGroup.items.forEach((item) => {
-        if ((0, ToolbarItem_1.isToolbarGroupItem)(item))
-            childItems.push(cloneGroup(item));
-        else
-            childItems.push(item);
-    });
-    const clonedGroup = { ...inGroup, items: childItems };
-    return clonedGroup;
-}
-function getItemSortValue(item) {
-    const groupValue = undefined === item.groupPriority ? 0 : /* istanbul ignore next */ item.groupPriority;
-    return groupValue * 10000 + item.itemPriority;
-}
-function getSortedChildren(group) {
-    const sortedChildren = group.items
-        .filter((item) => !(appui_abstract_1.ConditionalBooleanValue.getValue(item.isHidden)))
-        .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))
-        .map((i) => {
-        if ((0, ToolbarItem_1.isToolbarGroupItem)(i)) {
-            return { ...i, items: getSortedChildren(i) };
-        }
-        return i;
-    });
-    return sortedChildren;
-}
-/** local function to combine items from Stage and from Extensions */
-function combineItems(defaultItems, addonItems) {
-    let items = [];
-    const groupChildren = [];
-    // istanbul ignore else
-    if (defaultItems.length) {
-        defaultItems.forEach((srcItem) => {
-            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
-                // if the default item is a group that an addon may insert into copy it so we don't mess with original
-                const toolbarItem = (0, ToolbarItem_1.isToolbarGroupItem)(srcItem) ? cloneGroup(srcItem) : srcItem;
-                if (((0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem) || (0, ToolbarItem_1.isToolbarActionItem)(toolbarItem)) && toolbarItem.parentGroupItemId)
-                    groupChildren.push(toolbarItem);
-                else
-                    items.push(toolbarItem);
-            }
-        });
-    }
-    // istanbul ignore else
-    if (addonItems.length) {
-        addonItems.forEach((srcItem) => {
-            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
-                // if the default item is a group that an addon may insert into copy it so we don't mess with original
-                const toolbarItem = (0, ToolbarItem_1.isToolbarGroupItem)(srcItem) ? cloneGroup(srcItem) : srcItem;
-                if (((0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem) || (0, ToolbarItem_1.isToolbarActionItem)(toolbarItem)) && toolbarItem.parentGroupItemId)
-                    groupChildren.push(toolbarItem);
-                else
-                    items.push(toolbarItem);
-            }
-        });
-    }
-    // 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.
-    if (groupChildren.length) {
-        items = addItemToSpecifiedParentGroup(items, groupChildren);
-        if (groupChildren.length) {
-            groupChildren.forEach((toolbarItem) => {
-                core_bentley_1.Logger.logWarning("ToolbarComposer", `Requested Parent Group [${toolbarItem.parentGroupItemId}] not found, so item [${toolbarItem.id}] is added directly to toolbar.`);
-                items.push(toolbarItem);
-            });
-        }
-    }
-    const availableItems = items
-        .filter((item) => !(appui_abstract_1.ConditionalBooleanValue.getValue(item.isHidden)))
-        .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))
-        .map((i) => {
-        if ((0, ToolbarItem_1.isToolbarGroupItem)(i)) {
-            return { ...i, items: getSortedChildren(i) };
-        }
-        return i;
-    });
-    return availableItems;
-}
-const useProximityOpacitySetting = () => {
-    const [proximityOpacity, setProximityOpacity] = React.useState(UiFramework_1.UiFramework.visibility.useProximityOpacity);
-    React.useEffect(() => {
-        // istanbul ignore next
-        const handleUiVisibilityChanged = () => {
-            setProximityOpacity(UiFramework_1.UiFramework.visibility.useProximityOpacity);
-        };
-        UiFramework_1.UiFramework.onUiVisibilityChanged.addListener(handleUiVisibilityChanged);
-        return () => {
-            UiFramework_1.UiFramework.onUiVisibilityChanged.removeListener(handleUiVisibilityChanged);
-        };
-    }, []);
-    return proximityOpacity;
-};
-/**
- * Toolbar that is populated and maintained by item managers.
- * @public
- */
-function ToolbarComposer(props) {
-    const { usage, orientation } = props;
-    const [defaultItemsManager, setDefaultItemsManager] = React.useState(() => new ToolbarItemsManager_1.ToolbarItemsManager(props.items));
-    React.useEffect(() => {
-        setDefaultItemsManager(new ToolbarItemsManager_1.ToolbarItemsManager(props.items));
-    }, [props.items]); // eslint-disable-line react-hooks/exhaustive-deps
-    // process default items
-    const defaultItems = (0, useDefaultToolbarItems_1.useDefaultToolbarItems)(defaultItemsManager);
-    const syncIdsOfInterest = React.useMemo(() => ToolbarItemsManager_1.ToolbarItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);
-    useToolbarItemSyncEffect(defaultItemsManager, syncIdsOfInterest);
-    // process items from addon UI providers
-    const [addonItemsManager] = React.useState(() => new ToolbarItemsManager_1.ToolbarItemsManager());
-    const addonItems = (0, useUiItemsProviderToolbarItems_1.useUiItemsProviderToolbarItems)(addonItemsManager, usage, orientation);
-    const addonSyncIdsOfInterest = React.useMemo(() => ToolbarItemsManager_1.ToolbarItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);
-    useToolbarItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);
-    const toolbarItems = React.useMemo(() => {
-        const items = combineItems(defaultItems, addonItems);
-        return items.map((item) => (0, toUIAToolbarItem_1.toUIAToolbarItem)(item));
-    }, [defaultItems, addonItems]);
-    const toolbarOrientation = orientation === ToolbarItem_1.ToolbarOrientation.Horizontal ? core_react_1.Orientation.Horizontal : core_react_1.Orientation.Vertical;
-    const expandsTo = toolbarOrientation === core_react_1.Orientation.Horizontal ? components_react_1.Direction.Bottom : usage === ToolbarItem_1.ToolbarUsage.ViewNavigation ? components_react_1.Direction.Left : components_react_1.Direction.Right;
-    const panelAlignment = (toolbarOrientation === core_react_1.Orientation.Horizontal && usage === ToolbarItem_1.ToolbarUsage.ViewNavigation) ? components_react_1.ToolbarPanelAlignment.End : components_react_1.ToolbarPanelAlignment.Start;
-    const isDragEnabled = React.useContext(DragInteraction_1.ToolbarDragInteractionContext);
-    const useProximityOpacity = useProximityOpacitySetting();
-    return React.createElement(components_react_1.ToolbarWithOverflow, { expandsTo: expandsTo, panelAlignment: panelAlignment, items: toolbarItems, useDragInteraction: isDragEnabled, toolbarOpacitySetting: useProximityOpacity && !UiFramework_1.UiFramework.isMobile() ? components_react_1.ToolbarOpacitySetting.Proximity : /* istanbul ignore next */ components_react_1.ToolbarOpacitySetting.Defaults });
-}
-exports.ToolbarComposer = ToolbarComposer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Toolbar
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolbarComposer = void 0;
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const components_react_1 = require("@itwin/components-react");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_react_1 = require("@itwin/core-react");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const UiFramework_1 = require("../UiFramework");
+const DragInteraction_1 = require("./DragInteraction");
+const useDefaultToolbarItems_1 = require("./useDefaultToolbarItems");
+const useUiItemsProviderToolbarItems_1 = require("./useUiItemsProviderToolbarItems");
+const ToolbarItem_1 = require("./ToolbarItem");
+const ToolbarItemsManager_1 = require("./ToolbarItemsManager");
+const toUIAToolbarItem_1 = require("./toUIAToolbarItem");
+/** Private function to set up sync event monitoring of toolbar items */
+function useToolbarItemSyncEffect(uiDataProvider, syncIdsOfInterest) {
+    React.useEffect(() => {
+        return SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
+            if (0 === syncIdsOfInterest.length)
+                return;
+            // istanbul ignore else
+            if (syncIdsOfInterest.some((value) => args.eventIds.has(value.toLowerCase()))) {
+                // process each item that has interest
+                uiDataProvider.refreshAffectedItems(args.eventIds);
+            }
+        });
+    }, [uiDataProvider, syncIdsOfInterest, uiDataProvider.items]);
+    React.useEffect(() => {
+        return UiFramework_1.UiFramework.frontstages.onToolActivatedEvent.addListener(({ toolId }) => {
+            uiDataProvider.setActiveToolId(toolId);
+        });
+    }, [uiDataProvider, uiDataProvider.items]);
+}
+function nestedAddItemToSpecifiedParentGroup(items, groupChildren) {
+    const outItems = [];
+    for (const toolbarItem of items) {
+        if (!(0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem)) {
+            outItems.push(toolbarItem);
+            continue;
+        }
+        const newChildren = nestedAddItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
+        const foundIndices = [];
+        groupChildren.forEach((entry, index) => {
+            if (entry.parentGroupItemId === toolbarItem.id) {
+                foundIndices.push(index);
+            }
+        });
+        // istanbul ignore else
+        if (foundIndices.length) {
+            // process in reverse order so groupChildren can be reduced as we find matches
+            foundIndices.sort(
+            // istanbul ignore next
+            (a, b) => a - b).reverse().forEach((foundIndex) => {
+                newChildren.push(groupChildren[foundIndex]);
+                groupChildren.splice(foundIndex);
+            });
+        }
+        outItems.push({ ...toolbarItem, items: newChildren });
+    }
+    return outItems;
+}
+function addItemToSpecifiedParentGroup(items, groupChildren) {
+    const outItems = [];
+    for (const toolbarItem of items) {
+        if (!(0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem)) {
+            outItems.push(toolbarItem);
+            continue;
+        }
+        const newChildren = nestedAddItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
+        const foundIndices = [];
+        groupChildren.forEach((entry, index) => {
+            if (entry.parentGroupItemId === toolbarItem.id) {
+                foundIndices.push(index);
+            }
+        });
+        // istanbul ignore else
+        if (foundIndices.length) {
+            // process in reverse order so groupChildren can be reduced as we find matches
+            foundIndices.sort(
+            // istanbul ignore next
+            (a, b) => a - b).reverse().forEach((foundIndex) => {
+                newChildren.push(groupChildren[foundIndex]);
+                groupChildren.splice(foundIndex);
+            });
+        }
+        outItems.push({ ...toolbarItem, items: newChildren });
+    }
+    return outItems;
+}
+function cloneGroup(inGroup) {
+    const childItems = [];
+    inGroup.items.forEach((item) => {
+        if ((0, ToolbarItem_1.isToolbarGroupItem)(item))
+            childItems.push(cloneGroup(item));
+        else
+            childItems.push(item);
+    });
+    const clonedGroup = { ...inGroup, items: childItems };
+    return clonedGroup;
+}
+function getItemSortValue(item) {
+    const groupValue = undefined === item.groupPriority ? 0 : /* istanbul ignore next */ item.groupPriority;
+    return groupValue * 10000 + item.itemPriority;
+}
+function getSortedChildren(group) {
+    const sortedChildren = group.items
+        .filter((item) => !(appui_abstract_1.ConditionalBooleanValue.getValue(item.isHidden)))
+        .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))
+        .map((i) => {
+        if ((0, ToolbarItem_1.isToolbarGroupItem)(i)) {
+            return { ...i, items: getSortedChildren(i) };
+        }
+        return i;
+    });
+    return sortedChildren;
+}
+/** local function to combine items from Stage and from Extensions */
+function combineItems(defaultItems, addonItems) {
+    let items = [];
+    const groupChildren = [];
+    // istanbul ignore else
+    if (defaultItems.length) {
+        defaultItems.forEach((srcItem) => {
+            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
+                // if the default item is a group that an addon may insert into copy it so we don't mess with original
+                const toolbarItem = (0, ToolbarItem_1.isToolbarGroupItem)(srcItem) ? cloneGroup(srcItem) : srcItem;
+                if (((0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem) || (0, ToolbarItem_1.isToolbarActionItem)(toolbarItem)) && toolbarItem.parentGroupItemId)
+                    groupChildren.push(toolbarItem);
+                else
+                    items.push(toolbarItem);
+            }
+        });
+    }
+    // istanbul ignore else
+    if (addonItems.length) {
+        addonItems.forEach((srcItem) => {
+            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
+                // if the default item is a group that an addon may insert into copy it so we don't mess with original
+                const toolbarItem = (0, ToolbarItem_1.isToolbarGroupItem)(srcItem) ? cloneGroup(srcItem) : srcItem;
+                if (((0, ToolbarItem_1.isToolbarGroupItem)(toolbarItem) || (0, ToolbarItem_1.isToolbarActionItem)(toolbarItem)) && toolbarItem.parentGroupItemId)
+                    groupChildren.push(toolbarItem);
+                else
+                    items.push(toolbarItem);
+            }
+        });
+    }
+    // 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.
+    if (groupChildren.length) {
+        items = addItemToSpecifiedParentGroup(items, groupChildren);
+        if (groupChildren.length) {
+            groupChildren.forEach((toolbarItem) => {
+                core_bentley_1.Logger.logWarning("ToolbarComposer", `Requested Parent Group [${toolbarItem.parentGroupItemId}] not found, so item [${toolbarItem.id}] is added directly to toolbar.`);
+                items.push(toolbarItem);
+            });
+        }
+    }
+    const availableItems = items
+        .filter((item) => !(appui_abstract_1.ConditionalBooleanValue.getValue(item.isHidden)))
+        .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))
+        .map((i) => {
+        if ((0, ToolbarItem_1.isToolbarGroupItem)(i)) {
+            return { ...i, items: getSortedChildren(i) };
+        }
+        return i;
+    });
+    return availableItems;
+}
+const useProximityOpacitySetting = () => {
+    const [proximityOpacity, setProximityOpacity] = React.useState(UiFramework_1.UiFramework.visibility.useProximityOpacity);
+    React.useEffect(() => {
+        // istanbul ignore next
+        const handleUiVisibilityChanged = () => {
+            setProximityOpacity(UiFramework_1.UiFramework.visibility.useProximityOpacity);
+        };
+        UiFramework_1.UiFramework.onUiVisibilityChanged.addListener(handleUiVisibilityChanged);
+        return () => {
+            UiFramework_1.UiFramework.onUiVisibilityChanged.removeListener(handleUiVisibilityChanged);
+        };
+    }, []);
+    return proximityOpacity;
+};
+/**
+ * Toolbar that is populated and maintained by item managers.
+ * @public
+ */
+function ToolbarComposer(props) {
+    const { usage, orientation } = props;
+    const [defaultItemsManager, setDefaultItemsManager] = React.useState(() => new ToolbarItemsManager_1.ToolbarItemsManager(props.items));
+    React.useEffect(() => {
+        setDefaultItemsManager(new ToolbarItemsManager_1.ToolbarItemsManager(props.items));
+    }, [props.items]); // eslint-disable-line react-hooks/exhaustive-deps
+    // process default items
+    const defaultItems = (0, useDefaultToolbarItems_1.useDefaultToolbarItems)(defaultItemsManager);
+    const syncIdsOfInterest = React.useMemo(() => ToolbarItemsManager_1.ToolbarItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);
+    useToolbarItemSyncEffect(defaultItemsManager, syncIdsOfInterest);
+    // process items from addon UI providers
+    const [addonItemsManager] = React.useState(() => new ToolbarItemsManager_1.ToolbarItemsManager());
+    const addonItems = (0, useUiItemsProviderToolbarItems_1.useUiItemsProviderToolbarItems)(addonItemsManager, usage, orientation);
+    const addonSyncIdsOfInterest = React.useMemo(() => ToolbarItemsManager_1.ToolbarItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);
+    useToolbarItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);
+    const toolbarItems = React.useMemo(() => {
+        const items = combineItems(defaultItems, addonItems);
+        return items.map((item) => (0, toUIAToolbarItem_1.toUIAToolbarItem)(item));
+    }, [defaultItems, addonItems]);
+    const toolbarOrientation = orientation === ToolbarItem_1.ToolbarOrientation.Horizontal ? core_react_1.Orientation.Horizontal : core_react_1.Orientation.Vertical;
+    const expandsTo = toolbarOrientation === core_react_1.Orientation.Horizontal ? components_react_1.Direction.Bottom : usage === ToolbarItem_1.ToolbarUsage.ViewNavigation ? components_react_1.Direction.Left : components_react_1.Direction.Right;
+    const panelAlignment = (toolbarOrientation === core_react_1.Orientation.Horizontal && usage === ToolbarItem_1.ToolbarUsage.ViewNavigation) ? components_react_1.ToolbarPanelAlignment.End : components_react_1.ToolbarPanelAlignment.Start;
+    const isDragEnabled = React.useContext(DragInteraction_1.ToolbarDragInteractionContext);
+    const useProximityOpacity = useProximityOpacitySetting();
+    return React.createElement(components_react_1.ToolbarWithOverflow, { expandsTo: expandsTo, panelAlignment: panelAlignment, items: toolbarItems, useDragInteraction: isDragEnabled, toolbarOpacitySetting: useProximityOpacity && !UiFramework_1.UiFramework.isMobile() ? components_react_1.ToolbarOpacitySetting.Proximity : /* istanbul ignore next */ components_react_1.ToolbarOpacitySetting.Defaults });
+}
+exports.ToolbarComposer = ToolbarComposer;
 //# sourceMappingURL=ToolbarComposer.js.map

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

@@ -1,23 +1,23 @@
-/** @packageDocumentation
- * @module Toolbar
- */
-import * as React from "react";
-import { ActionButton, CommonToolbarItem, CustomButtonDefinition, GroupButton } from "@itwin/appui-abstract";
-import { AnyItemDef } from "../shared/AnyItemDef";
-import { CustomItemDef } from "../shared/CustomItemDef";
-import { ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem, ToolbarItem } from "./ToolbarItem";
-/** Helper functions for defining an ToolbarComposer.
- * @public
- */
-export declare class ToolbarHelper {
-    /** Construct CustomToolbarItem definitions given a CustomItemDef. */
-    static createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition>): ToolbarCustomItem;
-    /** Construct ActionButton and GroupButton definitions given an array to ItemDefs. */
-    static constructChildToolbarItems(itemDefs: AnyItemDef[]): Array<ToolbarActionItem | ToolbarGroupItem>;
-    private static getStringOrConditionalString;
-    static getIconReactNode(item: ActionButton | GroupButton): React.ReactNode;
-    /** Helper method to creates a generic toolbar item entry */
-    static createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<CommonToolbarItem>): ToolbarItem;
-    static createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority?: number, overrides?: Partial<CommonToolbarItem>): ToolbarItem[];
-}
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import * as React from "react";
+import { ActionButton, CommonToolbarItem, CustomButtonDefinition, GroupButton } from "@itwin/appui-abstract";
+import { AnyItemDef } from "../shared/AnyItemDef";
+import { CustomItemDef } from "../shared/CustomItemDef";
+import { ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem, ToolbarItem } from "./ToolbarItem";
+/** Helper functions for defining an ToolbarComposer.
+ * @public
+ */
+export declare class ToolbarHelper {
+    /** Construct CustomToolbarItem definitions given a CustomItemDef. */
+    static createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition>): ToolbarCustomItem;
+    /** Construct ActionButton and GroupButton definitions given an array to ItemDefs. */
+    static constructChildToolbarItems(itemDefs: AnyItemDef[]): Array<ToolbarActionItem | ToolbarGroupItem>;
+    private static getStringOrConditionalString;
+    static getIconReactNode(item: ActionButton | GroupButton): React.ReactNode;
+    /** Helper method to creates a generic toolbar item entry */
+    static createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<CommonToolbarItem>): ToolbarItem;
+    static createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority?: number, overrides?: Partial<CommonToolbarItem>): ToolbarItem[];
+}
 //# sourceMappingURL=ToolbarHelper.d.ts.map