@itwin/appui-abstract 3.2.0-dev.8 → 3.3.0-dev.1

package/lib/cjs/appui-abstract/UiItemsProvider.d.ts

@@ -0,0 +1,28 @@
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+import { BackstageItem } from "./backstage/BackstageItem";
+import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
+import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
+import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
+import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
+/** Describes interface of objects that want to provide UI component to the running IModelApp.
+ * @public
+ */
+export interface UiItemsProvider {
+    /** id of provider */
+    readonly id: string;
+    /** UiItemsManager calls following method to get items to populate specific toolbars */
+    provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[];
+    /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */
+    provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[];
+    /** UiItemsManager calls following method to augment backstage items. */
+    provideBackstageItems?: () => BackstageItem[];
+    /** UiItemsManager calls following method to augment Widget lists.
+     * @note Returned widgets must provide unique `AbstractWidgetProps["id"]` to correctly save/restore App layout.
+     */
+    provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;
+    /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */
+    onUnregister?: () => void;
+}
+//# sourceMappingURL=UiItemsProvider.d.ts.map

package/lib/cjs/appui-abstract/UiItemsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAElG;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,uFAAuF;IACvF,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,iBAAiB,EAAE,CAAC;IACjL,gGAAgG;IAChG,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,mBAAmB,EAAE,CAAC;IAC3G,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,MAAM,aAAa,EAAE,CAAC;IAC9C;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAC9G,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACjG,uHAAuH;IACvH,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B"}

package/lib/cjs/appui-abstract/UiItemsProvider.js

@@ -0,0 +1,11 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=UiItemsProvider.js.map

package/lib/cjs/appui-abstract/UiItemsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\n\r\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\r\n * @public\r\n */\r\nexport interface UiItemsProvider {\r\n  /** id of provider */\r\n  readonly id: string;\r\n\r\n  /** UiItemsManager calls following method to get items to populate specific toolbars */\r\n  provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[];\r\n  /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */\r\n  provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[];\r\n  /** UiItemsManager calls following method to augment backstage items. */\r\n  provideBackstageItems?: () => BackstageItem[];\r\n  /** UiItemsManager calls following method to augment Widget lists.\r\n   * @note Returned widgets must provide unique `AbstractWidgetProps[\"id\"]` to correctly save/restore App layout.\r\n   */\r\n  provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection,\r\n    zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;\r\n  /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */\r\n  onUnregister?: () => void;\r\n}\r\n"]}

package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts

