@itwin/appui-abstract 4.0.0-dev.48 → 4.0.0-dev.51

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts

@@ -1,122 +1,122 @@
-/** @packageDocumentation
- * @module Toolbar
- */
-import { BadgeType } from "../items/BadgeType";
-import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
-import { ConditionalStringValue } from "../items/ConditionalStringValue";
-import { ProvidedItem } from "../items/ProvidedItem";
-/** Used to specify the usage of the toolbar which determine the toolbar position.
- * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
- * @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.
- * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
- * @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 ToolbarItem extends ProvidedItem {
-    /** can be used by application to store miscellaneous data. */
-    readonly applicationData?: any;
-    /** Describes badge. Renders no badge if not specified. */
-    readonly badgeType?: BadgeType;
-    /** Optional description */
-    readonly description?: string | ConditionalStringValue;
-    /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
-    readonly id: string;
-    /** optional data to used by item implementor. */
-    readonly internalData?: Map<string, any>;
-    /** 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;
-    /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars
-     * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars
-     * the icon is usually changed to denote the state of a toggle.
-     */
-    readonly isPressed?: boolean;
-    /** 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;
-    /** Optional parent tool group to add tool. */
-    readonly parentToolGroupId?: string;
-}
-/** Describes the data needed to insert an action button into a toolbar.
- * @public
- */
-export interface ActionButton extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
-    readonly icon: string | ConditionalStringValue;
-    /** 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;
-}
-/** Describes the data needed to insert a group button into a toolbar.
- * @public
- */
-export interface GroupButton extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
-    readonly icon: string | ConditionalStringValue;
-    /** 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<ActionButton | GroupButton>;
-}
-/** Describes the data needed to insert a custom button into a toolbar.
- * @public
- */
-export interface CustomButtonDefinition extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
-    readonly icon?: string | ConditionalStringValue;
-    /** label, shown as tool tip on group button or a group button label in a group panel. */
-    readonly label?: string | ConditionalStringValue;
-    /** parameter that marks data as being a custom definition. */
-    readonly isCustom: true;
-}
-/** Any Button Type that can be inserted into a toolbar.
- * @public
- */
-export declare type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
-/** Type for Toolbar Item Id
- * @deprecated in 3.6. Please use `ToolbarItem["id"]` from @itwin/appui-react.
- * @public
- */
-export declare type ToolbarItemId = CommonToolbarItem["id"];
-/** Helper class to create Abstract StatusBar Item definitions.
- * @public
- */
-export declare class ToolbarItemUtilities {
-    /** Creates an Action Button */
-    static createActionButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton> | undefined) => ActionButton;
-    /** Creates a Group button. */
-    static createGroupButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton> | undefined) => GroupButton;
-    /** ActionButton type guard. */
-    static isActionButton(item: CommonToolbarItem): item is ActionButton;
-    /** GroupButton type guard. */
-    static isGroupButton(item: CommonToolbarItem): item is GroupButton;
-    /** CustomButtonDefinition type guard. */
-    static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition;
-}
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import { BadgeType } from "../items/BadgeType";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+import { ProvidedItem } from "../items/ProvidedItem";
+/** Used to specify the usage of the toolbar which determine the toolbar position.
+ * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
+ * @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.
+ * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
+ * @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 ToolbarItem extends ProvidedItem {
+    /** can be used by application to store miscellaneous data. */
+    readonly applicationData?: any;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badgeType?: BadgeType;
+    /** Optional description */
+    readonly description?: string | ConditionalStringValue;
+    /** Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
+    readonly id: string;
+    /** optional data to used by item implementor. */
+    readonly internalData?: Map<string, any>;
+    /** 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;
+    /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars
+     * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars
+     * the icon is usually changed to denote the state of a toggle.
+     */
+    readonly isPressed?: boolean;
+    /** 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;
+    /** Optional parent tool group to add tool. */
+    readonly parentToolGroupId?: string;
+}
+/** Describes the data needed to insert an action button into a toolbar.
+ * @public
+ */
+export interface ActionButton extends ToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
+    readonly icon: string | ConditionalStringValue;
+    /** 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;
+}
+/** Describes the data needed to insert a group button into a toolbar.
+ * @public
+ */
+export interface GroupButton extends ToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon: string | ConditionalStringValue;
+    /** 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<ActionButton | GroupButton>;
+}
+/** Describes the data needed to insert a custom button into a toolbar.
+ * @public
+ */
+export interface CustomButtonDefinition extends ToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon?: string | ConditionalStringValue;
+    /** label, shown as tool tip on group button or a group button label in a group panel. */
+    readonly label?: string | ConditionalStringValue;
+    /** parameter that marks data as being a custom definition. */
+    readonly isCustom: true;
+}
+/** Any Button Type that can be inserted into a toolbar.
+ * @public
+ */
+export declare type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
+/** Type for Toolbar Item Id
+ * @deprecated in 3.6. Please use `ToolbarItem["id"]` from @itwin/appui-react.
+ * @public
+ */
+export declare type ToolbarItemId = CommonToolbarItem["id"];
+/** Helper class to create Abstract StatusBar Item definitions.
+ * @public
+ */
+export declare class ToolbarItemUtilities {
+    /** Creates an Action Button */
+    static createActionButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton> | undefined) => ActionButton;
+    /** Creates a Group button. */
+    static createGroupButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton> | undefined) => GroupButton;
+    /** ActionButton type guard. */
+    static isActionButton(item: CommonToolbarItem): item is ActionButton;
+    /** GroupButton type guard. */
+    static isGroupButton(item: CommonToolbarItem): item is GroupButton;
+    /** CustomButtonDefinition type guard. */
+    static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition;
+}
 //# sourceMappingURL=ToolbarItem.d.ts.map

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js

