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

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

@@ -1,135 +1,125 @@
-import { ConditionalStringValue, ToolbarItemUtilities, } from "@itwin/appui-abstract";
-import { isCustomToolbarItem } from "@itwin/components-react";
-import { IconHelper } from "@itwin/core-react";
-import { CommandItemDef } from "../shared/CommandItemDef";
-import { CustomItemDef } from "../shared/CustomItemDef";
-import { ToolItemDef } from "../shared/ToolItemDef";
-import { GroupItemDef } from "./GroupItem";
-/** Helper functions for defining an ToolbarComposer.
- * @public
- */
-export class ToolbarHelper {
-    /** Construct CustomToolbarItem definitions given a CustomItemDef. */
-    static createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides) {
-        const isHidden = itemDef.isHidden;
-        const isDisabled = itemDef.isDisabled;
-        const internalData = new Map(); // used to store ReactNode if iconSpec hold a ReactNode
-        const icon = IconHelper.getIconData(itemDef.iconSpec, internalData);
-        const label = this.getStringOrConditionalString(itemDef.rawLabel);
-        const badgeType = itemDef.badgeType;
-        // istanbul ignore else
-        return {
-            id: itemDef.id,
-            itemPriority,
-            icon,
-            label,
-            isCustom: true,
-            isHidden,
-            isDisabled,
-            internalData,
-            badgeType,
-            panelContentNode: itemDef.popupPanelNode,
-            ...overrides,
-        };
-    }
-    /** Construct ActionButton and GroupButton definitions given an array to ItemDefs. */
-    static constructChildToolbarItems(itemDefs) {
-        let count = 10;
-        const items = [];
-        for (const itemDef of itemDefs) {
-            const item = this.createToolbarItemFromItemDef(count, itemDef);
-            count = count + 10;
-            // istanbul ignore else
-            if (ToolbarItemUtilities.isActionButton(item) || ToolbarItemUtilities.isGroupButton(item))
-                items.push(item);
-        }
-        return items;
-    }
-    static getStringOrConditionalString(inString) {
-        if (inString instanceof ConditionalStringValue || typeof inString === "string")
-            return inString;
-        return inString();
-    }
-    static getIconReactNode(item) {
-        return IconHelper.getIconReactNode(item.icon, item.internalData);
-    }
-    /** Helper method to creates a generic toolbar item entry */
-    static createToolbarItemFromItemDef(itemPriority, itemDef, overrides) {
-        const isHidden = itemDef.isHidden;
-        const isDisabled = itemDef.isDisabled;
-        const internalData = new Map(); // used to store ReactNode if iconSpec hold a ReactNode
-        const icon = IconHelper.getIconData(itemDef.iconSpec, internalData);
-        const label = this.getStringOrConditionalString(itemDef.rawLabel);
-        const badgeType = itemDef.badgeType;
-        // istanbul ignore else
-        if (itemDef instanceof CommandItemDef) {
-            return {
-                id: itemDef.id,
-                itemPriority,
-                icon,
-                label,
-                isHidden,
-                isDisabled,
-                isActive: itemDef.isActive,
-                execute: itemDef.execute,
-                badgeType,
-                internalData,
-                ...overrides,
-            };
-        }
-        else if (itemDef instanceof CustomItemDef) {
-            return ToolbarHelper.createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides);
-        }
-        else if (itemDef instanceof GroupItemDef) {
-            const children = this.constructChildToolbarItems(itemDef.items);
-            return {
-                id: itemDef.id,
-                itemPriority,
-                icon,
-                label,
-                panelLabel: itemDef.panelLabel,
-                isHidden,
-                isDisabled,
-                items: children,
-                isActive: false,
-                badgeType,
-                internalData,
-                ...overrides,
-            };
-        }
-        else if (itemDef instanceof ToolItemDef) {
-            return {
-                id: itemDef.id,
-                itemPriority,
-                icon,
-                label,
-                isHidden,
-                isDisabled,
-                isActive: itemDef.isActive,
-                execute: itemDef.execute,
-                badgeType,
-                internalData,
-                ...overrides,
-            };
-        }
-        else {
-            throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);
-        }
-    }
-    static createToolbarItemsFromItemDefs(itemDefs, startingItemPriority = 10, overrides) {
-        let itemPriority = startingItemPriority;
-        const items = itemDefs.map((itemDef) => {
-            const item = ToolbarHelper.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);
-            itemPriority = itemPriority + 10;
-            return item;
-        });
-        return items;
-    }
-}
-/** CustomToolbarButton type guard.
- * @internal
- */
-ToolbarHelper.isCustomToolbarButton = (item) => {
-    return isCustomToolbarItem(item);
-};
+import { ConditionalStringValue, } from "@itwin/appui-abstract";
+import { IconHelper } from "@itwin/core-react";
+import { CommandItemDef } from "../shared/CommandItemDef";
+import { CustomItemDef } from "../shared/CustomItemDef";
+import { ToolItemDef } from "../shared/ToolItemDef";
+import { GroupItemDef } from "./GroupItem";
+import { isToolbarActionItem, isToolbarGroupItem } from "./ToolbarItem";
+/** Helper functions for defining an ToolbarComposer.
+ * @public
+ */
+export class ToolbarHelper {
+    /** Construct CustomToolbarItem definitions given a CustomItemDef. */
+    static createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides) {
+        const isHidden = itemDef.isHidden;
+        const isDisabled = itemDef.isDisabled;
+        const internalData = new Map(); // used to store ReactNode if iconSpec hold a ReactNode
+        const icon = IconHelper.getIconData(itemDef.iconSpec, internalData);
+        const label = this.getStringOrConditionalString(itemDef.rawLabel);
+        const badgeType = itemDef.badgeType;
+        // istanbul ignore else
+        return {
+            id: itemDef.id,
+            itemPriority,
+            icon,
+            label,
+            isCustom: true,
+            isHidden,
+            isDisabled,
+            internalData,
+            badgeType,
+            panelContent: itemDef.popupPanelNode,
+            ...overrides,
+        };
+    }
+    /** Construct ActionButton and GroupButton definitions given an array to ItemDefs. */
+    static constructChildToolbarItems(itemDefs) {
+        let count = 10;
+        const items = [];
+        for (const itemDef of itemDefs) {
+            const item = this.createToolbarItemFromItemDef(count, itemDef);
+            count = count + 10;
+            // istanbul ignore else
+            if (isToolbarActionItem(item) || isToolbarGroupItem(item))
+                items.push(item);
+        }
+        return items;
+    }
+    static getStringOrConditionalString(inString) {
+        if (inString instanceof ConditionalStringValue || typeof inString === "string")
+            return inString;
+        return inString();
+    }
+    static getIconReactNode(item) {
+        return IconHelper.getIconReactNode(item.icon, item.internalData);
+    }
+    /** Helper method to creates a generic toolbar item entry */
+    static createToolbarItemFromItemDef(itemPriority, itemDef, overrides) {
+        const isHidden = itemDef.isHidden;
+        const isDisabled = itemDef.isDisabled;
+        const icon = itemDef.iconSpec;
+        const label = this.getStringOrConditionalString(itemDef.rawLabel);
+        const badge = itemDef.badgeType;
+        // istanbul ignore else
+        if (itemDef instanceof CommandItemDef) {
+            return {
+                id: itemDef.id,
+                itemPriority,
+                icon,
+                label,
+                isHidden,
+                isDisabled,
+                isActive: itemDef.isActive,
+                execute: itemDef.execute,
+                badge,
+                ...overrides,
+            };
+        }
+        else if (itemDef instanceof CustomItemDef) {
+            return ToolbarHelper.createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides);
+        }
+        else if (itemDef instanceof GroupItemDef) {
+            const children = this.constructChildToolbarItems(itemDef.items);
+            return {
+                id: itemDef.id,
+                itemPriority,
+                icon,
+                label,
+                panelLabel: itemDef.panelLabel,
+                isHidden,
+                isDisabled,
+                items: children,
+                isActive: false,
+                badge,
+                ...overrides,
+            };
+        }
+        else if (itemDef instanceof ToolItemDef) {
+            return {
+                id: itemDef.id,
+                itemPriority,
+                icon,
+                label,
+                isHidden,
+                isDisabled,
+                isActive: itemDef.isActive,
+                execute: itemDef.execute,
+                badge,
+                ...overrides,
+            };
+        }
+        else {
+            throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);
+        }
+    }
+    static createToolbarItemsFromItemDefs(itemDefs, startingItemPriority = 10, overrides) {
+        let itemPriority = startingItemPriority;
+        const items = itemDefs.map((itemDef) => {
+            const item = ToolbarHelper.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);
+            itemPriority = itemPriority + 10;
+            return item;
+        });
+        return items;
+    }
+}
 //# sourceMappingURL=ToolbarHelper.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ToolbarHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAQA,OAAO,EAC4B,sBAAsB,EAAkE,oBAAoB,GAC9I,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAqB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,aAAa;IACxB,qEAAqE;IAC9D,MAAM,CAAC,iCAAiC,CAAC,YAAoB,EAAE,OAAsB,EAAE,SAA2C;QACvI,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC,CAAE,uDAAuD;QACrG,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEpC,uBAAuB;QACvB,OAAO;YACL,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,UAAU;YACV,YAAY;YACZ,SAAS;YACT,gBAAgB,EAAE,OAAO,CAAC,cAAc;YACxC,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,0BAA0B,CAAC,QAAsB;QAC7D,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,MAAM,KAAK,GAAsC,EAAE,CAAC;QACpD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC/D,KAAK,GAAG,KAAK,GAAG,EAAE,CAAC;YACnB,uBAAuB;YACvB,IAAI,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,aAAa,CAAC,IAAI,CAAC;gBACvF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACpB;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,4BAA4B,CAAC,QAAwD;QAClG,IAAI,QAAQ,YAAY,sBAAsB,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC5E,OAAO,QAAQ,CAAC;QAElB,OAAO,QAAQ,EAAE,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,IAAgC;QAC7D,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC;IAED,4DAA4D;IACrD,MAAM,CAAC,4BAA4B,CAAC,YAAoB,EAAE,OAAmB,EAAE,SAAgC;QACpH,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC,CAAE,uDAAuD;QACrG,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEpC,uBAAuB;QACvB,IAAI,OAAO,YAAY,cAAc,EAAE;YACrC,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,YAAY;gBACZ,IAAI;gBACJ,KAAK;gBACL,QAAQ;gBACR,UAAU;gBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,SAAS;gBACT,YAAY;gBACZ,GAAG,SAAS;aACb,CAAC;SACH;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE;YAC3C,OAAO,aAAa,CAAC,iCAAiC,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;SAC1F;aAAM,IAAI,OAAO,YAAY,YAAY,EAAE;YAC1C,MAAM,QAAQ,GAAsC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACnG,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,YAAY;gBACZ,IAAI;gBACJ,KAAK;gBACL,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,QAAQ;gBACR,UAAU;gBACV,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,KAAK;gBACf,SAAS;gBACT,YAAY;gBACZ,GAAG,SAAS;aACb,CAAC;SACH;aAAM,IAAI,OAAO,YAAY,WAAW,EAAE;YACzC,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,YAAY;gBACZ,IAAI;gBACJ,KAAK;gBACL,QAAQ;gBACR,UAAU;gBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,SAAS;gBACT,YAAY;gBACZ,GAAG,SAAS;aACb,CAAC;SACH;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,0CAA0C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;SACzE;IACH,CAAC;IAEM,MAAM,CAAC,8BAA8B,CAAC,QAAsB,EAAE,oBAAoB,GAAG,EAAE,EAAE,SAAgC;QAC9H,IAAI,YAAY,GAAG,oBAAoB,CAAC;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAmB,EAAE,EAAE;YACjD,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;YAC1F,YAAY,GAAG,YAAY,GAAG,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;;AAED;;GAEG;AACW,mCAAqB,GAAG,CAAC,IAAuB,EAA6B,EAAE;IAC3F,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n */\r\nimport * as React from \"react\";\r\nimport {\r\n  ActionButton, CommonToolbarItem, ConditionalStringValue, CustomButtonDefinition, GroupButton, StringGetter, ToolbarItem, ToolbarItemUtilities,\r\n} from \"@itwin/appui-abstract\";\r\nimport { CustomToolbarItem, isCustomToolbarItem } from \"@itwin/components-react\";\r\nimport { IconHelper } from \"@itwin/core-react\";\r\nimport { AnyItemDef } from \"../shared/AnyItemDef\";\r\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\r\nimport { CustomItemDef } from \"../shared/CustomItemDef\";\r\nimport { ToolItemDef } from \"../shared/ToolItemDef\";\r\nimport { GroupItemDef } from \"./GroupItem\";\r\n\r\n/** Helper functions for defining an ToolbarComposer.\r\n * @public\r\n */\r\nexport class ToolbarHelper {\r\n  /** Construct CustomToolbarItem definitions given a CustomItemDef. */\r\n  public static createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition>): CustomToolbarItem {\r\n    const isHidden = itemDef.isHidden;\r\n    const isDisabled = itemDef.isDisabled;\r\n    const internalData = new Map<string, any>();  // used to store ReactNode if iconSpec hold a ReactNode\r\n    const icon = IconHelper.getIconData(itemDef.iconSpec, internalData);\r\n    const label = this.getStringOrConditionalString(itemDef.rawLabel);\r\n    const badgeType = itemDef.badgeType;\r\n\r\n    // istanbul ignore else\r\n    return {\r\n      id: itemDef.id,\r\n      itemPriority,\r\n      icon,\r\n      label,\r\n      isCustom: true,\r\n      isHidden,\r\n      isDisabled,\r\n      internalData,\r\n      badgeType,\r\n      panelContentNode: itemDef.popupPanelNode,\r\n      ...overrides,\r\n    };\r\n  }\r\n\r\n  /** Construct ActionButton and GroupButton definitions given an array to ItemDefs. */\r\n  public static constructChildToolbarItems(itemDefs: AnyItemDef[]): Array<ActionButton | GroupButton> {\r\n    let count = 10;\r\n    const items: Array<ActionButton | GroupButton> = [];\r\n    for (const itemDef of itemDefs) {\r\n      const item = this.createToolbarItemFromItemDef(count, itemDef);\r\n      count = count + 10;\r\n      // istanbul ignore else\r\n      if (ToolbarItemUtilities.isActionButton(item) || ToolbarItemUtilities.isGroupButton(item))\r\n        items.push(item);\r\n    }\r\n    return items;\r\n  }\r\n\r\n  private static getStringOrConditionalString(inString: string | StringGetter | ConditionalStringValue): string | ConditionalStringValue {\r\n    if (inString instanceof ConditionalStringValue || typeof inString === \"string\")\r\n      return inString;\r\n\r\n    return inString();\r\n  }\r\n\r\n  public static getIconReactNode(item: ActionButton | GroupButton): React.ReactNode {\r\n    return IconHelper.getIconReactNode(item.icon, item.internalData);\r\n  }\r\n\r\n  /** Helper method to creates a generic toolbar item entry */\r\n  public static createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<ToolbarItem>): CommonToolbarItem {\r\n    const isHidden = itemDef.isHidden;\r\n    const isDisabled = itemDef.isDisabled;\r\n    const internalData = new Map<string, any>();  // used to store ReactNode if iconSpec hold a ReactNode\r\n    const icon = IconHelper.getIconData(itemDef.iconSpec, internalData);\r\n    const label = this.getStringOrConditionalString(itemDef.rawLabel);\r\n    const badgeType = itemDef.badgeType;\r\n\r\n    // istanbul ignore else\r\n    if (itemDef instanceof CommandItemDef) {\r\n      return {\r\n        id: itemDef.id,\r\n        itemPriority,\r\n        icon,\r\n        label,\r\n        isHidden,\r\n        isDisabled,\r\n        isActive: itemDef.isActive,\r\n        execute: itemDef.execute,\r\n        badgeType,\r\n        internalData,\r\n        ...overrides,\r\n      };\r\n    } else if (itemDef instanceof CustomItemDef) {\r\n      return ToolbarHelper.createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides);\r\n    } else if (itemDef instanceof GroupItemDef) {\r\n      const children: Array<ActionButton | GroupButton> = this.constructChildToolbarItems(itemDef.items);\r\n      return {\r\n        id: itemDef.id,\r\n        itemPriority,\r\n        icon,\r\n        label,\r\n        panelLabel: itemDef.panelLabel,\r\n        isHidden,\r\n        isDisabled,\r\n        items: children,\r\n        isActive: false,\r\n        badgeType,\r\n        internalData,\r\n        ...overrides,\r\n      };\r\n    } else if (itemDef instanceof ToolItemDef) {\r\n      return {\r\n        id: itemDef.id,\r\n        itemPriority,\r\n        icon,\r\n        label,\r\n        isHidden,\r\n        isDisabled,\r\n        isActive: itemDef.isActive,\r\n        execute: itemDef.execute,\r\n        badgeType,\r\n        internalData,\r\n        ...overrides,\r\n      };\r\n    } else {\r\n      throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);\r\n    }\r\n  }\r\n\r\n  public static createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority = 10, overrides?: Partial<ToolbarItem>): CommonToolbarItem[] {\r\n    let itemPriority = startingItemPriority;\r\n    const items = itemDefs.map((itemDef: AnyItemDef) => {\r\n      const item = ToolbarHelper.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);\r\n      itemPriority = itemPriority + 10;\r\n      return item;\r\n    });\r\n    return items;\r\n  }\r\n\r\n  /** CustomToolbarButton type guard.\r\n   * @internal\r\n   */\r\n  public static isCustomToolbarButton = (item: CommonToolbarItem): item is CustomToolbarItem => {\r\n    return isCustomToolbarItem(item);\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"ToolbarHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarHelper.tsx"],"names":[],"mappings":"AAQA,OAAO,EAC4B,sBAAsB,GACxD,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAuE,MAAM,eAAe,CAAC;AAE7I;;GAEG;AACH,MAAM,OAAO,aAAa;IACxB,qEAAqE;IAC9D,MAAM,CAAC,iCAAiC,CAAC,YAAoB,EAAE,OAAsB,EAAE,SAA2C;QACvI,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC,CAAE,uDAAuD;QACrG,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEpC,uBAAuB;QACvB,OAAO;YACL,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,YAAY;YACZ,IAAI;YACJ,KAAK;YACL,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,UAAU;YACV,YAAY;YACZ,SAAS;YACT,YAAY,EAAE,OAAO,CAAC,cAAc;YACpC,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,0BAA0B,CAAC,QAAsB;QAC7D,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,MAAM,KAAK,GAAgD,EAAE,CAAC;QAC9D,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC/D,KAAK,GAAG,KAAK,GAAG,EAAE,CAAC;YACnB,uBAAuB;YACvB,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC;gBACvD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACpB;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,4BAA4B,CAAC,QAAwD;QAClG,IAAI,QAAQ,YAAY,sBAAsB,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC5E,OAAO,QAAQ,CAAC;QAElB,OAAO,QAAQ,EAAE,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,IAAgC;QAC7D,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC;IAED,4DAA4D;IACrD,MAAM,CAAC,4BAA4B,CAAC,YAAoB,EAAE,OAAmB,EAAE,SAAsC;QAC1H,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC;QAEhC,uBAAuB;QACvB,IAAI,OAAO,YAAY,cAAc,EAAE;YACrC,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,YAAY;gBACZ,IAAI;gBACJ,KAAK;gBACL,QAAQ;gBACR,UAAU;gBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,KAAK;gBACL,GAAG,SAAS;aACb,CAAC;SACH;aAAM,IAAI,OAAO,YAAY,aAAa,EAAE;YAC3C,OAAO,aAAa,CAAC,iCAAiC,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;SAC1F;aAAM,IAAI,OAAO,YAAY,YAAY,EAAE;YAC1C,MAAM,QAAQ,GAAgD,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7G,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,YAAY;gBACZ,IAAI;gBACJ,KAAK;gBACL,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,QAAQ;gBACR,UAAU;gBACV,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,KAAK;gBACf,KAAK;gBACL,GAAG,SAAS;aACb,CAAC;SACH;aAAM,IAAI,OAAO,YAAY,WAAW,EAAE;YACzC,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,YAAY;gBACZ,IAAI;gBACJ,KAAK;gBACL,QAAQ;gBACR,UAAU;gBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,KAAK;gBACL,GAAG,SAAS;aACb,CAAC;SACH;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,0CAA0C,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;SACzE;IACH,CAAC;IAEM,MAAM,CAAC,8BAA8B,CAAC,QAAsB,EAAE,oBAAoB,GAAG,EAAE,EAAE,SAAsC;QACpI,IAAI,YAAY,GAAG,oBAAoB,CAAC;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAmB,EAAE,EAAE;YACjD,MAAM,IAAI,GAAG,aAAa,CAAC,4BAA4B,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;YAC1F,YAAY,GAAG,YAAY,GAAG,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n */\r\nimport * as React from \"react\";\r\nimport {\r\n  ActionButton, CommonToolbarItem, ConditionalStringValue, CustomButtonDefinition, GroupButton, StringGetter,\r\n} from \"@itwin/appui-abstract\";\r\nimport { IconHelper } from \"@itwin/core-react\";\r\nimport { AnyItemDef } from \"../shared/AnyItemDef\";\r\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\r\nimport { CustomItemDef } from \"../shared/CustomItemDef\";\r\nimport { ToolItemDef } from \"../shared/ToolItemDef\";\r\nimport { GroupItemDef } from \"./GroupItem\";\r\nimport { isToolbarActionItem, isToolbarGroupItem, ToolbarActionItem, ToolbarCustomItem, ToolbarGroupItem, ToolbarItem } from \"./ToolbarItem\";\r\n\r\n/** Helper functions for defining an ToolbarComposer.\r\n * @public\r\n */\r\nexport class ToolbarHelper {\r\n  /** Construct CustomToolbarItem definitions given a CustomItemDef. */\r\n  public static createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition>): ToolbarCustomItem {\r\n    const isHidden = itemDef.isHidden;\r\n    const isDisabled = itemDef.isDisabled;\r\n    const internalData = new Map<string, any>();  // used to store ReactNode if iconSpec hold a ReactNode\r\n    const icon = IconHelper.getIconData(itemDef.iconSpec, internalData);\r\n    const label = this.getStringOrConditionalString(itemDef.rawLabel);\r\n    const badgeType = itemDef.badgeType;\r\n\r\n    // istanbul ignore else\r\n    return {\r\n      id: itemDef.id,\r\n      itemPriority,\r\n      icon,\r\n      label,\r\n      isCustom: true,\r\n      isHidden,\r\n      isDisabled,\r\n      internalData,\r\n      badgeType,\r\n      panelContent: itemDef.popupPanelNode,\r\n      ...overrides,\r\n    };\r\n  }\r\n\r\n  /** Construct ActionButton and GroupButton definitions given an array to ItemDefs. */\r\n  public static constructChildToolbarItems(itemDefs: AnyItemDef[]): Array<ToolbarActionItem | ToolbarGroupItem> {\r\n    let count = 10;\r\n    const items: Array<ToolbarActionItem | ToolbarGroupItem> = [];\r\n    for (const itemDef of itemDefs) {\r\n      const item = this.createToolbarItemFromItemDef(count, itemDef);\r\n      count = count + 10;\r\n      // istanbul ignore else\r\n      if (isToolbarActionItem(item) || isToolbarGroupItem(item))\r\n        items.push(item);\r\n    }\r\n    return items;\r\n  }\r\n\r\n  private static getStringOrConditionalString(inString: string | StringGetter | ConditionalStringValue): string | ConditionalStringValue {\r\n    if (inString instanceof ConditionalStringValue || typeof inString === \"string\")\r\n      return inString;\r\n\r\n    return inString();\r\n  }\r\n\r\n  public static getIconReactNode(item: ActionButton | GroupButton): React.ReactNode {\r\n    return IconHelper.getIconReactNode(item.icon, item.internalData);\r\n  }\r\n\r\n  /** Helper method to creates a generic toolbar item entry */\r\n  public static createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<CommonToolbarItem>): ToolbarItem {\r\n    const isHidden = itemDef.isHidden;\r\n    const isDisabled = itemDef.isDisabled;\r\n    const icon = itemDef.iconSpec;\r\n    const label = this.getStringOrConditionalString(itemDef.rawLabel);\r\n    const badge = itemDef.badgeType;\r\n\r\n    // istanbul ignore else\r\n    if (itemDef instanceof CommandItemDef) {\r\n      return {\r\n        id: itemDef.id,\r\n        itemPriority,\r\n        icon,\r\n        label,\r\n        isHidden,\r\n        isDisabled,\r\n        isActive: itemDef.isActive,\r\n        execute: itemDef.execute,\r\n        badge,\r\n        ...overrides,\r\n      };\r\n    } else if (itemDef instanceof CustomItemDef) {\r\n      return ToolbarHelper.createCustomDefinitionToolbarItem(itemPriority, itemDef, overrides);\r\n    } else if (itemDef instanceof GroupItemDef) {\r\n      const children: Array<ToolbarActionItem | ToolbarGroupItem> = this.constructChildToolbarItems(itemDef.items);\r\n      return {\r\n        id: itemDef.id,\r\n        itemPriority,\r\n        icon,\r\n        label,\r\n        panelLabel: itemDef.panelLabel,\r\n        isHidden,\r\n        isDisabled,\r\n        items: children,\r\n        isActive: false,\r\n        badge,\r\n        ...overrides,\r\n      };\r\n    } else if (itemDef instanceof ToolItemDef) {\r\n      return {\r\n        id: itemDef.id,\r\n        itemPriority,\r\n        icon,\r\n        label,\r\n        isHidden,\r\n        isDisabled,\r\n        isActive: itemDef.isActive,\r\n        execute: itemDef.execute,\r\n        badge,\r\n        ...overrides,\r\n      };\r\n    } else {\r\n      throw new Error(`Invalid Item type encountered, item id=${itemDef.id}`);\r\n    }\r\n  }\r\n\r\n  public static createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority = 10, overrides?: Partial<CommonToolbarItem>): ToolbarItem[] {\r\n    let itemPriority = startingItemPriority;\r\n    const items = itemDefs.map((itemDef: AnyItemDef) => {\r\n      const item = ToolbarHelper.createToolbarItemFromItemDef(itemPriority, itemDef, overrides);\r\n      itemPriority = itemPriority + 10;\r\n      return item;\r\n    });\r\n    return items;\r\n  }\r\n}\r\n"]}

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