@@ -27,7 +27,7 @@ export interface CommonBackstageItem extends ProvidedItem {
      * allows extensions enough gaps to insert their own groups.
      */
     readonly groupPriority: number;
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
     readonly icon?: string | ConditionalStringValue;
     /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
     readonly id: string;

package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,YAAY,SAAU,aAAa,gCAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,SAAU,aAAa,mCAElD,CAAC;AAEF;;GAEG;AACH,qBAAa,sBAAsB;IACjC,8CAA8C;IAC9C,OAAc,mBAAmB,iBACjB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,GAAG,sBAAsB,0KAExG,sBAAsB,CAStB;IAEH,uCAAuC;IACvC,OAAc,gBAAgB,WACpB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,GAAG,sBAAsB,uKAEvH,mBAAmB,CASnB;CACJ"}
+{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,YAAY,SAAU,aAAa,gCAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,SAAU,aAAa,mCAElD,CAAC;AAEF;;GAEG;AACH,qBAAa,sBAAsB;IACjC,8CAA8C;IAC9C,OAAc,mBAAmB,iBACjB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,GAAG,sBAAsB,0KAExG,sBAAsB,CAUtB;IAEH,uCAAuC;IACvC,OAAc,gBAAgB,WACpB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,GAAG,sBAAsB,uKAEvH,mBAAmB,CAUnB;CACJ"}

package/lib/cjs/appui-abstract/backstage/BackstageItem.js

@@ -42,6 +42,7 @@ exports.BackstageItemUtilities = BackstageItemUtilities;
 BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, icon, overrides) => ({
     groupPriority,
     icon,
+    internalData: overrides === null || overrides === void 0 ? void 0 : overrides.internalData,
     id: frontstageId,
     itemPriority,
     label,
@@ -54,6 +55,7 @@ BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority,
     execute,
     groupPriority,
     icon,
+    internalData: overrides === null || overrides === void 0 ? void 0 : overrides.internalData,
     id: itemId,
     itemPriority,
     label,

package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;GAEG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAwDD;;GAEG;AACI,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC;AAC7D,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB;AAEF;;GAEG;AACI,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAEF;;GAEG;AACH,MAAa,sBAAsB;;AAAnC,wDA8BC;AA7BC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,EACvG,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,EACvG,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,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 Backstage\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 item type added to the backstage menu.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n  /** Item that executes an action function */\r\n  ActionItem = 1,\r\n  /** Item that activate a stage. */\r\n  StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem {\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\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.\r\n   */\r\n  readonly groupPriority: number;\r\n  /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Required unique id of 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 be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\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  /** Priority within a group (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Subtitle. */\r\n  readonly subtitle?: string | ConditionalStringValue;\r\n  /** Tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n  readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem {\r\n  readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem {\r\n  readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher;\r\n\r\n/** BackstageActionItem type guard.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => {\r\n  return (item as BackstageActionItem).execute !== undefined;\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => {\r\n  return (item as BackstageStageLauncher).stageId !== undefined;\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item */\r\n  public static createStageLauncher = (\r\n    frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>\r\n  ): BackstageStageLauncher => ({\r\n    groupPriority,\r\n    icon,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item */\r\n  public static createActionItem = (\r\n    itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>\r\n  ): BackstageActionItem => ({\r\n    execute,\r\n    groupPriority,\r\n    icon,\r\n    id: itemId,\r\n    itemPriority,\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}
+{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;GAEG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAwDD;;GAEG;AACI,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC;AAC7D,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB;AAEF;;GAEG;AACI,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAEF;;GAEG;AACH,MAAa,sBAAsB;;AAAnC,wDAgCC;AA/BC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,EACvG,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,YAAY;IACrC,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,EACvG,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,YAAY;IACrC,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,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 Backstage\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 item type added to the backstage menu.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n  /** Item that executes an action function */\r\n  ActionItem = 1,\r\n  /** Item that activate a stage. */\r\n  StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem {\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\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.\r\n   */\r\n  readonly groupPriority: number;\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  /** Required unique id of 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 be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\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  /** Priority within a group (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Subtitle. */\r\n  readonly subtitle?: string | ConditionalStringValue;\r\n  /** Tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n  readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem {\r\n  readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem {\r\n  readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher;\r\n\r\n/** BackstageActionItem type guard.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => {\r\n  return (item as BackstageActionItem).execute !== undefined;\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => {\r\n  return (item as BackstageStageLauncher).stageId !== undefined;\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item */\r\n  public static createStageLauncher = (\r\n    frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>\r\n  ): BackstageStageLauncher => ({\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item */\r\n  public static createActionItem = (\r\n    itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>\r\n  ): BackstageActionItem => ({\r\n    execute,\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: itemId,\r\n    itemPriority,\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}

package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts

@@ -18,7 +18,7 @@ export interface CommonItemProps {
     badgeType?: BadgeType;
     /** if set, it is used to explicitly set the description shown by components that support a description. */
     description?: string | ConditionalStringValue;
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
     icon?: string | ConditionalStringValue;
     /** optional data to be used by item implementor. */
     readonly internalData?: Map<string, any>;

package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractItemProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/items/AbstractItemProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,wCAAwC;IACxC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,2GAA2G;IAC3G,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC9C,0HAA0H;IAC1H,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvC,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEzC,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC7C,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,2GAA2G;IAC3G,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2KAA2K;IAC3K,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACxC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,0BAA0B;IAC1B,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,4DAA4D;IAC5D,cAAc,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe,EAAE,cAAc;CAC/E"}
+{"version":3,"file":"AbstractItemProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/items/AbstractItemProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,wCAAwC;IACxC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,2GAA2G;IAC3G,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC9C,sHAAsH;IACtH,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvC,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEzC,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC7C,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,2GAA2G;IAC3G,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2KAA2K;IAC3K,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACxC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,0BAA0B;IAC1B,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;IAC9B,wCAAwC;IACxC,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,4DAA4D;IAC5D,cAAc,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe,EAAE,cAAc;CAC/E"}

package/lib/cjs/appui-abstract/items/AbstractItemProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractItemProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/AbstractItemProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Item\r\n */\r\n\r\nimport { BadgeType } from \"./BadgeType\";\r\nimport { ConditionalBooleanValue } from \"./ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"./ConditionalStringValue\";\r\n\r\n/** Prototype for string getter function.\r\n * @public\r\n */\r\nexport type StringGetter = () => string;\r\n\r\n/** Definition that specifies properties shared between many ConfigurableUi components.\r\n * @public\r\n */\r\nexport interface CommonItemProps {\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Badge to be overlaid on the item. */\r\n  badgeType?: BadgeType;\r\n  /** if set, it is used to explicitly set the description shown by components that support a description. */\r\n  description?: string | ConditionalStringValue;\r\n  /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id. */\r\n  icon?: string | ConditionalStringValue;\r\n  /** optional data to be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n\r\n  /** if true component will be hidden - defaults to false */\r\n  isHidden?: boolean | ConditionalBooleanValue;\r\n  /** if true component will be disabled - defaults to false */\r\n  isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** if set, component will be considered \"active\" an will display an \"active stripe\" - defaults to false */\r\n  isActive?: boolean;\r\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\r\n  isPressed?: boolean;\r\n  /** if set, it is used to explicitly set the label shown by a component. */\r\n  label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Definition for a command handler.\r\n * @public\r\n */\r\nexport interface CommandHandler {\r\n  /** Function to execute */\r\n  execute?: (args?: any) => any;\r\n  /** Parameters passed to the function */\r\n  parameters?: any;\r\n  /** Function to get the parameters passed to the function */\r\n  getCommandArgs?: () => any[];\r\n}\r\n\r\n/** Definition for an item that executes and action.\r\n * @public\r\n */\r\nexport interface AbstractActionItemProps extends CommonItemProps, CommandHandler {\r\n}\r\n"]}
+{"version":3,"file":"AbstractItemProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/AbstractItemProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Item\r\n */\r\n\r\nimport { BadgeType } from \"./BadgeType\";\r\nimport { ConditionalBooleanValue } from \"./ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"./ConditionalStringValue\";\r\n\r\n/** Prototype for string getter function.\r\n * @public\r\n */\r\nexport type StringGetter = () => string;\r\n\r\n/** Definition that specifies properties shared between many ConfigurableUi components.\r\n * @public\r\n */\r\nexport interface CommonItemProps {\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Badge to be overlaid on the item. */\r\n  badgeType?: BadgeType;\r\n  /** if set, it is used to explicitly set the description shown by components that support a description. */\r\n  description?: string | ConditionalStringValue;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\r\n  icon?: string | ConditionalStringValue;\r\n  /** optional data to be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n\r\n  /** if true component will be hidden - defaults to false */\r\n  isHidden?: boolean | ConditionalBooleanValue;\r\n  /** if true component will be disabled - defaults to false */\r\n  isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** if set, component will be considered \"active\" an will display an \"active stripe\" - defaults to false */\r\n  isActive?: boolean;\r\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\r\n  isPressed?: boolean;\r\n  /** if set, it is used to explicitly set the label shown by a component. */\r\n  label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Definition for a command handler.\r\n * @public\r\n */\r\nexport interface CommandHandler {\r\n  /** Function to execute */\r\n  execute?: (args?: any) => any;\r\n  /** Parameters passed to the function */\r\n  parameters?: any;\r\n  /** Function to get the parameters passed to the function */\r\n  getCommandArgs?: () => any[];\r\n}\r\n\r\n/** Definition for an item that executes and action.\r\n * @public\r\n */\r\nexport interface AbstractActionItemProps extends CommonItemProps, CommandHandler {\r\n}\r\n"]}

package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts

@@ -14,7 +14,7 @@ export interface AbstractMenuItemProps extends CommonItemProps {
     /** Nested array of item props. Either 'item' or 'submenu' must be specified. */
     submenu?: AbstractMenuItemProps[];
     /** Icon to display on right side of the menu item.
-     * Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.
+     * Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id.
      */
     iconRight?: string | ConditionalStringValue;
 }

package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractMenuItemProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/AbstractMenuItemProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Item\r\n */\r\n\r\nimport { AbstractActionItemProps, CommonItemProps } from \"./AbstractItemProps\";\r\nimport { ConditionalStringValue } from \"./ConditionalStringValue\";\r\n\r\n/** Properties for a Menu item\r\n * @public\r\n */\r\nexport interface AbstractMenuItemProps extends CommonItemProps {\r\n  /** The id for the menu item. */\r\n  id: string;\r\n  /** The item to execute when this item is invoked. Either 'item' or 'submenu' must be specified. */\r\n  item?: AbstractActionItemProps;\r\n  /** Nested array of item props. Either 'item' or 'submenu' must be specified. */\r\n  submenu?: AbstractMenuItemProps[];\r\n  /** Icon to display on right side of the menu item.\r\n   * Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id.\r\n   */\r\n  iconRight?: string | ConditionalStringValue;\r\n}\r\n"]}
+{"version":3,"file":"AbstractMenuItemProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/AbstractMenuItemProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Item\r\n */\r\n\r\nimport { AbstractActionItemProps, CommonItemProps } from \"./AbstractItemProps\";\r\nimport { ConditionalStringValue } from \"./ConditionalStringValue\";\r\n\r\n/** Properties for a Menu item\r\n * @public\r\n */\r\nexport interface AbstractMenuItemProps extends CommonItemProps {\r\n  /** The id for the menu item. */\r\n  id: string;\r\n  /** The item to execute when this item is invoked. Either 'item' or 'submenu' must be specified. */\r\n  item?: AbstractActionItemProps;\r\n  /** Nested array of item props. Either 'item' or 'submenu' must be specified. */\r\n  submenu?: AbstractMenuItemProps[];\r\n  /** Icon to display on right side of the menu item.\r\n   * Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id.\r\n   */\r\n  iconRight?: string | ConditionalStringValue;\r\n}\r\n"]}

package/lib/cjs/appui-abstract/properties/EditorParams.d.ts

@@ -112,7 +112,7 @@ export declare const isIconListEditorParams: (item: BasePropertyEditorParams) =>
  * @public
  */
 export interface IconDefinition {
-    /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an SVG symbol, use `svg:` prefix. */
+    /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an imported SVG symbol use "webSvg:" prefix . */
     iconSpec: string;
     /** Function to determine if the item is enabled. */
     isEnabledFunction?: () => boolean;

package/lib/cjs/appui-abstract/properties/EditorParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EditorParams.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/EditorParams.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,CAAC;IACnC,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CACtD;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,IAAI,IAAI;IAER,QAAQ,IAAI;IAEZ,WAAW,IAAA;IAEX,QAAQ,IAAA;IAER,WAAW,IAAA;IAEX,eAAe,IAAA;IAEf,kBAAkB,IAAA;CACnB;AAED;;GAEG;AACH,oBAAY,WAAW;IAErB,KAAK,aAAa;IAElB,MAAM,gBAAgB;IAEtB,IAAI,UAAU;IAEd,KAAK,aAAa;CACnB;AAED;;;GAGG;AACH,oBAAY,wBAAwB;IAClC,eAAe,+BAA+B;IAC9C,aAAa,6BAA6B;IAC1C,IAAI,oBAAoB;IACxB,eAAe,+BAA+B;IAC9C,SAAS,yBAAyB;IAClC,qBAAqB,qCAAqC;IAC1D,YAAY,4BAA4B;IAExC,aAAa,6BAA6B;IAC1C,KAAK,qBAAqB;IAC1B,MAAM,sBAAsB;IAE5B,mBAAmB,mCAAmC;IACtD,cAAc,8BAA8B;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,wBAAwB;IACrE,IAAI,EAAE,wBAAwB,CAAC,eAAe,CAAC;IAC/C,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,SAAU,wBAAwB,kCAErE,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE,IAAI,EAAE,wBAAwB,CAAC,SAAS,CAAC;IACzC,kJAAkJ;IAClJ,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAU,wBAAwB,8BAEjE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,wBAAwB;IACpE,IAAI,EAAE,wBAAwB,CAAC,YAAY,CAAC;IAC5C,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,6FAA6F;IAC7F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,SAAU,wBAAwB,iCAEpE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,6HAA6H;IAC7H,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,OAAO,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,IAAI,EAAE,wBAAwB,CAAC,eAAe,CAAC;IAC/C,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,SAAU,wBAAwB,oCAEvE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE,IAAI,EAAE,wBAAwB,CAAC,mBAAmB,CAAC;IACnD,wHAAwH;IACxH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B,SAAU,wBAAwB,sCAEzE,CAAC;AAWF;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE,IAAI,EAAE,wBAAwB,CAAC,KAAK,CAAC;IACrC,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,wBAAwB;IAClE,IAAI,EAAE,wBAAwB,CAAC,MAAM,CAAC;IACtC,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAEhB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,sEAAsE;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,qHAAqH;IACrH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mFAAmF;IACnF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qCAAqC;IACrC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAE1C,oFAAoF;IACpF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kEAAkE;IAClE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACtC,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,MAAM,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,MAAM,EAAE,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE,IAAI,EAAE,wBAAwB,CAAC,aAAa,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,wBAAwB;IAChE,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;IACpC,UAAU,EAAE,cAAc,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,wBAAwB;IACnE,IAAI,EAAE,wBAAwB,CAAC,cAAc,CAAC;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAElB;AAUD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,SAAS,CAAC;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,wBAAwB;IAC3E,IAAI,EAAE,wBAAwB,CAAC,qBAAqB,CAAC;IACrD,cAAc,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAC;IAChD,aAAa,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,YAAY,CAAC;CACtD;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B,SAAU,wBAAwB,wCAE3E,CAAC;AAEF;;;GAGG;AACH,oBAAY,oBAAoB,GAAG,wBAAwB,CAAC"}
+{"version":3,"file":"EditorParams.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/EditorParams.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,CAAC;IACnC,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,GAAG,SAAS,CAAC;CACtD;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,IAAI,IAAI;IAER,QAAQ,IAAI;IAEZ,WAAW,IAAA;IAEX,QAAQ,IAAA;IAER,WAAW,IAAA;IAEX,eAAe,IAAA;IAEf,kBAAkB,IAAA;CACnB;AAED;;GAEG;AACH,oBAAY,WAAW;IAErB,KAAK,aAAa;IAElB,MAAM,gBAAgB;IAEtB,IAAI,UAAU;IAEd,KAAK,aAAa;CACnB;AAED;;;GAGG;AACH,oBAAY,wBAAwB;IAClC,eAAe,+BAA+B;IAC9C,aAAa,6BAA6B;IAC1C,IAAI,oBAAoB;IACxB,eAAe,+BAA+B;IAC9C,SAAS,yBAAyB;IAClC,qBAAqB,qCAAqC;IAC1D,YAAY,4BAA4B;IAExC,aAAa,6BAA6B;IAC1C,KAAK,qBAAqB;IAC1B,MAAM,sBAAsB;IAE5B,mBAAmB,mCAAmC;IACtD,cAAc,8BAA8B;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,wBAAwB;IACrE,IAAI,EAAE,wBAAwB,CAAC,eAAe,CAAC;IAC/C,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,SAAU,wBAAwB,kCAErE,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE,IAAI,EAAE,wBAAwB,CAAC,SAAS,CAAC;IACzC,kJAAkJ;IAClJ,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAU,wBAAwB,8BAEjE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,wBAAwB;IACpE,IAAI,EAAE,wBAAwB,CAAC,YAAY,CAAC;IAC5C,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,6FAA6F;IAC7F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,SAAU,wBAAwB,iCAEpE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,yIAAyI;IACzI,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,OAAO,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,wBAAwB;IACvE,IAAI,EAAE,wBAAwB,CAAC,eAAe,CAAC;IAC/C,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,SAAU,wBAAwB,oCAEvE,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE,IAAI,EAAE,wBAAwB,CAAC,mBAAmB,CAAC;IACnD,wHAAwH;IACxH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B,SAAU,wBAAwB,sCAEzE,CAAC;AAWF;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,wBAAwB;IACjE,IAAI,EAAE,wBAAwB,CAAC,KAAK,CAAC;IACrC,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,wBAAwB;IAClE,IAAI,EAAE,wBAAwB,CAAC,MAAM,CAAC;IACtC,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAEhB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,sEAAsE;IACtE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,qHAAqH;IACrH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mFAAmF;IACnF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qCAAqC;IACrC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAE1C,oFAAoF;IACpF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kEAAkE;IAClE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACtC,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,MAAM,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,MAAM,EAAE,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;IACzE,IAAI,EAAE,wBAAwB,CAAC,aAAa,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,wBAAwB;IAChE,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;IACpC,UAAU,EAAE,cAAc,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,wBAAwB;IACnE,IAAI,EAAE,wBAAwB,CAAC,cAAc,CAAC;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAElB;AAUD;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,SAAS,CAAC;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,wBAAwB;IAC3E,IAAI,EAAE,wBAAwB,CAAC,qBAAqB,CAAC;IACrD,cAAc,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAC;IAChD,aAAa,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,YAAY,CAAC;CACtD;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B,SAAU,wBAAwB,wCAE3E,CAAC;AAEF;;;GAGG;AACH,oBAAY,oBAAoB,GAAG,wBAAwB,CAAC"}

package/lib/cjs/appui-abstract/properties/EditorParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditorParams.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/EditorParams.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAcH;;GAEG;AACH,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC9B,+DAAQ,CAAA;IACR,aAAa;IACb,uEAAY,CAAA;IACZ,2BAA2B;IAC3B,6EAAW,CAAA;IACX,cAAc;IACd,uEAAQ,CAAA;IACR,2BAA2B;IAC3B,6EAAW,CAAA;IACX,mBAAmB;IACnB,qFAAe,CAAA;IACf,gCAAgC;IAChC,2FAAkB,CAAA;AACpB,CAAC,EAdW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAc/B;AAED;;GAEG;AACH,IAAY,WASX;AATD,WAAY,WAAW;IACrB,wCAAwC;IACxC,iCAAkB,CAAA;IAClB,iDAAiD;IACjD,qCAAsB,CAAA;IACtB,uBAAuB;IACvB,6BAAc,CAAA;IACd,mCAAmC;IACnC,iCAAkB,CAAA;AACpB,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB;AAED;;;GAGG;AACH,IAAY,wBAeX;AAfD,WAAY,wBAAwB;IAClC,0EAA8C,CAAA;IAC9C,sEAA0C,CAAA;IAC1C,oDAAwB,CAAA;IACxB,0EAA8C,CAAA;IAC9C,8DAAkC,CAAA;IAClC,sFAA0D,CAAA;IAC1D,oEAAwC,CAAA;IACxC,4BAA4B;IAC5B,sEAA0C,CAAA;IAC1C,sDAA0B,CAAA;IAC1B,wDAA4B,CAAA;IAC5B,sDAAsD;IACtD,kFAAsD,CAAA;IACtD,wEAA4C,CAAA;AAC9C,CAAC,EAfW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAenC;AAyBD;;GAEG;AACI,MAAM,uBAAuB,GAAG,CAAC,IAA8B,EAAiC,EAAE;IACvG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,uBAAuB,2BAElC;AAeF;;GAEG;AACI,MAAM,mBAAmB,GAAG,CAAC,IAA8B,EAA6B,EAAE;IAC/F,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,SAAS,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,mBAAmB,uBAE9B;AAgBF;;GAEG;AACI,MAAM,sBAAsB,GAAG,CAAC,IAA8B,EAAgC,EAAE;IACrG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,YAAY,CAAC;AAC7D,CAAC,CAAC;AAFW,QAAA,sBAAsB,0BAEjC;AAsBF;;GAEG;AACI,MAAM,yBAAyB,GAAG,CAAC,IAA8B,EAAmC,EAAE;IAC3G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,yBAAyB,6BAEpC;AAYF;;GAEG;AACI,MAAM,2BAA2B,GAAG,CAAC,IAA8B,EAAqC,EAAE;IAC/G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,mBAAmB,CAAC;AACpE,CAAC,CAAC;AAFW,QAAA,2BAA2B,+BAEtC;AA4IF;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAA8B,EAAuC,EAAE;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,qBAAqB,CAAC;AACtE,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC","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 Properties\r\n */\r\n\r\n// cspell:ignore BBGGRR pushable DDTHH\r\n\r\n/** Interface used to provide a custom Date Time formatter and optional parser\r\n * for use by `DatePickerPopup`. If a parseData function is not implemented\r\n * then string to date parsing will not be possible when a `DateFormatter` is used.\r\n * @public\r\n */\r\nexport interface DateFormatter {\r\n  formateDate: (day: Date) => string;\r\n  parseDate?: (dateString: string) => Date | undefined;\r\n}\r\n\r\n/** Alternate Data Formats that can be provide by javascript. Can be used by Date TypeConverter and TypeEditor.\r\n * @public\r\n */\r\nexport enum AlternateDateFormats {\r\n  None = 0,\r\n  // YYYY-MM-DD\r\n  IsoShort = 1,\r\n  // YYYY-MM-DDTHH:mm:ss.sssZ\r\n  IsoDateTime,\r\n  // dd Mmm yyyy\r\n  UtcShort,\r\n  // dd Mmm yyyy hh:mm:ss GMT\r\n  UtcDateTime,\r\n  // Www, dd Mmm yyyy\r\n  UtcShortWithDay,\r\n  // Www, dd Mmm yyyy hh:mm:ss GMT\r\n  UtcDateTimeWithDay,\r\n}\r\n\r\n/** Enum that defines supported time formats.\r\n * @public\r\n */\r\nexport enum TimeDisplay {\r\n  // 12 hour with minutes and cycle(AM/PM)\r\n  H12MC = \"hh:mm aa\",\r\n  // 12 hour with minutes, seconds and cycle(AM/PM)\r\n  H12MSC = \"hh:mm:ss aa\",\r\n  // 24 hour with minutes\r\n  H24M = \"hh:mm\",\r\n  // 24 hour with minutes and seconds\r\n  H24MS = \"hh:mm:ss\",\r\n}\r\n\r\n/**\r\n * Enum for Property Editor Param Types\r\n * @public\r\n */\r\nexport enum PropertyEditorParamTypes {\r\n  ButtonGroupData = \"UiAbstract-ButtonGroupData\",\r\n  CheckBoxIcons = \"UiAbstract-CheckBoxIcons\",\r\n  Icon = \"UiAbstract-Icon\",\r\n  InputEditorSize = \"UiAbstract-InputEditorSize\",\r\n  ColorData = \"UiAbstract-ColorData\",\r\n  CustomFormattedNumber = \"UiAbstract-CustomFormattedNumber\",\r\n  IconListData = \"UiAbstract-IconListData\",\r\n  // JSON = \"UiAbstract-JSON\",\r\n  MultilineText = \"UiAbstract-MultilineText\",\r\n  Range = \"UiAbstract-Range\",\r\n  Slider = \"UiAbstract-Slider\",\r\n  // SuppressUnitLabel = \"UiAbstract-SuppressUnitLabel\",\r\n  SuppressEditorLabel = \"UiAbstract-SuppressEditorLabel\",\r\n  CheckBoxImages = \"UiAbstract-CheckBoxImages\",\r\n}\r\n\r\n/**\r\n * [[BasePropertyEditorParams]] Base interface for Property Editor Params\r\n * @public\r\n */\r\nexport interface BasePropertyEditorParams {\r\n  type: string;\r\n}\r\n\r\n/**\r\n * Parameters used by PropertyEditors that use HTML <input> element.\r\n * @public\r\n */\r\n/** [[InputEditorSizeParams]] type guard.\r\n * @public\r\n */\r\nexport interface InputEditorSizeParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.InputEditorSize;\r\n  /** Optionally define the width in characters. */\r\n  size?: number;\r\n  /** Optionally define the maximum number of characters allowed. */\r\n  maxLength?: number;\r\n}\r\n\r\n/** InputEditorSizeParams type guard.\r\n * @public\r\n */\r\nexport const isInputEditorSizeParams = (item: BasePropertyEditorParams): item is InputEditorSizeParams => {\r\n  return item.type === PropertyEditorParamTypes.InputEditorSize;\r\n};\r\n\r\n/**\r\n * [[ColorEditorParams]] Parameters used to populate color type editor with a specific set of colors. If not specified the Color\r\n * Editor will show a default palette of 16 colors.\r\n * @public\r\n */\r\nexport interface ColorEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.ColorData;\r\n  /** array of color values to show in color picker popup. Use [[ColorByName]] enum values. Values should be 32-bit integer in the form 0xBBGGRR. */\r\n  colorValues: number[];\r\n  /** number of columns to show in color picker popup. The value of 4 is used if not defined. */\r\n  numColumns?: number;\r\n}\r\n\r\n/** ColorEditorParams type guard.\r\n * @public\r\n */\r\nexport const isColorEditorParams = (item: BasePropertyEditorParams): item is ColorEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.ColorData;\r\n};\r\n\r\n/**\r\n * [[IconListEditorParams]] Parameters used to populate icon type editor with a specific set of icons.\r\n * @public\r\n */\r\nexport interface IconListEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.IconListData;\r\n  /** active icon shown in the button */\r\n  iconValue: string;\r\n  /** array of icon (svg) names to show in icon picker popup. */\r\n  iconValues: string[];\r\n  /** number of columns to show in icon picker popup. The value of 4 is used if not defined. */\r\n  numColumns?: number;\r\n}\r\n\r\n/** IconListEditorParams type guard.\r\n * @public\r\n */\r\nexport const isIconListEditorParams = (item: BasePropertyEditorParams): item is IconListEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.IconListData;\r\n};\r\n\r\n/**\r\n * [[IconDefinition]] Information about an icon displayed next to a property editor.\r\n * @public\r\n */\r\nexport interface IconDefinition {\r\n  /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an SVG symbol, use `svg:` prefix. */\r\n  iconSpec: string;\r\n  /** Function to determine if the item is enabled. */\r\n  isEnabledFunction?: () => boolean;\r\n}\r\n\r\n/**\r\n * [[ButtonGroupEditorParams]] Parameters used by EnumButtonGroupEditor to define icons in button group.\r\n * @public\r\n */\r\nexport interface ButtonGroupEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.ButtonGroupData;\r\n  buttons: IconDefinition[];\r\n}\r\n\r\n/** ButtonGroupEditorParams type guard.\r\n * @public\r\n */\r\nexport const isButtonGroupEditorParams = (item: BasePropertyEditorParams): item is ButtonGroupEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.ButtonGroupData;\r\n};\r\n\r\n/**\r\n * [[SuppressLabelEditorParams]] Parameters used to suppress the label for a type editor in the ToolSettings widget.\r\n * @public\r\n */\r\nexport interface SuppressLabelEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.SuppressEditorLabel;\r\n  /** if false then an empty placeholder label is created. This is sometimes necessary to align editor in proper column */\r\n  suppressLabelPlaceholder?: boolean;\r\n}\r\n\r\n/** SuppressLabelEditorParams type guard.\r\n * @public\r\n */\r\nexport const isSuppressLabelEditorParams = (item: BasePropertyEditorParams): item is SuppressLabelEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.SuppressEditorLabel;\r\n};\r\n\r\n// /**\r\n//  * Parameters used by PropertyEditors that support JSON.\r\n//  * @alpha\r\n//  */\r\n// export interface JsonEditorParams extends BasePropertyEditorParams {\r\n//   type: PropertyEditorParamTypes.JSON;\r\n//   json: any;\r\n// }\r\n\r\n/**\r\n * Parameters used by PropertyEditors that support defining a minimum and maximum value.\r\n * @public\r\n */\r\nexport interface RangeEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Range;\r\n  /** Defines the minimum value. Default is Number.MIN_SAFE_INTEGER. */\r\n  minimum?: number;\r\n  /** Defines the maximum value. Default is Number.MAX_SAFE_INTEGER. */\r\n  maximum?: number;\r\n  /** Defines the step value. Default is 1. */\r\n  step?: number;\r\n  /** Defines the precision. Default is 0. */\r\n  precision?: number;\r\n}\r\n\r\n/**\r\n * Parameters used to indicate that a Slider should be presented for the property\r\n * and to specify the values needed by the slider.\r\n * @public\r\n */\r\nexport interface SliderEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Slider;\r\n  /** Defines the minimum value. */\r\n  minimum: number;\r\n  /** Defines the maximum value. */\r\n  maximum: number;\r\n\r\n  /** Optionally define the width in pixels. */\r\n  size?: number;\r\n\r\n  /** Step value. Default is 0.1. */\r\n  step?: number;\r\n  /** The interaction mode. Default is 1. Possible values:\r\n   * 1 - allows handles to cross each other.\r\n   * 2 - keeps the sliders from crossing and separated by a step.\r\n   */\r\n  mode?: number;\r\n\r\n  /** Indicates whether the display of the Slider values is reversed. */\r\n  reversed?: boolean;\r\n\r\n  /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */\r\n  showTooltip?: boolean;\r\n  /** Indicates whether the tooltip should show below the Slider instead of above. */\r\n  tooltipBelow?: boolean;\r\n  /** Format a value for the tooltip */\r\n  formatTooltip?: (value: number) => string;\r\n\r\n  /** Indicates whether to show min & max values to the left & right of the Slider. */\r\n  showMinMax?: boolean;\r\n  /** Image to show for min. */\r\n  minIconSpec?: string;\r\n  /** Image to show for max. */\r\n  maxIconSpec?: string;\r\n\r\n  /** Indicates whether to show tick marks under the Slider. */\r\n  showTicks?: boolean;\r\n  /** Indicates whether to show tick labels under the tick marks. */\r\n  showTickLabels?: boolean;\r\n  /** Format a tick mark value */\r\n  formatTick?: (tick: number) => string;\r\n  /** Function to get the tick count. The default tick count is 10. */\r\n  getTickCount?: () => number;\r\n  /** Function to get the tick values. This overrides the tick count from getTickCount.\r\n   * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.\r\n   * The numbers should be valid numbers in the domain and correspond to the step value.\r\n   * Invalid values will be coerced to the closet matching value in the domain.\r\n   */\r\n  getTickValues?: () => number[];\r\n}\r\n\r\n/**\r\n * Parameter that is used to indicate that a multiline text editor should be created.\r\n * The number of rows specified will determine the height of the editor control.\r\n * @public\r\n */\r\nexport interface MultilineTextEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.MultilineText;\r\n  rows: number;\r\n}\r\n\r\n/**\r\n * Parameters used to display an icon next to property editor.\r\n * @public\r\n */\r\nexport interface IconEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Icon;\r\n  definition: IconDefinition;\r\n}\r\n\r\n/**\r\n * Parameters for ImageCheckBoxEditor\r\n * @public\r\n */\r\nexport interface ImageCheckBoxParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.CheckBoxImages;\r\n  imageOn: string;\r\n  imageOff: string;\r\n\r\n}\r\n\r\n// /**\r\n//  * Parameter used to suppress Unit labels\r\n//  * @alpha\r\n//  */\r\n// export interface SuppressUnitLabelEditorParams extends BasePropertyEditorParams {\r\n//   type: PropertyEditorParamTypes.SuppressUnitLabel;\r\n// }\r\n\r\n/**\r\n * defines Results of parsing a string input by a user into its desired value type\r\n * @public\r\n */\r\nexport interface ParseResults {\r\n  value?: string | number | boolean | {} | string[] | Date | [] | undefined;\r\n  parseError?: string;\r\n}\r\n\r\n/**\r\n * Parameters used with properties that want to control parsing and formatting.\r\n * @public\r\n */\r\nexport interface CustomFormattedNumberParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.CustomFormattedNumber;\r\n  formatFunction: (numberValue: number) => string;\r\n  parseFunction: (stringValue: string) => ParseResults;\r\n}\r\n\r\n/** CustomFormattedNumberParams type guard.\r\n * @public\r\n */\r\nexport const isCustomFormattedNumberParams = (item: BasePropertyEditorParams): item is CustomFormattedNumberParams => {\r\n  return item.type === PropertyEditorParamTypes.CustomFormattedNumber;\r\n};\r\n\r\n/**\r\n * Type definition for Property Editor params\r\n * @public\r\n */\r\nexport type PropertyEditorParams = BasePropertyEditorParams;\r\n"]}
+{"version":3,"file":"EditorParams.js","sourceRoot":"","sources":["../../../../src/appui-abstract/properties/EditorParams.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAcH;;GAEG;AACH,IAAY,oBAcX;AAdD,WAAY,oBAAoB;IAC9B,+DAAQ,CAAA;IACR,aAAa;IACb,uEAAY,CAAA;IACZ,2BAA2B;IAC3B,6EAAW,CAAA;IACX,cAAc;IACd,uEAAQ,CAAA;IACR,2BAA2B;IAC3B,6EAAW,CAAA;IACX,mBAAmB;IACnB,qFAAe,CAAA;IACf,gCAAgC;IAChC,2FAAkB,CAAA;AACpB,CAAC,EAdW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAc/B;AAED;;GAEG;AACH,IAAY,WASX;AATD,WAAY,WAAW;IACrB,wCAAwC;IACxC,iCAAkB,CAAA;IAClB,iDAAiD;IACjD,qCAAsB,CAAA;IACtB,uBAAuB;IACvB,6BAAc,CAAA;IACd,mCAAmC;IACnC,iCAAkB,CAAA;AACpB,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB;AAED;;;GAGG;AACH,IAAY,wBAeX;AAfD,WAAY,wBAAwB;IAClC,0EAA8C,CAAA;IAC9C,sEAA0C,CAAA;IAC1C,oDAAwB,CAAA;IACxB,0EAA8C,CAAA;IAC9C,8DAAkC,CAAA;IAClC,sFAA0D,CAAA;IAC1D,oEAAwC,CAAA;IACxC,4BAA4B;IAC5B,sEAA0C,CAAA;IAC1C,sDAA0B,CAAA;IAC1B,wDAA4B,CAAA;IAC5B,sDAAsD;IACtD,kFAAsD,CAAA;IACtD,wEAA4C,CAAA;AAC9C,CAAC,EAfW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAenC;AAyBD;;GAEG;AACI,MAAM,uBAAuB,GAAG,CAAC,IAA8B,EAAiC,EAAE;IACvG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,uBAAuB,2BAElC;AAeF;;GAEG;AACI,MAAM,mBAAmB,GAAG,CAAC,IAA8B,EAA6B,EAAE;IAC/F,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,SAAS,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,mBAAmB,uBAE9B;AAgBF;;GAEG;AACI,MAAM,sBAAsB,GAAG,CAAC,IAA8B,EAAgC,EAAE;IACrG,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,YAAY,CAAC;AAC7D,CAAC,CAAC;AAFW,QAAA,sBAAsB,0BAEjC;AAsBF;;GAEG;AACI,MAAM,yBAAyB,GAAG,CAAC,IAA8B,EAAmC,EAAE;IAC3G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,eAAe,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,yBAAyB,6BAEpC;AAYF;;GAEG;AACI,MAAM,2BAA2B,GAAG,CAAC,IAA8B,EAAqC,EAAE;IAC/G,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,mBAAmB,CAAC;AACpE,CAAC,CAAC;AAFW,QAAA,2BAA2B,+BAEtC;AA4IF;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAA8B,EAAuC,EAAE;IACnH,OAAO,IAAI,CAAC,IAAI,KAAK,wBAAwB,CAAC,qBAAqB,CAAC;AACtE,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC","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 Properties\r\n */\r\n\r\n// cspell:ignore BBGGRR pushable DDTHH\r\n\r\n/** Interface used to provide a custom Date Time formatter and optional parser\r\n * for use by `DatePickerPopup`. If a parseData function is not implemented\r\n * then string to date parsing will not be possible when a `DateFormatter` is used.\r\n * @public\r\n */\r\nexport interface DateFormatter {\r\n  formateDate: (day: Date) => string;\r\n  parseDate?: (dateString: string) => Date | undefined;\r\n}\r\n\r\n/** Alternate Data Formats that can be provide by javascript. Can be used by Date TypeConverter and TypeEditor.\r\n * @public\r\n */\r\nexport enum AlternateDateFormats {\r\n  None = 0,\r\n  // YYYY-MM-DD\r\n  IsoShort = 1,\r\n  // YYYY-MM-DDTHH:mm:ss.sssZ\r\n  IsoDateTime,\r\n  // dd Mmm yyyy\r\n  UtcShort,\r\n  // dd Mmm yyyy hh:mm:ss GMT\r\n  UtcDateTime,\r\n  // Www, dd Mmm yyyy\r\n  UtcShortWithDay,\r\n  // Www, dd Mmm yyyy hh:mm:ss GMT\r\n  UtcDateTimeWithDay,\r\n}\r\n\r\n/** Enum that defines supported time formats.\r\n * @public\r\n */\r\nexport enum TimeDisplay {\r\n  // 12 hour with minutes and cycle(AM/PM)\r\n  H12MC = \"hh:mm aa\",\r\n  // 12 hour with minutes, seconds and cycle(AM/PM)\r\n  H12MSC = \"hh:mm:ss aa\",\r\n  // 24 hour with minutes\r\n  H24M = \"hh:mm\",\r\n  // 24 hour with minutes and seconds\r\n  H24MS = \"hh:mm:ss\",\r\n}\r\n\r\n/**\r\n * Enum for Property Editor Param Types\r\n * @public\r\n */\r\nexport enum PropertyEditorParamTypes {\r\n  ButtonGroupData = \"UiAbstract-ButtonGroupData\",\r\n  CheckBoxIcons = \"UiAbstract-CheckBoxIcons\",\r\n  Icon = \"UiAbstract-Icon\",\r\n  InputEditorSize = \"UiAbstract-InputEditorSize\",\r\n  ColorData = \"UiAbstract-ColorData\",\r\n  CustomFormattedNumber = \"UiAbstract-CustomFormattedNumber\",\r\n  IconListData = \"UiAbstract-IconListData\",\r\n  // JSON = \"UiAbstract-JSON\",\r\n  MultilineText = \"UiAbstract-MultilineText\",\r\n  Range = \"UiAbstract-Range\",\r\n  Slider = \"UiAbstract-Slider\",\r\n  // SuppressUnitLabel = \"UiAbstract-SuppressUnitLabel\",\r\n  SuppressEditorLabel = \"UiAbstract-SuppressEditorLabel\",\r\n  CheckBoxImages = \"UiAbstract-CheckBoxImages\",\r\n}\r\n\r\n/**\r\n * [[BasePropertyEditorParams]] Base interface for Property Editor Params\r\n * @public\r\n */\r\nexport interface BasePropertyEditorParams {\r\n  type: string;\r\n}\r\n\r\n/**\r\n * Parameters used by PropertyEditors that use HTML <input> element.\r\n * @public\r\n */\r\n/** [[InputEditorSizeParams]] type guard.\r\n * @public\r\n */\r\nexport interface InputEditorSizeParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.InputEditorSize;\r\n  /** Optionally define the width in characters. */\r\n  size?: number;\r\n  /** Optionally define the maximum number of characters allowed. */\r\n  maxLength?: number;\r\n}\r\n\r\n/** InputEditorSizeParams type guard.\r\n * @public\r\n */\r\nexport const isInputEditorSizeParams = (item: BasePropertyEditorParams): item is InputEditorSizeParams => {\r\n  return item.type === PropertyEditorParamTypes.InputEditorSize;\r\n};\r\n\r\n/**\r\n * [[ColorEditorParams]] Parameters used to populate color type editor with a specific set of colors. If not specified the Color\r\n * Editor will show a default palette of 16 colors.\r\n * @public\r\n */\r\nexport interface ColorEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.ColorData;\r\n  /** array of color values to show in color picker popup. Use [[ColorByName]] enum values. Values should be 32-bit integer in the form 0xBBGGRR. */\r\n  colorValues: number[];\r\n  /** number of columns to show in color picker popup. The value of 4 is used if not defined. */\r\n  numColumns?: number;\r\n}\r\n\r\n/** ColorEditorParams type guard.\r\n * @public\r\n */\r\nexport const isColorEditorParams = (item: BasePropertyEditorParams): item is ColorEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.ColorData;\r\n};\r\n\r\n/**\r\n * [[IconListEditorParams]] Parameters used to populate icon type editor with a specific set of icons.\r\n * @public\r\n */\r\nexport interface IconListEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.IconListData;\r\n  /** active icon shown in the button */\r\n  iconValue: string;\r\n  /** array of icon (svg) names to show in icon picker popup. */\r\n  iconValues: string[];\r\n  /** number of columns to show in icon picker popup. The value of 4 is used if not defined. */\r\n  numColumns?: number;\r\n}\r\n\r\n/** IconListEditorParams type guard.\r\n * @public\r\n */\r\nexport const isIconListEditorParams = (item: BasePropertyEditorParams): item is IconListEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.IconListData;\r\n};\r\n\r\n/**\r\n * [[IconDefinition]] Information about an icon displayed next to a property editor.\r\n * @public\r\n */\r\nexport interface IconDefinition {\r\n  /** Icon specification. The value is the name of an icon WebFont entry, or if specifying an imported SVG symbol use \"webSvg:\" prefix . */\r\n  iconSpec: string;\r\n  /** Function to determine if the item is enabled. */\r\n  isEnabledFunction?: () => boolean;\r\n}\r\n\r\n/**\r\n * [[ButtonGroupEditorParams]] Parameters used by EnumButtonGroupEditor to define icons in button group.\r\n * @public\r\n */\r\nexport interface ButtonGroupEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.ButtonGroupData;\r\n  buttons: IconDefinition[];\r\n}\r\n\r\n/** ButtonGroupEditorParams type guard.\r\n * @public\r\n */\r\nexport const isButtonGroupEditorParams = (item: BasePropertyEditorParams): item is ButtonGroupEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.ButtonGroupData;\r\n};\r\n\r\n/**\r\n * [[SuppressLabelEditorParams]] Parameters used to suppress the label for a type editor in the ToolSettings widget.\r\n * @public\r\n */\r\nexport interface SuppressLabelEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.SuppressEditorLabel;\r\n  /** if false then an empty placeholder label is created. This is sometimes necessary to align editor in proper column */\r\n  suppressLabelPlaceholder?: boolean;\r\n}\r\n\r\n/** SuppressLabelEditorParams type guard.\r\n * @public\r\n */\r\nexport const isSuppressLabelEditorParams = (item: BasePropertyEditorParams): item is SuppressLabelEditorParams => {\r\n  return item.type === PropertyEditorParamTypes.SuppressEditorLabel;\r\n};\r\n\r\n// /**\r\n//  * Parameters used by PropertyEditors that support JSON.\r\n//  * @alpha\r\n//  */\r\n// export interface JsonEditorParams extends BasePropertyEditorParams {\r\n//   type: PropertyEditorParamTypes.JSON;\r\n//   json: any;\r\n// }\r\n\r\n/**\r\n * Parameters used by PropertyEditors that support defining a minimum and maximum value.\r\n * @public\r\n */\r\nexport interface RangeEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Range;\r\n  /** Defines the minimum value. Default is Number.MIN_SAFE_INTEGER. */\r\n  minimum?: number;\r\n  /** Defines the maximum value. Default is Number.MAX_SAFE_INTEGER. */\r\n  maximum?: number;\r\n  /** Defines the step value. Default is 1. */\r\n  step?: number;\r\n  /** Defines the precision. Default is 0. */\r\n  precision?: number;\r\n}\r\n\r\n/**\r\n * Parameters used to indicate that a Slider should be presented for the property\r\n * and to specify the values needed by the slider.\r\n * @public\r\n */\r\nexport interface SliderEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Slider;\r\n  /** Defines the minimum value. */\r\n  minimum: number;\r\n  /** Defines the maximum value. */\r\n  maximum: number;\r\n\r\n  /** Optionally define the width in pixels. */\r\n  size?: number;\r\n\r\n  /** Step value. Default is 0.1. */\r\n  step?: number;\r\n  /** The interaction mode. Default is 1. Possible values:\r\n   * 1 - allows handles to cross each other.\r\n   * 2 - keeps the sliders from crossing and separated by a step.\r\n   */\r\n  mode?: number;\r\n\r\n  /** Indicates whether the display of the Slider values is reversed. */\r\n  reversed?: boolean;\r\n\r\n  /** Indicates whether to show tooltip with the value. The tooltip will be positioned above the Slider, by default. */\r\n  showTooltip?: boolean;\r\n  /** Indicates whether the tooltip should show below the Slider instead of above. */\r\n  tooltipBelow?: boolean;\r\n  /** Format a value for the tooltip */\r\n  formatTooltip?: (value: number) => string;\r\n\r\n  /** Indicates whether to show min & max values to the left & right of the Slider. */\r\n  showMinMax?: boolean;\r\n  /** Image to show for min. */\r\n  minIconSpec?: string;\r\n  /** Image to show for max. */\r\n  maxIconSpec?: string;\r\n\r\n  /** Indicates whether to show tick marks under the Slider. */\r\n  showTicks?: boolean;\r\n  /** Indicates whether to show tick labels under the tick marks. */\r\n  showTickLabels?: boolean;\r\n  /** Format a tick mark value */\r\n  formatTick?: (tick: number) => string;\r\n  /** Function to get the tick count. The default tick count is 10. */\r\n  getTickCount?: () => number;\r\n  /** Function to get the tick values. This overrides the tick count from getTickCount.\r\n   * Use this prop if you want to specify your own tick values instead of ticks generated by the slider.\r\n   * The numbers should be valid numbers in the domain and correspond to the step value.\r\n   * Invalid values will be coerced to the closet matching value in the domain.\r\n   */\r\n  getTickValues?: () => number[];\r\n}\r\n\r\n/**\r\n * Parameter that is used to indicate that a multiline text editor should be created.\r\n * The number of rows specified will determine the height of the editor control.\r\n * @public\r\n */\r\nexport interface MultilineTextEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.MultilineText;\r\n  rows: number;\r\n}\r\n\r\n/**\r\n * Parameters used to display an icon next to property editor.\r\n * @public\r\n */\r\nexport interface IconEditorParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.Icon;\r\n  definition: IconDefinition;\r\n}\r\n\r\n/**\r\n * Parameters for ImageCheckBoxEditor\r\n * @public\r\n */\r\nexport interface ImageCheckBoxParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.CheckBoxImages;\r\n  imageOn: string;\r\n  imageOff: string;\r\n\r\n}\r\n\r\n// /**\r\n//  * Parameter used to suppress Unit labels\r\n//  * @alpha\r\n//  */\r\n// export interface SuppressUnitLabelEditorParams extends BasePropertyEditorParams {\r\n//   type: PropertyEditorParamTypes.SuppressUnitLabel;\r\n// }\r\n\r\n/**\r\n * defines Results of parsing a string input by a user into its desired value type\r\n * @public\r\n */\r\nexport interface ParseResults {\r\n  value?: string | number | boolean | {} | string[] | Date | [] | undefined;\r\n  parseError?: string;\r\n}\r\n\r\n/**\r\n * Parameters used with properties that want to control parsing and formatting.\r\n * @public\r\n */\r\nexport interface CustomFormattedNumberParams extends BasePropertyEditorParams {\r\n  type: PropertyEditorParamTypes.CustomFormattedNumber;\r\n  formatFunction: (numberValue: number) => string;\r\n  parseFunction: (stringValue: string) => ParseResults;\r\n}\r\n\r\n/** CustomFormattedNumberParams type guard.\r\n * @public\r\n */\r\nexport const isCustomFormattedNumberParams = (item: BasePropertyEditorParams): item is CustomFormattedNumberParams => {\r\n  return item.type === PropertyEditorParamTypes.CustomFormattedNumber;\r\n};\r\n\r\n/**\r\n * Type definition for Property Editor params\r\n * @public\r\n */\r\nexport type PropertyEditorParams = BasePropertyEditorParams;\r\n"]}

package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts

@@ -64,7 +64,7 @@ export interface AbstractStatusBarItem extends ProvidedItem {
 export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
     /** method to execute when icon is pressed */
     readonly execute: () => void;
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
     readonly icon?: string | ConditionalStringValue;
     /** Label. */
     readonly label?: string | ConditionalStringValue;
@@ -75,7 +75,7 @@ export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
  * @public
  */
 export interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
     readonly icon?: string | ConditionalStringValue;
     /** Label. */
     readonly label: string | ConditionalStringValue;

package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StatusBarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,OAAO,IAAI;IACX,4CAA4C;IAC5C,IAAI,IAAI;IACR,mCAAmC;IACnC,KAAK,IAAI;IACT,mCAAmC;IACnC,MAAM,IAAI;IACV,sCAAsC;IACtC,SAAS,IAAI;IACb,sCAAsC;IACtC,KAAK,IAAI;IACT,4CAA4C;IAC5C,OAAO,IAAI;CACZ;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,IAAI,IAAA;IACJ,6CAA6C;IAC7C,KAAK,IAAA;CACN;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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,wEAAwE;IACxE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,yBAAyB;IACzB,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,aAAa;IACb,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,2BAA2B,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAEzH;;GAEG;AACH,eAAO,MAAM,6BAA6B,SAAU,mBAAmB,wCAEtE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,SAAU,mBAAmB,uCAErE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,SAAU,mBAAmB,wCAEtE,CAAC;AAEF;;GAEG;AACH,qBAAa,8BAA8B;IACzC,oDAAoD;IACpD,OAAc,gBAAgB,OAAQ,MAAM,WAAW,gBAAgB,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,WAAW,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,mEAAqD,2BAA2B,CAKhR;IAEH,kDAAkD;IAClD,OAAc,eAAe,OAAQ,MAAM,WAAW,gBAAgB,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,kGAA0F,0BAA0B,CAK5R;CACJ"}
+{"version":3,"file":"StatusBarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,OAAO,IAAI;IACX,4CAA4C;IAC5C,IAAI,IAAI;IACR,mCAAmC;IACnC,KAAK,IAAI;IACT,mCAAmC;IACnC,MAAM,IAAI;IACV,sCAAsC;IACtC,SAAS,IAAI;IACb,sCAAsC;IACtC,KAAK,IAAI;IACT,4CAA4C;IAC5C,OAAO,IAAI;CACZ;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,IAAI,IAAA;IACJ,6CAA6C;IAC7C,KAAK,IAAA;CACN;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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,wEAAwE;IACxE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,yBAAyB;IACzB,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,sHAAsH;IACtH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,aAAa;IACb,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE,sHAAsH;IACtH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,2BAA2B,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAEzH;;GAEG;AACH,eAAO,MAAM,6BAA6B,SAAU,mBAAmB,wCAEtE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,SAAU,mBAAmB,uCAErE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,SAAU,mBAAmB,wCAEtE,CAAC;AAEF;;GAEG;AACH,qBAAa,8BAA8B;IACzC,oDAAoD;IACpD,OAAc,gBAAgB,OAAQ,MAAM,WAAW,gBAAgB,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,WAAW,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,mEAAqD,2BAA2B,CAKhR;IAEH,kDAAkD;IAClD,OAAc,eAAe,OAAQ,MAAM,WAAW,gBAAgB,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,kGAA0F,0BAA0B,CAK5R;CACJ"}

package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;GAEG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAe3B;AAED;;GAEG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAoED;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACrE,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;GAEG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACjI,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;GAEG;AACH,MAAa,8BAA8B;;AAA3C,wEAgBC;AAfC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,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 StatusBar\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/** Status bar Groups/Sections from Left to Right\r\n * @public\r\n */\r\nexport enum StatusBarSection {\r\n  /** area for tool assistance and messages */\r\n  Message = 0,\r\n  /** area for tool assistance and messages */\r\n  Left = 0,\r\n  /** items specific to stage/task */\r\n  Stage = 1,\r\n  /** items specific to stage/task */\r\n  Center = 1,\r\n  /** Select scope and selection info */\r\n  Selection = 2,\r\n  /** Select scope and selection info */\r\n  Right = 2,\r\n  /** items that only show based on context */\r\n  Context = 3,\r\n}\r\n\r\n/** Defines which side of Icon where label is placed\r\n * @public\r\n */\r\nexport enum StatusBarLabelSide {\r\n  /** Label is placed left side of icon. This is the default if not specified */\r\n  Left,\r\n  /** Label is placed on right side of icon. */\r\n  Right,\r\n}\r\n\r\n/** Type for StatusBar Item Id\r\n * @public\r\n */\r\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"];\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarItem extends ProvidedItem {\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Required unique id of 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  /** 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  /** Priority within a section (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** status bar section */\r\n  readonly section: StatusBarSection;\r\n}\r\n\r\n/** Describes the data needed to insert an action item into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem {\r\n  /** method to execute when icon is pressed */\r\n  readonly execute: () => void;\r\n  /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Label. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {\r\n  /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Defines which side of icon to display label if icon is defined. */\r\n  readonly labelSide?: StatusBarLabelSide;\r\n}\r\n\r\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\r\n *  implementer to create a framework specific component.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {\r\n  readonly isCustom: true;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @public\r\n */\r\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;\r\n\r\n/** AbstractStatusBarActionItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => {\r\n  return (item as AbstractStatusBarActionItem).execute !== undefined;\r\n};\r\n\r\n/** AbstractStatusBarLabelItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => {\r\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined;\r\n};\r\n\r\n/** AbstractStatusBarCustomItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => {\r\n  return !!(item as AbstractStatusBarCustomItem).isCustom;\r\n};\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @public\r\n */\r\nexport class AbstractStatusBarItemUtilities {\r\n  /** Creates a StatusBar item to perform an action */\r\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({\r\n    id, section, itemPriority,\r\n    icon, tooltip,\r\n    execute,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates a StatusBar item to display a label */\r\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({\r\n    id, section, itemPriority,\r\n    icon, label,\r\n    labelSide,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}
+{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;GAEG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAe3B;AAED;;GAEG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAoED;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACrE,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;GAEG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACjI,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;GAEG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;GAEG;AACH,MAAa,8BAA8B;;AAA3C,wEAgBC;AAfC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,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 StatusBar\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/** Status bar Groups/Sections from Left to Right\r\n * @public\r\n */\r\nexport enum StatusBarSection {\r\n  /** area for tool assistance and messages */\r\n  Message = 0,\r\n  /** area for tool assistance and messages */\r\n  Left = 0,\r\n  /** items specific to stage/task */\r\n  Stage = 1,\r\n  /** items specific to stage/task */\r\n  Center = 1,\r\n  /** Select scope and selection info */\r\n  Selection = 2,\r\n  /** Select scope and selection info */\r\n  Right = 2,\r\n  /** items that only show based on context */\r\n  Context = 3,\r\n}\r\n\r\n/** Defines which side of Icon where label is placed\r\n * @public\r\n */\r\nexport enum StatusBarLabelSide {\r\n  /** Label is placed left side of icon. This is the default if not specified */\r\n  Left,\r\n  /** Label is placed on right side of icon. */\r\n  Right,\r\n}\r\n\r\n/** Type for StatusBar Item Id\r\n * @public\r\n */\r\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"];\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarItem extends ProvidedItem {\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Required unique id of 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  /** 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  /** Priority within a section (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** status bar section */\r\n  readonly section: StatusBarSection;\r\n}\r\n\r\n/** Describes the data needed to insert an action item into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem {\r\n  /** method to execute when icon is pressed */\r\n  readonly execute: () => void;\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. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {\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. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Defines which side of icon to display label if icon is defined. */\r\n  readonly labelSide?: StatusBarLabelSide;\r\n}\r\n\r\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\r\n *  implementer to create a framework specific component.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {\r\n  readonly isCustom: true;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @public\r\n */\r\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;\r\n\r\n/** AbstractStatusBarActionItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => {\r\n  return (item as AbstractStatusBarActionItem).execute !== undefined;\r\n};\r\n\r\n/** AbstractStatusBarLabelItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => {\r\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined;\r\n};\r\n\r\n/** AbstractStatusBarCustomItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => {\r\n  return !!(item as AbstractStatusBarCustomItem).isCustom;\r\n};\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @public\r\n */\r\nexport class AbstractStatusBarItemUtilities {\r\n  /** Creates a StatusBar item to perform an action */\r\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({\r\n    id, section, itemPriority,\r\n    icon, tooltip,\r\n    execute,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates a StatusBar item to display a label */\r\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({\r\n    id, section, itemPriority,\r\n    icon, label,\r\n    labelSide,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}

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

@@ -62,7 +62,7 @@ export interface ToolbarItem extends ProvidedItem {
  * @public
  */
 export interface ActionButton extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** 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;
@@ -73,7 +73,7 @@ export interface ActionButton extends ToolbarItem {
  * @public
  */
 export interface GroupButton extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** 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;
@@ -86,7 +86,7 @@ export interface GroupButton extends ToolbarItem {
  * @public
  */
 export interface CustomButtonDefinition extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
+    /** 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;

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

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;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,WAAY,SAAQ,YAAY;IAC/C,8DAA8D;IAC9D,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,8CAA8C;IAC9C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,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,YAAY,GAAG,WAAW,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,sBAAsB,CAAC;AAEpF;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAEpD;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,+BAA+B;IAC/B,OAAc,kBAAkB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,oDAAsC,YAAY,CAKvN;IAEH,6BAA6B;IAC7B,OAAc,iBAAiB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,SAAS,cAAc,YAAY,GAAG,WAAW,CAAC,mDAAqC,WAAW,CAKjP;IAEH,+BAA+B;WACjB,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,YAAY;IAI3E,8BAA8B;WAChB,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,WAAW;IAIzE,yCAAyC;WAC3B,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,sBAAsB;CAG1F"}
+{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;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,WAAY,SAAQ,YAAY;IAC/C,8DAA8D;IAC9D,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,8CAA8C;IAC9C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,sHAAsH;IACtH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,qHAAqH;IACrH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,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,YAAY,GAAG,WAAW,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,sBAAsB,CAAC;AAEpF;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAEpD;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,+BAA+B;IAC/B,OAAc,kBAAkB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,oDAAsC,YAAY,CAKvN;IAEH,6BAA6B;IAC7B,OAAc,iBAAiB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,SAAS,cAAc,YAAY,GAAG,WAAW,CAAC,mDAAqC,WAAW,CAKjP;IAEH,+BAA+B;WACjB,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,YAAY;IAI3E,8BAA8B;WAChB,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,WAAW;IAIzE,yCAAyC;WAC3B,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,sBAAsB;CAG1F"}

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;;GAEG;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;;GAEG;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;AAsFD;;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,6BAA6B;AACf,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 * @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 ToolbarItem extends ProvidedItem {\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 SVG symbol added by plug on use \"svg:\" 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 SVG symbol added by plug on use \"svg:\" 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>;\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 SVG symbol added by plug on use \"svg:\" 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 * @public\r\n */\r\nexport type ToolbarItemId = CommonToolbarItem[\"id\"];\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"]}
+{"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;GAEG;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;;GAEG;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;AAsFD;;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,6BAA6B;AACf,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 * @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 ToolbarItem extends ProvidedItem {\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>;\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 * @public\r\n */\r\nexport type ToolbarItemId = CommonToolbarItem[\"id\"];\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/utils/IconSpecUtilities.d.ts

@@ -5,11 +5,26 @@
  * @public
  */
 export declare class IconSpecUtilities {
-    /** Prefix for an SVG IconSpec */
+    /** Prefix for an SVG IconSpec loaded with the Sprite loader */
     static readonly SVG_PREFIX = "svg:";
-    /** Create an IconSpec for an SVG */
+    static readonly WEB_COMPONENT_PREFIX = "webSvg:";
+    /** Create an IconSpec for an SVG loaded into web component with sprite loader
+     * This method is deprecated --  use createWebComponentIconSpec()
+     * @public @deprecated
+    */
     static createSvgIconSpec(svgSrc: string): string;
-    /** Get the SVG Source from an IconSpec */
+    /** Create an IconSpec for an SVG loaded into web component with svg-loader
+     * @public
+    */
+    static createWebComponentIconSpec(srcString: string): string;
+    /** Get the SVG Source from an sprite IconSpec
+     * This method is deprecated -- use getWebComponentSource()
+     * @public @deprecated
+    */
     static getSvgSource(iconSpec: string): string | undefined;
+    /** Get the SVG Source from an svg-loader IconSpec
+     * @public
+    */
+    static getWebComponentSource(iconSpec: string): string | undefined;
 }
 //# sourceMappingURL=IconSpecUtilities.d.ts.map

package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IconSpecUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,iCAAiC;IACjC,gBAAuB,UAAU,UAAU;IAE3C,oCAAoC;WACtB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAIvD,0CAA0C;WAC5B,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAOjE"}
+{"version":3,"file":"IconSpecUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,+DAA+D;IAC/D,gBAAuB,UAAU,UAAU;IAC3C,gBAAuB,oBAAoB,aAAa;IAExD;;;MAGE;WACY,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAGvD;;MAEE;WACY,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAInE;;;MAGE;WACY,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAOhE;;MAEE;WAEY,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAQ1E"}

package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js

@@ -12,19 +12,41 @@ exports.IconSpecUtilities = void 0;
  * @public
  */
 class IconSpecUtilities {
-    /** Create an IconSpec for an SVG */
+    /** Create an IconSpec for an SVG loaded into web component with sprite loader
+     * This method is deprecated --  use createWebComponentIconSpec()
+     * @public @deprecated
+    */
     static createSvgIconSpec(svgSrc) {
         return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;
     }
-    /** Get the SVG Source from an IconSpec */
+    /** Create an IconSpec for an SVG loaded into web component with svg-loader
+     * @public
+    */
+    static createWebComponentIconSpec(srcString) {
+        return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;
+    }
+    /** Get the SVG Source from an sprite IconSpec
+     * This method is deprecated -- use getWebComponentSource()
+     * @public @deprecated
+    */
     static getSvgSource(iconSpec) {
         if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {
             return iconSpec.slice(4);
         }
         return undefined;
     }
+    /** Get the SVG Source from an svg-loader IconSpec
+     * @public
+    */
+    static getWebComponentSource(iconSpec) {
+        if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {
+            return iconSpec.slice(7);
+        }
+        return undefined;
+    }
 }
 exports.IconSpecUtilities = IconSpecUtilities;
-/** Prefix for an SVG IconSpec */
+/** Prefix for an SVG IconSpec loaded with the Sprite loader */
 IconSpecUtilities.SVG_PREFIX = "svg:";
+IconSpecUtilities.WEB_COMPONENT_PREFIX = "webSvg:";
 //# sourceMappingURL=IconSpecUtilities.js.map

package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,MAAa,iBAAiB;IAI5B,oCAAoC;IAC7B,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;;AAhBH,8CAiBC;AAhBC,iCAAiC;AACV,4BAAU,GAAG,MAAM,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 Utilities\r\n */\r\n\r\n/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\r\n * @public\r\n */\r\nexport class IconSpecUtilities {\r\n  /** Prefix for an SVG IconSpec */\r\n  public static readonly SVG_PREFIX = \"svg:\";\r\n\r\n  /** Create an IconSpec for an SVG */\r\n  public static createSvgIconSpec(svgSrc: string): string {\r\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\r\n  }\r\n\r\n  /** Get the SVG Source from an IconSpec */\r\n  public static getSvgSource(iconSpec: string): string | undefined {\r\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\r\n      return iconSpec.slice(4);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,MAAa,iBAAiB;IAK5B;;;MAGE;IACK,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IACD;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;;MAGE;IACK,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AAzCH,8CA0CC;AAzCC,+DAA+D;AACxC,4BAAU,GAAG,MAAM,CAAC;AACpB,sCAAoB,GAAG,SAAS,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 Utilities\r\n */\r\n\r\n/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\r\n * @public\r\n */\r\nexport class IconSpecUtilities {\r\n  /** Prefix for an SVG IconSpec loaded with the Sprite loader */\r\n  public static readonly SVG_PREFIX = \"svg:\";\r\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\r\n\r\n  /** Create an IconSpec for an SVG loaded into web component with sprite loader\r\n   * This method is deprecated --  use createWebComponentIconSpec()\r\n   * @public @deprecated\r\n  */\r\n  public static createSvgIconSpec(svgSrc: string): string {\r\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\r\n  }\r\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\r\n   * @public\r\n  */\r\n  public static createWebComponentIconSpec(srcString: string): string {\r\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\r\n  }\r\n\r\n  /** Get the SVG Source from an sprite IconSpec\r\n   * This method is deprecated -- use getWebComponentSource()\r\n   * @public @deprecated\r\n  */\r\n  public static getSvgSource(iconSpec: string): string | undefined {\r\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\r\n      return iconSpec.slice(4);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n  /** Get the SVG Source from an svg-loader IconSpec\r\n   * @public\r\n  */\r\n\r\n  public static getWebComponentSource(iconSpec: string): string | undefined {\r\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\r\n      return iconSpec.slice(7);\r\n    }\r\n\r\n    return undefined;\r\n\r\n  }\r\n}\r\n"]}