@@ -1,65 +1,65 @@
-"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.ToolbarItemUtilities = exports.ToolbarOrientation = exports.ToolbarUsage = void 0;
-/** Used to specify the usage of the toolbar which determine the toolbar position.
- * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
- * @public
- */
-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 = exports.ToolbarUsage || (exports.ToolbarUsage = {}));
-/** Used to specify the orientation of the toolbar.
- * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
- * @public
- */
-var ToolbarOrientation;
-(function (ToolbarOrientation) {
-    /** Horizontal toolbar. */
-    ToolbarOrientation[ToolbarOrientation["Horizontal"] = 0] = "Horizontal";
-    /** Vertical toolbar. */
-    ToolbarOrientation[ToolbarOrientation["Vertical"] = 1] = "Vertical";
-})(ToolbarOrientation = exports.ToolbarOrientation || (exports.ToolbarOrientation = {}));
-/** Helper class to create Abstract StatusBar Item definitions.
- * @public
- */
-class ToolbarItemUtilities {
-    /** ActionButton type guard. */
-    static isActionButton(item) {
-        return item.execute !== undefined;
-    }
-    /** GroupButton type guard. */
-    static isGroupButton(item) {
-        return item.items !== undefined;
-    }
-    /** CustomButtonDefinition type guard. */
-    static isCustomDefinition(item) {
-        return !!item.isCustom;
-    }
-}
-exports.ToolbarItemUtilities = ToolbarItemUtilities;
-/** Creates an Action Button */
-ToolbarItemUtilities.createActionButton = (id, itemPriority, icon, label, execute, overrides) => ({
-    id, itemPriority,
-    icon, label,
-    execute,
-    ...overrides,
-});
-/** Creates a Group button. */
-ToolbarItemUtilities.createGroupButton = (id, itemPriority, icon, label, items, overrides) => ({
-    id, itemPriority,
-    icon, label,
-    items,
-    ...overrides,
-});
+"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.ToolbarItemUtilities = exports.ToolbarOrientation = exports.ToolbarUsage = void 0;
+/** Used to specify the usage of the toolbar which determine the toolbar position.
+ * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
+ * @public
+ */
+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 = exports.ToolbarUsage || (exports.ToolbarUsage = {}));
+/** Used to specify the orientation of the toolbar.
+ * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
+ * @public
+ */
+var ToolbarOrientation;
+(function (ToolbarOrientation) {
+    /** Horizontal toolbar. */
+    ToolbarOrientation[ToolbarOrientation["Horizontal"] = 0] = "Horizontal";
+    /** Vertical toolbar. */
+    ToolbarOrientation[ToolbarOrientation["Vertical"] = 1] = "Vertical";
+})(ToolbarOrientation = exports.ToolbarOrientation || (exports.ToolbarOrientation = {}));
+/** Helper class to create Abstract StatusBar Item definitions.
+ * @public
+ */
+class ToolbarItemUtilities {
+    /** ActionButton type guard. */
+    static isActionButton(item) {
+        return item.execute !== undefined;
+    }
+    /** GroupButton type guard. */
+    static isGroupButton(item) {
+        return item.items !== undefined;
+    }
+    /** CustomButtonDefinition type guard. */
+    static isCustomDefinition(item) {
+        return !!item.isCustom;
+    }
+}
+exports.ToolbarItemUtilities = ToolbarItemUtilities;
+/** Creates an Action Button */
+ToolbarItemUtilities.createActionButton = (id, itemPriority, icon, label, execute, overrides) => ({
+    id, itemPriority,
+    icon, label,
+    execute,
+    ...overrides,
+});
+/** Creates a Group button. */
+ToolbarItemUtilities.createGroupButton = (id, itemPriority, icon, label, items, overrides) => ({
+    id, itemPriority,
+    icon, label,
+    items,
+    ...overrides,
+});
 //# sourceMappingURL=ToolbarItem.js.map

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAa,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA9BH,oDA+BC;AA9BC,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Used to specify the usage of the toolbar which determine the toolbar position.\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\n * @public\n */\nexport enum ToolbarUsage {\n  /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */\n  ContentManipulation = 0,\n  /** Manipulate view/camera - in ninezone this is in top right of content area. */\n  ViewNavigation = 1,\n}\n\n/** Used to specify the orientation of the toolbar.\n * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\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 ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\n  /** can be used by application to store miscellaneous data. */\n  readonly applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Optional description */\n  readonly description?: string | ConditionalStringValue;\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  /** optional data to used by item implementor. */\n  readonly internalData?: Map<string, any>;\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  /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\n   * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\n   * the icon is usually changed to denote the state of a toggle.\n   */\n  readonly isPressed?: boolean;\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  /** Optional parent tool group to add tool. */\n  readonly parentToolGroupId?: string;\n}\n\n/** Describes the data needed to insert an action button into a toolbar.\n * @public\n */\nexport interface ActionButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\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}\n\n/** Describes the data needed to insert a group button into a toolbar.\n * @public\n */\nexport interface GroupButton extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon: string | ConditionalStringValue;\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<ActionButton | GroupButton>; // eslint-disable-line deprecation/deprecation\n}\n\n/** Describes the data needed to insert a custom button into a toolbar.\n * @public\n */\nexport interface CustomButtonDefinition extends ToolbarItem {\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** label, shown as tool tip on group button or a group button label in a group panel. */\n  readonly label?: string | ConditionalStringValue;\n  /** parameter that marks data as being a custom definition. */\n  readonly isCustom: true;\n}\n\n/** Any Button Type that can be inserted into a toolbar.\n * @public\n */\nexport type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;\n\n/** Type for Toolbar Item Id\n * @deprecated in 3.6. Please use `ToolbarItem[\"id\"]` from @itwin/appui-react.\n * @public\n */\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @public\n */\nexport class ToolbarItemUtilities {\n  /** Creates an Action Button */\n  public static createActionButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\n    id, itemPriority,\n    icon, label,\n    execute,\n    ...overrides,\n  });\n\n  /** Creates a Group button. */\n  public static createGroupButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\n    id, itemPriority,\n    icon, label,\n    items,\n    ...overrides,\n  });\n\n  /** ActionButton type guard. */\n  public static isActionButton(item: CommonToolbarItem): item is ActionButton {\n    return (item as ActionButton).execute !== undefined;\n  }\n\n  /** GroupButton type guard. */\n  public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\n    return (item as GroupButton).items !== undefined;\n  }\n\n  /** CustomButtonDefinition type guard. */\n  public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\n    return !!(item as CustomButtonDefinition).isCustom;\n  }\n}\n"]}
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAa,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA9BH,oDA+BC;AA9BC,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,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\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Used to specify the usage of the toolbar which determine the toolbar position.\r\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\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 * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\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 ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** can be used by application to store miscellaneous data. */\r\n  readonly applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Optional description */\r\n  readonly description?: string | ConditionalStringValue;\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  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\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  /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\r\n   * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\r\n   * the icon is usually changed to denote the state of a toggle.\r\n   */\r\n  readonly isPressed?: boolean;\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  /** Optional parent tool group to add tool. */\r\n  readonly parentToolGroupId?: string;\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 ActionButton extends ToolbarItem {\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: string | ConditionalStringValue;\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}\r\n\r\n/** Describes the data needed to insert a group button into a toolbar.\r\n * @public\r\n */\r\nexport interface GroupButton extends ToolbarItem {\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: string | ConditionalStringValue;\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<ActionButton | GroupButton>; // eslint-disable-line deprecation/deprecation\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 CustomButtonDefinition extends ToolbarItem {\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?: string | ConditionalStringValue;\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  /** parameter that marks data as being a custom definition. */\r\n  readonly isCustom: true;\r\n}\r\n\r\n/** Any Button Type that can be inserted into a toolbar.\r\n * @public\r\n */\r\nexport type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;\r\n\r\n/** Type for Toolbar Item Id\r\n * @deprecated in 3.6. Please use `ToolbarItem[\"id\"]` from @itwin/appui-react.\r\n * @public\r\n */\r\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @public\r\n */\r\nexport class ToolbarItemUtilities {\r\n  /** Creates an Action Button */\r\n  public static createActionButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\r\n    id, itemPriority,\r\n    icon, label,\r\n    execute,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates a Group button. */\r\n  public static createGroupButton = (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\r\n    id, itemPriority,\r\n    icon, label,\r\n    items,\r\n    ...overrides,\r\n  });\r\n\r\n  /** ActionButton type guard. */\r\n  public static isActionButton(item: CommonToolbarItem): item is ActionButton {\r\n    return (item as ActionButton).execute !== undefined;\r\n  }\r\n\r\n  /** GroupButton type guard. */\r\n  public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\r\n    return (item as GroupButton).items !== undefined;\r\n  }\r\n\r\n  /** CustomButtonDefinition type guard. */\r\n  public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\r\n    return !!(item as CustomButtonDefinition).isCustom;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts

@@ -1,46 +1,46 @@
-/** @packageDocumentation
- * @module Toolbar
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { CommonToolbarItem, ToolbarItemId } from "./ToolbarItem";
-/** Arguments of [[ToolbarItemsManager.onChanged]] event.
- * @internal
- */
-export interface ToolbarItemsChangedArgs {
-    readonly items: ReadonlyArray<CommonToolbarItem>;
-}
-/**
- * Controls status bar items.
- * @internal
- */
-export declare class ToolbarItemsManager {
-    protected _items: ReadonlyArray<CommonToolbarItem>;
-    constructor(items?: ReadonlyArray<CommonToolbarItem>);
-    /** Event raised when Toolbar items are changed.
-     * @internal
-     */
-    readonly onItemsChanged: BeEvent<(args: ToolbarItemsChangedArgs) => void>;
-    private loadItemsInternal;
-    /** load items but do not fire onItemsChanged
-     * @internal
-     */
-    loadItems(items: ReadonlyArray<CommonToolbarItem>): void;
-    /** Get an array of the Toolbar items  */
-    get items(): ReadonlyArray<CommonToolbarItem>;
-    set items(items: ReadonlyArray<CommonToolbarItem>);
-    add(itemOrItems: CommonToolbarItem | ReadonlyArray<CommonToolbarItem>): void;
-    /** Remove Toolbar items based on id */
-    remove(itemIdOrItemIds: ToolbarItemId | ReadonlyArray<ToolbarItemId>): void;
-    /** @internal */
-    removeAll(): void;
-    private static gatherSyncIds;
-    static getSyncIdsOfInterest(items: readonly CommonToolbarItem[]): string[];
-    private static refreshChildItems;
-    private internalRefreshAffectedItems;
-    refreshAffectedItems(eventIds: Set<string>): void;
-    private static isActiveToolIdRefreshRequiredForChildren;
-    private isActiveToolIdRefreshRequired;
-    private static refreshActiveToolIdInChildItems;
-    setActiveToolId(toolId: string): void;
-}
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { CommonToolbarItem, ToolbarItemId } from "./ToolbarItem";
+/** Arguments of [[ToolbarItemsManager.onChanged]] event.
+ * @internal
+ */
+export interface ToolbarItemsChangedArgs {
+    readonly items: ReadonlyArray<CommonToolbarItem>;
+}
+/**
+ * Controls status bar items.
+ * @internal
+ */
+export declare class ToolbarItemsManager {
+    protected _items: ReadonlyArray<CommonToolbarItem>;
+    constructor(items?: ReadonlyArray<CommonToolbarItem>);
+    /** Event raised when Toolbar items are changed.
+     * @internal
+     */
+    readonly onItemsChanged: BeEvent<(args: ToolbarItemsChangedArgs) => void>;
+    private loadItemsInternal;
+    /** load items but do not fire onItemsChanged
+     * @internal
+     */
+    loadItems(items: ReadonlyArray<CommonToolbarItem>): void;
+    /** Get an array of the Toolbar items  */
+    get items(): ReadonlyArray<CommonToolbarItem>;
+    set items(items: ReadonlyArray<CommonToolbarItem>);
+    add(itemOrItems: CommonToolbarItem | ReadonlyArray<CommonToolbarItem>): void;
+    /** Remove Toolbar items based on id */
+    remove(itemIdOrItemIds: ToolbarItemId | ReadonlyArray<ToolbarItemId>): void;
+    /** @internal */
+    removeAll(): void;
+    private static gatherSyncIds;
+    static getSyncIdsOfInterest(items: readonly CommonToolbarItem[]): string[];
+    private static refreshChildItems;
+    private internalRefreshAffectedItems;
+    refreshAffectedItems(eventIds: Set<string>): void;
+    private static isActiveToolIdRefreshRequiredForChildren;
+    private isActiveToolIdRefreshRequired;
+    private static refreshActiveToolIdInChildItems;
+    setActiveToolId(toolId: string): void;
+}
 //# sourceMappingURL=ToolbarItemsManager.d.ts.map