@@ -1,53 +1,104 @@
-/** @packageDocumentation
- * @module Toolbar
- */
-import { ActionButton, CustomButtonDefinition, GroupButton, CommonToolbarItem as UIA_CommonToolbarItem, ToolbarItem as UIA_ToolbarItem, ToolbarOrientation as UIA_ToolbarOrientation, ToolbarUsage as UIA_ToolbarUsage } from "@itwin/appui-abstract";
-/** Used to specify the usage of the toolbar which determine the toolbar position.
- * @public // TODO: 4.x cleanup
- */
-export declare type ToolbarUsage = UIA_ToolbarUsage;
-/** Used to specify the usage of the toolbar which determine the toolbar position.
- * @public // TODO: 4.x cleanup
- */
-export declare const ToolbarUsage: typeof UIA_ToolbarUsage;
-/** Used to specify the orientation of the toolbar.
- * @public // TODO: 4.x cleanup
- */
-export declare type ToolbarOrientation = UIA_ToolbarOrientation;
-/** Used to specify the orientation of the toolbar.
- * @public // TODO: 4.x cleanup
- */
-export declare const ToolbarOrientation: typeof UIA_ToolbarOrientation;
-/** Describes the data needed to insert a UI items into an existing set of UI items.
- * @beta
- */
-export declare type CommonToolbarItem = UIA_ToolbarItem;
-/** Describes the data needed to insert an action button into a toolbar.
- * @beta
- */
-export declare type ToolbarActionItem = ActionButton;
-/** Describes the data needed to insert a group button into a toolbar.
- * @beta
- */
-export declare type ToolbarGroupItem = GroupButton;
-/** Describes the data needed to insert a custom button into a toolbar.
- * @beta
- */
-export declare type ToolbarCustomItem = CustomButtonDefinition;
-/** Any Button Type that can be inserted into a toolbar.
- * @beta
- */
-export declare type ToolbarItem = UIA_CommonToolbarItem;
-/** ToolbarActionItem type guard.
- * @beta
- */
-export declare function isToolbarActionItem(item: ToolbarItem): item is ToolbarActionItem;
-/** ToolbarGroupItem type guard.
- * @beta
- */
-export declare function isToolbarGroupItem(item: ToolbarItem): item is ToolbarGroupItem;
-/** ToolbarCustomItem type guard.
- * @beta
- */
-export declare function isToolbarCustomItem(item: ToolbarItem): item is ToolbarCustomItem;
+/** @packageDocumentation
+ * @module Toolbar
+ */
+/// <reference types="react" />
+import { BadgeType, ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import { IconSpec } from "@itwin/core-react";
+/** 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 ninezone this is in top left of content area. */
+    ContentManipulation = 0,
+    /** Manipulate view/camera - in ninezone 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;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badge?: BadgeType;
+    /** 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 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. */
+    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. */
+    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. */
+    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;
 //# sourceMappingURL=ToolbarItem.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,WAAW,EACX,iBAAiB,IAAI,qBAAqB,EAC1C,WAAW,IAAI,eAAe,EAE9B,kBAAkB,IAAI,sBAAsB,EAC5C,YAAY,IAAI,gBAAgB,EACjC,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,oBAAY,YAAY,GAAG,gBAAgB,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,YAAY,yBAAmB,CAAC;AAE7C;;GAEG;AACH,oBAAY,kBAAkB,GAAG,sBAAsB,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,kBAAkB,+BAAyB,CAAC;AAEzD;;GAEG;AACH,oBAAY,iBAAiB,GAAG,eAAe,CAAC;AAEhD;;GAEG;AACH,oBAAY,iBAAiB,GAAG,YAAY,CAAC;AAE7C;;GAEG;AACH,oBAAY,gBAAgB,GAAG,WAAW,CAAC;AAE3C;;GAEG;AACH,oBAAY,iBAAiB,GAAG,sBAAsB,CAAC;AAEvD;;GAEG;AACH,oBAAY,WAAW,GAAG,qBAAqB,CAAC;AAEhD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,iBAAiB,CAEhF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,gBAAgB,CAE9E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,iBAAiB,CAEhF"}
+{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;GAEG;AACH,oBAAY,YAAY;IACtB,4GAA4G;IAC5G,mBAAmB,IAAI;IACvB,iFAAiF;IACjF,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,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B,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;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,sHAAsH;IACtH,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,qHAAqH;IACrH,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,qHAAqH;IACrH,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,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAEnF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,iBAAiB,CAEhF;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,gBAAgB,CAE9E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,IAAI,iBAAiB,CAEhF"}

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

@@ -1,35 +1,46 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { ToolbarItemUtilities as UIA_ToolbarItemUtilities, ToolbarOrientation as UIA_ToolbarOrientation, ToolbarUsage as UIA_ToolbarUsage, } from "@itwin/appui-abstract";
-/** Used to specify the usage of the toolbar which determine the toolbar position.
- * @public // TODO: 4.x cleanup
- */
-export const ToolbarUsage = UIA_ToolbarUsage; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation
-/** Used to specify the orientation of the toolbar.
- * @public // TODO: 4.x cleanup
- */
-export const ToolbarOrientation = UIA_ToolbarOrientation; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation
-/** ToolbarActionItem type guard.
- * @beta
- */
-export function isToolbarActionItem(item) {
-    return UIA_ToolbarItemUtilities.isActionButton(item);
-}
-/** ToolbarGroupItem type guard.
- * @beta
- */
-export function isToolbarGroupItem(item) {
-    return UIA_ToolbarItemUtilities.isGroupButton(item);
-}
-/** ToolbarCustomItem type guard.
- * @beta
- */
-export function isToolbarCustomItem(item) {
-    return UIA_ToolbarItemUtilities.isCustomDefinition(item);
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Used to specify the usage of the toolbar which determine the toolbar position.
+ * @public
+ */
+export var ToolbarUsage;
+(function (ToolbarUsage) {
+    /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */
+    ToolbarUsage[ToolbarUsage["ContentManipulation"] = 0] = "ContentManipulation";
+    /** Manipulate view/camera - in ninezone this is in top right of content area. */
+    ToolbarUsage[ToolbarUsage["ViewNavigation"] = 1] = "ViewNavigation";
+})(ToolbarUsage || (ToolbarUsage = {}));
+/** Used to specify the orientation of the toolbar.
+ * @public
+ */
+export var ToolbarOrientation;
+(function (ToolbarOrientation) {
+    /** Horizontal toolbar. */
+    ToolbarOrientation[ToolbarOrientation["Horizontal"] = 0] = "Horizontal";
+    /** Vertical toolbar. */
+    ToolbarOrientation[ToolbarOrientation["Vertical"] = 1] = "Vertical";
+})(ToolbarOrientation || (ToolbarOrientation = {}));
+/** ToolbarActionItem type guard.
+ * @public
+ */
+export function isToolbarActionItem(item) {
+    return "execute" in item;
+}
+/** ToolbarGroupItem type guard.
+ * @public
+ */
+export function isToolbarGroupItem(item) {
+    return "items" in item;
+}
+/** ToolbarCustomItem type guard.
+ * @public
+ */
+export function isToolbarCustomItem(item) {
+    return !isToolbarActionItem(item) && !isToolbarGroupItem(item);
+}
 //# sourceMappingURL=ToolbarItem.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAML,oBAAoB,IAAI,wBAAwB,EAChD,kBAAkB,IAAI,sBAAsB,EAC5C,YAAY,IAAI,gBAAgB,GACjC,MAAM,uBAAuB,CAAC;AAO/B;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC,CAAC,+EAA+E;AAO7H;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,CAAC,+EAA+E;AA2BzI;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiB;IACnD,OAAO,wBAAwB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAiB;IAClD,OAAO,wBAAwB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiB;IACnD,OAAO,wBAAwB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n */\r\n\r\nimport {\r\n  ActionButton,\r\n  CustomButtonDefinition,\r\n  GroupButton,\r\n  CommonToolbarItem as UIA_CommonToolbarItem,\r\n  ToolbarItem as UIA_ToolbarItem,\r\n  ToolbarItemUtilities as UIA_ToolbarItemUtilities,\r\n  ToolbarOrientation as UIA_ToolbarOrientation,\r\n  ToolbarUsage as UIA_ToolbarUsage,\r\n} from \"@itwin/appui-abstract\";\r\n\r\n/** Used to specify the usage of the toolbar which determine the toolbar position.\r\n * @public // TODO: 4.x cleanup\r\n */\r\nexport type ToolbarUsage = UIA_ToolbarUsage; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Used to specify the usage of the toolbar which determine the toolbar position.\r\n * @public // TODO: 4.x cleanup\r\n */\r\nexport const ToolbarUsage = UIA_ToolbarUsage; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation\r\n\r\n/** Used to specify the orientation of the toolbar.\r\n * @public // TODO: 4.x cleanup\r\n */\r\nexport type ToolbarOrientation = UIA_ToolbarOrientation; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Used to specify the orientation of the toolbar.\r\n * @public // TODO: 4.x cleanup\r\n */\r\nexport const ToolbarOrientation = UIA_ToolbarOrientation; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation\r\n\r\n/** Describes the data needed to insert a UI items into an existing set of UI items.\r\n * @beta\r\n */\r\nexport type CommonToolbarItem = UIA_ToolbarItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert an action button into a toolbar.\r\n * @beta\r\n */\r\nexport type ToolbarActionItem = ActionButton;\r\n\r\n/** Describes the data needed to insert a group button into a toolbar.\r\n * @beta\r\n */\r\nexport type ToolbarGroupItem = GroupButton;\r\n\r\n/** Describes the data needed to insert a custom button into a toolbar.\r\n * @beta\r\n */\r\nexport type ToolbarCustomItem = CustomButtonDefinition;\r\n\r\n/** Any Button Type that can be inserted into a toolbar.\r\n * @beta\r\n */\r\nexport type ToolbarItem = UIA_CommonToolbarItem;\r\n\r\n/** ToolbarActionItem type guard.\r\n * @beta\r\n */\r\nexport function isToolbarActionItem(item: ToolbarItem): item is ToolbarActionItem {\r\n  return UIA_ToolbarItemUtilities.isActionButton(item);\r\n}\r\n\r\n/** ToolbarGroupItem type guard.\r\n * @beta\r\n */\r\nexport function isToolbarGroupItem(item: ToolbarItem): item is ToolbarGroupItem {\r\n  return UIA_ToolbarItemUtilities.isGroupButton(item);\r\n}\r\n\r\n/** ToolbarCustomItem type guard.\r\n * @beta\r\n */\r\nexport function isToolbarCustomItem(item: ToolbarItem): item is ToolbarCustomItem {\r\n  return UIA_ToolbarItemUtilities.isCustomDefinition(item);\r\n}\r\n"]}
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;GAEG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,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;AA0ED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiB;IACnD,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAiB;IAClD,OAAO,OAAO,IAAI,IAAI,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiB;IACnD,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n */\r\n\r\nimport { BadgeType, ConditionalBooleanValue, ConditionalStringValue } from \"@itwin/appui-abstract\";\r\nimport { IconSpec } from \"@itwin/core-react\";\r\n\r\n/** Used to specify the usage of the toolbar which determine the toolbar position.\r\n * @public\r\n */\r\nexport enum ToolbarUsage {\r\n  /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */\r\n  ContentManipulation = 0,\r\n  /** Manipulate view/camera - in ninezone this is in top right of content area. */\r\n  ViewNavigation = 1,\r\n}\r\n\r\n/** Used to specify the orientation of the toolbar.\r\n * @public\r\n */\r\nexport enum ToolbarOrientation {\r\n  /** Horizontal toolbar. */\r\n  Horizontal = 0,\r\n  /** Vertical toolbar. */\r\n  Vertical = 1,\r\n}\r\n\r\n/** Describes the data needed to insert a UI items into an existing set of UI items.\r\n * @public\r\n */\r\nexport interface CommonToolbarItem {\r\n  /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badge?: BadgeType;\r\n  /** Optional description */\r\n  readonly description?: string | ConditionalStringValue;\r\n  /** Defines if the item is active (shown with an active stripe/bar). */\r\n  readonly isActive?: boolean;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n   * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\r\n   */\r\n  readonly groupPriority?: number;\r\n  /** Priority within a toolbar or group. */\r\n  readonly itemPriority: number;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into a toolbar.\r\n * @public\r\n */\r\nexport interface ToolbarActionItem extends CommonToolbarItem {\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\r\n  readonly icon: IconSpec;\r\n  /** label, shown as tool tip on a button or an item label in a group. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** function to run when the button is pressed. */\r\n  readonly execute: () => void;\r\n  /** Optional parent tool group to add the tool to. */\r\n  readonly parentGroupItemId?: string;\r\n}\r\n\r\n/** Describes the data needed to insert a group button into a toolbar.\r\n * @public\r\n */\r\nexport interface ToolbarGroupItem extends CommonToolbarItem {\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon: IconSpec;\r\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** label shown as the title in at top of group panel. */\r\n  readonly panelLabel?: string | ConditionalStringValue;\r\n  /** children of the group */\r\n  readonly items: ReadonlyArray<ToolbarActionItem | ToolbarGroupItem>;\r\n  /** Optional parent tool group to add the tool to. */\r\n  readonly parentGroupItemId?: string;\r\n}\r\n\r\n/** Describes the data needed to insert a custom button into a toolbar.\r\n * @public\r\n */\r\nexport interface ToolbarCustomItem extends CommonToolbarItem {\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon?: IconSpec;\r\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** defines the content to display in popup panel */\r\n  readonly panelContent?: React.ReactNode;\r\n}\r\n\r\n/** Any Button Type that can be inserted into a toolbar.\r\n * @public\r\n */\r\nexport type ToolbarItem = ToolbarActionItem | ToolbarGroupItem | ToolbarCustomItem;\r\n\r\n/** ToolbarActionItem type guard.\r\n * @public\r\n */\r\nexport function isToolbarActionItem(item: ToolbarItem): item is ToolbarActionItem {\r\n  return \"execute\" in item;\r\n}\r\n\r\n/** ToolbarGroupItem type guard.\r\n * @public\r\n */\r\nexport function isToolbarGroupItem(item: ToolbarItem): item is ToolbarGroupItem {\r\n  return \"items\" in item;\r\n}\r\n\r\n/** ToolbarCustomItem type guard.\r\n * @public\r\n */\r\nexport function isToolbarCustomItem(item: ToolbarItem): item is ToolbarCustomItem {\r\n  return !isToolbarActionItem(item) && !isToolbarGroupItem(item);\r\n}\r\n"]}