@itwin/appui-abstract 3.2.0-dev.3 → 3.2.0-dev.30

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"]}

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts

@@ -11,7 +11,7 @@ import { WidgetState } from "./WidgetState";
 export interface AbstractWidgetProps extends ProvidedItem {
     /** Gets the widget content */
     readonly getWidgetContent: () => any;
-    /** 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;
     /** Id used to uniquely identify the widget.
      * @note It is recommended to provide unique widget id to correctly save/restore App layout.
@@ -35,14 +35,14 @@ export interface AbstractWidgetProps extends ProvidedItem {
     readonly isStatusBar?: boolean;
     /** Indicates whether this Widget should fill the available space in the Zone. */
     readonly fillZone?: boolean;
-    /** Indicates if widget can be popped out to a child window. */
+    /** Indicates if widget can be popped out to a child window. Defaults to false. */
     readonly canPopout?: boolean;
-    /** If the widget state is changed to `floating` and the floatingContainerId is defined then the widget will be added to a
-     * floating panel by that name. If no name is specified the current practice of using a GUID is used. */
+    /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a
+     * floating panel by that name. If no name is specified, a GUID is used. */
     readonly floatingContainerId?: string;
-    /** Indicates if widget can be in floating state. */
+    /** Indicates if widget can be in floating state, default to true. */
     readonly isFloatingStateSupported?: boolean;
-    /** Indicates if floating widget is resizable. */
+    /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */
     readonly isFloatingStateWindowResizable?: boolean;
     /** Defines that default Top Left position when widget is floated via API calls */
     readonly defaultFloatingPosition?: {
@@ -65,5 +65,12 @@ export interface AbstractWidgetProps extends ProvidedItem {
      * @note Return true if the state is restored or the Widget will remount.
      */
     readonly restoreTransientState?: () => boolean;
+    /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.
+     * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element
+     * internally. */
+    defaultFloatingSize?: {
+        width: number;
+        height: number;
+    };
 }
 //# sourceMappingURL=AbstractWidgetProps.d.ts.map

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8BAA8B;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC;IACrC,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC;IACpC,2KAA2K;IAC3K,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,qIAAqI;IACrI,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;4GACwG;IACxG,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,oDAAoD;IACpD,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,iDAAiD;IACjD,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,gHAAgH;IAChH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;IACnE,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,qDAAqD;IACrD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC;CAChD"}
+{"version":3,"file":"AbstractWidgetProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8BAA8B;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC;IACrC,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC;IACpC,2KAA2K;IAC3K,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,qIAAqI;IACrI,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;+EAC2E;IAC3E,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,qEAAqE;IACrE,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,8GAA8G;IAC9G,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,gHAAgH;IAChH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;IACnE,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,qDAAqD;IACrD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC;IAC/C;;qBAEiB;IACjB,mBAAmB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACzD"}

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.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 Widget\r\n */\r\n\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\nimport { WidgetState } from \"./WidgetState\";\r\n\r\n/** Properties for a Widget.\r\n * @public\r\n */\r\nexport interface AbstractWidgetProps extends ProvidedItem {\r\n  /** Gets the widget content */\r\n  readonly getWidgetContent: () => any;\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  /** Id used to uniquely identify the widget.\r\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\r\n   */\r\n  readonly id?: string;\r\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\r\n  readonly defaultState?: WidgetState;\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  readonly label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false. @deprecated */\r\n  readonly isFreeform?: boolean;\r\n  /** Application data attached to the Widget. */\r\n  readonly applicationData?: any;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Indicates whether this Widget is for the Tool Settings. */\r\n  readonly isToolSettings?: boolean;\r\n  /** Indicates whether this Widget is for the Status Bar. */\r\n  readonly isStatusBar?: boolean;\r\n  /** Indicates whether this Widget should fill the available space in the Zone. */\r\n  readonly fillZone?: boolean;\r\n  /** Indicates if widget can be popped out to a child window. */\r\n  readonly canPopout?: boolean;\r\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined then the widget will be added to a\r\n   * floating panel by that name. If no name is specified the current practice of using a GUID is used. */\r\n  readonly floatingContainerId?: string;\r\n  /** Indicates if widget can be in floating state. */\r\n  readonly isFloatingStateSupported?: boolean;\r\n  /** Indicates if floating widget is resizable. */\r\n  readonly isFloatingStateWindowResizable?: boolean;\r\n  /** Defines that default Top Left position when widget is floated via API calls */\r\n  readonly defaultFloatingPosition?: { x: number, y: number };\r\n  /** Widget priority */\r\n  readonly priority?: number;\r\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\r\n  readonly syncEventIds?: string[];\r\n  /** Function executed to determine the state of the widget. */\r\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;\r\n  /** Badge to be overlaid on the widget tab. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Handler for widget state changed event */\r\n  readonly onWidgetStateChanged?: () => void;\r\n  /** Save transient DOM state (i.e. scroll offset). */\r\n  readonly saveTransientState?: () => void;\r\n  /** Restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  readonly restoreTransientState?: () => boolean;\r\n}\r\n"]}
+{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.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 Widget\r\n */\r\n\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\nimport { WidgetState } from \"./WidgetState\";\r\n\r\n/** Properties for a Widget.\r\n * @public\r\n */\r\nexport interface AbstractWidgetProps extends ProvidedItem {\r\n  /** Gets the widget content */\r\n  readonly getWidgetContent: () => any;\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  /** Id used to uniquely identify the widget.\r\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\r\n   */\r\n  readonly id?: string;\r\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\r\n  readonly defaultState?: WidgetState;\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  readonly label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false. @deprecated */\r\n  readonly isFreeform?: boolean;\r\n  /** Application data attached to the Widget. */\r\n  readonly applicationData?: any;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Indicates whether this Widget is for the Tool Settings. */\r\n  readonly isToolSettings?: boolean;\r\n  /** Indicates whether this Widget is for the Status Bar. */\r\n  readonly isStatusBar?: boolean;\r\n  /** Indicates whether this Widget should fill the available space in the Zone. */\r\n  readonly fillZone?: boolean;\r\n  /** Indicates if widget can be popped out to a child window. Defaults to false. */\r\n  readonly canPopout?: boolean;\r\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined, the widget will be added to a\r\n   * floating panel by that name. If no name is specified, a GUID is used. */\r\n  readonly floatingContainerId?: string;\r\n  /** Indicates if widget can be in floating state, default to true. */\r\n  readonly isFloatingStateSupported?: boolean;\r\n  /** Indicates if floating widget is resizable, defaults to false which caused the widget to be auto-sized.. */\r\n  readonly isFloatingStateWindowResizable?: boolean;\r\n  /** Defines that default Top Left position when widget is floated via API calls */\r\n  readonly defaultFloatingPosition?: { x: number, y: number };\r\n  /** Widget priority */\r\n  readonly priority?: number;\r\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\r\n  readonly syncEventIds?: string[];\r\n  /** Function executed to determine the state of the widget. */\r\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;\r\n  /** Badge to be overlaid on the widget tab. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Handler for widget state changed event */\r\n  readonly onWidgetStateChanged?: () => void;\r\n  /** Save transient DOM state (i.e. scroll offset). */\r\n  readonly saveTransientState?: () => void;\r\n  /** Restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  readonly restoreTransientState?: () => boolean;\r\n  /** Optional default size to use when floating a widget. If not specified then the default is to size to content if possible.\r\n   * Certain widget can't be intrinsically sized and must specify a content. These are typically ones that use a canvas element\r\n   * internally. */\r\n  defaultFloatingSize?: { width: number, height: number };\r\n}\r\n"]}

package/lib/cjs/appui-abstract/widget/StagePanel.d.ts

@@ -26,6 +26,7 @@ export declare enum StagePanelLocation {
  */
 export declare enum StagePanelSection {
     Start = 0,
+    /** @deprecated - all widgets that a targeted for Middle will be placed in `End` section */
     Middle = 1,
     End = 2
 }

package/lib/cjs/appui-abstract/widget/StagePanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,UAAU,MAAA;CACX;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}
+{"version":3,"file":"StagePanel.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,UAAU,IAAI;IACd,WAAW,IAAI;IACf,UAAU,IAAI;IACd,WAAW,IAAI;CAChB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,GAAG,MAAM;IACT,OAAO,MAAA;IACP,IAAI,MAAA;IACJ,KAAK,MAAA;IACL,MAAM,MAAA;IACN,UAAU,MAAA;CACX;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,IAAA;IACL,2FAA2F;IAC3F,MAAM,IAAA;IACN,GAAG,IAAA;CACJ"}

package/lib/cjs/appui-abstract/widget/StagePanel.js

@@ -36,6 +36,7 @@ var StagePanelLocation;
 var StagePanelSection;
 (function (StagePanelSection) {
     StagePanelSection[StagePanelSection["Start"] = 0] = "Start";
+    /** @deprecated - all widgets that a targeted for Middle will be placed in `End` section */
     StagePanelSection[StagePanelSection["Middle"] = 1] = "Middle";
     StagePanelSection[StagePanelSection["End"] = 2] = "End";
 })(StagePanelSection = exports.StagePanelSection || (exports.StagePanelSection = {}));

package/lib/cjs/appui-abstract/widget/StagePanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,yEAAU,CAAA;AACZ,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAED;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B","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 Widget\r\n */\r\n\r\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\r\n * @public @deprecated\r\n */\r\nexport enum AbstractZoneLocation {\r\n  CenterLeft = 4,\r\n  CenterRight = 6,\r\n  BottomLeft = 7,\r\n  BottomRight = 9,\r\n}\r\n\r\n/** Available Stage Panel locations.\r\n * @public\r\n */\r\nexport enum StagePanelLocation {\r\n  Top = 101,\r\n  TopMost,\r\n  Left,\r\n  Right,\r\n  Bottom,\r\n  BottomMost,\r\n}\r\n\r\n/** Enum for Stage Panel Sections\r\n * @public\r\n */\r\nexport enum StagePanelSection {\r\n  Start,\r\n  Middle,\r\n  End,\r\n}\r\n"]}
+{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,yEAAU,CAAA;AACZ,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAED;;GAEG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,2FAA2F;IAC3F,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B","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 Widget\r\n */\r\n\r\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\r\n * @public @deprecated\r\n */\r\nexport enum AbstractZoneLocation {\r\n  CenterLeft = 4,\r\n  CenterRight = 6,\r\n  BottomLeft = 7,\r\n  BottomRight = 9,\r\n}\r\n\r\n/** Available Stage Panel locations.\r\n * @public\r\n */\r\nexport enum StagePanelLocation {\r\n  Top = 101,\r\n  TopMost,\r\n  Left,\r\n  Right,\r\n  Bottom,\r\n  BottomMost,\r\n}\r\n\r\n/** Enum for Stage Panel Sections\r\n * @public\r\n */\r\nexport enum StagePanelSection {\r\n  Start,\r\n  /** @deprecated - all widgets that a targeted for Middle will be placed in `End` section */\r\n  Middle,\r\n  End,\r\n}\r\n"]}

package/lib/esm/appui-abstract/UiItemsManager.d.ts

@@ -8,7 +8,7 @@ import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/
 import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
 import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
 /** Action taken by the application on item provided by a UiItemsProvider
- * @public
+ * @public @deprecated this was only used by the previously removed UiItemsArbiter.
  */
 export declare enum UiItemsApplicationAction {
     /** Allow the change to the item */
@@ -44,8 +44,8 @@ export interface UiItemsProvider {
  */
 export declare class BaseUiItemsProvider implements UiItemsProvider {
     protected _providerId: string;
-    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined;
-    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined);
+    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => boolean) | undefined;
+    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => boolean) | undefined);
     get id(): string;
     onUnregister(): void;
     unregister(): void;

package/lib/esm/appui-abstract/UiItemsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AACtD,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;AAIlG;;GAEG;AACH,oBAAY,wBAAwB;IAClC,mCAAmC;IACnC,KAAK,IAAA;IACL,sCAAsC;IACtC,QAAQ,IAAA;IACR,wCAAwC;IACxC,MAAM,IAAA;CACP;AAED;;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;AAED;;;;GAIG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO7C,SAAS,CAAC,WAAW,EAAE,MAAM;IAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,KAAK,OAAO;gBAAnH,WAAW,EAAE,MAAM,EAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,KAAK,OAAO,aAAA;IAEzI,IAAW,EAAE,IAAI,MAAM,CAA6B;IAC7C,YAAY,IAAI,IAAI;IAEpB,UAAU;IAIjB,oEAAoE;IAC7D,qBAAqB,IAAI,aAAa,EAAE;IAIxC,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAGxL,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAY3K,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAGhH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAYrG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAItK,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAClH,aAAa,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAWhG;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAoE;IAE9G;mBACe;WACD,iBAAiB;IAI/B,wEAAwE;IACxE,gBAAuB,2BAA2B,eAAoB,iCAAiC,KAAK,IAAI,EAAI;IAEpH,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI;IAWzD,8EAA8E;WAChE,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAcpD;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EACjG,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAgBlF;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAgB/G;;OAEG;WACW,iBAAiB,IAAI,aAAa,EAAE;IAgBlD;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAgBtN"}
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AACtD,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;AAIlG;;GAEG;AACH,oBAAY,wBAAwB;IAClC,mCAAmC;IACnC,KAAK,IAAA;IACL,sCAAsC;IACtC,QAAQ,IAAA;IACR,wCAAwC;IACxC,MAAM,IAAA;CACP;AAED;;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;AAED;;;;GAIG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO7C,SAAS,CAAC,WAAW,EAAE,MAAM;IAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,6CAAiC,OAAO;gBAA/I,WAAW,EAAE,MAAM,EAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,6CAAiC,OAAO,aAAA;IAErK,IAAW,EAAE,IAAI,MAAM,CAA6B;IAC7C,YAAY,IAAI,IAAI;IAEpB,UAAU;IAIjB,oEAAoE;IAC7D,qBAAqB,IAAI,aAAa,EAAE;IAIxC,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAGxL,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAY3K,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAGhH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAYrG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAItK,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAClH,aAAa,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAWhG;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAoE;IAE9G;mBACe;WACD,iBAAiB;IAI/B,wEAAwE;IACxE,gBAAuB,2BAA2B,eAAoB,iCAAiC,KAAK,IAAI,EAAI;IAEpH,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI;IAWzD,8EAA8E;WAChE,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAcpD;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EACjG,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAgBlF;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAgB/G;;OAEG;WACW,iBAAiB,IAAI,aAAa,EAAE;IAgBlD;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAgBtN"}

package/lib/esm/appui-abstract/UiItemsManager.js

@@ -10,7 +10,7 @@ import { BeEvent, Logger } from "@itwin/core-bentley";
 import { loggerCategory } from "./utils/misc";
 import { StageUsage } from "./items/StageUsage";
 /** Action taken by the application on item provided by a UiItemsProvider
- * @public
+ * @public @deprecated this was only used by the previously removed UiItemsArbiter.
  */
 export var UiItemsApplicationAction;
 (function (UiItemsApplicationAction) {
@@ -52,7 +52,7 @@ export class BaseUiItemsProvider {
     provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
         let provideToStage = false;
         if (this.isSupportedStage) {
-            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
         }
         else {
             provideToStage = (stageUsage === StageUsage.General);
@@ -65,7 +65,7 @@ export class BaseUiItemsProvider {
     provideStatusBarItems(stageId, stageUsage, stageAppData) {
         let provideToStage = false;
         if (this.isSupportedStage) {
-            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
         }
         else {
             provideToStage = (stageUsage === StageUsage.General);
@@ -78,7 +78,7 @@ export class BaseUiItemsProvider {
     provideWidgets(stageId, stageUsage, location, section, _zoneLocation, stageAppData) {
         let provideToStage = false;
         if (this.isSupportedStage) {
-            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
         }
         else {
             provideToStage = (stageUsage === StageUsage.General);

package/lib/esm/appui-abstract/UiItemsManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAMtD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AAwBD;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;;OAKG;IACH,YAAsB,WAAmB,EAAS,gBAAuF;QAAnH,gBAAW,GAAX,WAAW,CAAQ;QAAS,qBAAgB,GAAhB,gBAAgB,CAAuE;IAAI,CAAC;IAE9I,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,YAAY,KAAW,CAAC;IAExB,UAAU;QACf,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED,oEAAoE;IAC7D,qBAAqB;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,iCAAiC,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAA2B,EAAE,mBAAuC,EAAE,aAAmB;QACvK,OAAO,EAAE,CAAC;IACZ,CAAC;IACM,yBAAyB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EAAE,kBAAsC,EAAE,YAAkB;QAC1J,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SAC3E;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3I,CAAC;IAEM,6BAA6B,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;QAC7F,OAAO,EAAE,CAAC;IACZ,CAAC;IACM,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QAClF,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SAC3E;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,CAAC;IAEM,sBAAsB,CAAC,QAAgB,EAAE,WAAmB,EAAE,SAA6B,EAAE,QAA4B,EAAE,aAAmB;QACnJ,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,cAAc,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAClH,aAAoC,EAAE,YAAkB;QACxD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SAC3E;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjH,CAAC;CACF;AASD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B;QAChD,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YACpD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,CAAC,EAAE,qBAAqB,CAAC,CAAC;SAC9F;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YAC1E,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC;YAElF,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAuC,CAAC,CAAC;SACxG;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAEnF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,EAAE;gBACxC,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aACnG;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE;gBACpC,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aACxG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE;gBACpC,UAAU,CAAC,qBAAqB,EAAE;qBAC/B,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aAClG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,EAAE;gBAC7B,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aACrG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AAtJc,0CAA2B,GAAiC,IAAI,GAAG,EAA2B,CAAC;AAQ9G,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\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\nimport { loggerCategory } from \"./utils/misc\";\r\nimport { StageUsage } from \"./items/StageUsage\";\r\n\r\n/** Action taken by the application on item provided by a UiItemsProvider\r\n * @public\r\n */\r\nexport enum UiItemsApplicationAction {\r\n  /** Allow the change to the item */\r\n  Allow,\r\n  /** Disallow the change to the item */\r\n  Disallow,\r\n  /** Update the item during the change */\r\n  Update,\r\n}\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\r\n/**\r\n * Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the\r\n * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.\r\n * @public\r\n */\r\nexport class BaseUiItemsProvider implements UiItemsProvider {\r\n  /*\r\n   * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want\r\n   * to set up custom stage with their own subset of standard tools.\r\n   * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\r\n   * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\r\n   */\r\n  constructor(protected _providerId: string, public isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean) { }\r\n\r\n  public get id(): string { return this._providerId; }\r\n  public onUnregister(): void { }\r\n\r\n  public unregister() {\r\n    UiItemsManager.unregister(this._providerId);\r\n  }\r\n\r\n  /** Backstage items are not stage specific so no callback is used */\r\n  public provideBackstageItems(): BackstageItem[] {\r\n    return [];\r\n  }\r\n\r\n  public provideToolbarButtonItemsInternal(_stageId: string, _stageUsage: string, _toolbarUsage: ToolbarUsage, _toolbarOrientation: ToolbarOrientation, _stageAppData?: any): CommonToolbarItem[] {\r\n    return [];\r\n  }\r\n  public provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideToolbarButtonItemsInternal(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) : [];\r\n  }\r\n\r\n  public provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[] {\r\n    return [];\r\n  }\r\n  public provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideStatusBarItemsInternal(stageId, stageUsage, stageAppData) : [];\r\n  }\r\n\r\n  public provideWidgetsInternal(_stageId: string, _stageUsage: string, _location: StagePanelLocation, _section?: StagePanelSection, _stageAppData?: any): AbstractWidgetProps[] {\r\n    return [];\r\n  }\r\n\r\n  public provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection,\r\n    _zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideWidgetsInternal(stageId, stageUsage, location, section, stageAppData) : [];\r\n  }\r\n}\r\n\r\n/** UIProvider Registered Event Args interface.\r\n * @public\r\n */\r\nexport interface UiItemProviderRegisteredEventArgs {\r\n  providerId: string;\r\n}\r\n\r\n/**\r\n * Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemsProvider> = new Map<string, UiItemsProvider>();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\r\n    UiItemsManager._registeredUiItemsProviders.clear();\r\n  }\r\n\r\n  /** Event raised any time a UiProvider is registered or unregistered. */\r\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds() {\r\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n    return ids;\r\n  }\r\n\r\n  /** Return true if there is any registered UiProvider. */\r\n  public static get hasRegisteredProviders(): boolean {\r\n    return this._registeredUiItemsProviders.size > 0;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a previously loaded UiItemsProvider.\r\n   * @param providerId id of the UiItemsProvider to get\r\n   */\r\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n    return UiItemsManager._registeredUiItemsProviders.get(providerId);\r\n  }\r\n\r\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\r\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\r\n  }\r\n\r\n  /**\r\n   * Registers a UiItemsProvider with the UiItemsManager.\r\n   * @param uiProvider the UI items provider to register.\r\n   */\r\n  public static register(uiProvider: UiItemsProvider): void {\r\n    if (UiItemsManager.getUiItemsProvider(uiProvider.id)) {\r\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProvider.id}) is already loaded`);\r\n    } else {\r\n      UiItemsManager._registeredUiItemsProviders.set(uiProvider.id, uiProvider);\r\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProvider.id}) loaded`);\r\n\r\n      UiItemsManager.sendRegisteredEvent({ providerId: uiProvider.id } as UiItemProviderRegisteredEventArgs);\r\n    }\r\n  }\r\n\r\n  /** Remove a specific UiItemsProvider from the list of available providers. */\r\n  public static unregister(uiProviderId: string): void {\r\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\r\n    if (!provider)\r\n      return;\r\n\r\n    provider.onUnregister && provider.onUnregister();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\r\n    Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\r\n\r\n    // trigger a refresh of the ui\r\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\r\n  }\r\n\r\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n   * an action or specify a registered ToolId into toolbar.\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param toolbarUsage usage of the toolbar\r\n   * @param toolbarOrientation orientation of the toolbar\r\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n   */\r\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\r\n    toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    const buttonItems: CommonToolbarItem[] = [];\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return buttonItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideToolbarButtonItems) {\r\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\r\n          .forEach((spec: CommonToolbarItem) => buttonItems.push({ ...spec, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n\r\n    return buttonItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n   */\r\n  public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return statusBarItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideStatusBarItems) {\r\n        uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\r\n          .forEach((item: CommonStatusBarItem) => statusBarItems.push({ ...item, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n    return statusBarItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n   */\r\n  public static getBackstageItems(): BackstageItem[] {\r\n    const backstageItems: BackstageItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return backstageItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideBackstageItems) {\r\n        uiProvider.provideBackstageItems()\r\n          .forEach((item: BackstageItem) => backstageItems.push({ ...item, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n    return backstageItems;\r\n  }\r\n\r\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param location the location within the stage.\r\n   * @param section the section within location.\r\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\r\n   */\r\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return widgets;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideWidgets) {\r\n        uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\r\n          .forEach((widget: AbstractWidgetProps) => widgets.push({ ...widget, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n    return widgets;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAMtD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AAwBD;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;;OAKG;IACH,YAAsB,WAAmB,EAAS,gBAAmH;QAA/I,gBAAW,GAAX,WAAW,CAAQ;QAAS,qBAAgB,GAAhB,gBAAgB,CAAmG;IAAI,CAAC;IAE1K,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,YAAY,KAAW,CAAC;IAExB,UAAU;QACf,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED,oEAAoE;IAC7D,qBAAqB;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,iCAAiC,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAA2B,EAAE,mBAAuC,EAAE,aAAmB;QACvK,OAAO,EAAE,CAAC;IACZ,CAAC;IACM,yBAAyB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EAAE,kBAAsC,EAAE,YAAkB;QAC1J,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;SACjF;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3I,CAAC;IAEM,6BAA6B,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;QAC7F,OAAO,EAAE,CAAC;IACZ,CAAC;IACM,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QAClF,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;SACjF;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,CAAC;IAEM,sBAAsB,CAAC,QAAgB,EAAE,WAAmB,EAAE,SAA6B,EAAE,QAA4B,EAAE,aAAmB;QACnJ,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,cAAc,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAClH,aAAoC,EAAE,YAAkB;QACxD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;SACjF;aAAM;YACL,cAAc,GAAG,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,OAAO,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjH,CAAC;CACF;AASD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B;QAChD,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YACpD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,CAAC,EAAE,qBAAqB,CAAC,CAAC;SAC9F;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YAC1E,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC;YAElF,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAuC,CAAC,CAAC;SACxG;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAEnF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,EAAE;gBACxC,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aACnG;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE;gBACpC,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aACxG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE;gBACpC,UAAU,CAAC,qBAAqB,EAAE;qBAC/B,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aAClG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;YACjF,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,EAAE;gBAC7B,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;aACrG;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AAtJc,0CAA2B,GAAiC,IAAI,GAAG,EAA2B,CAAC;AAQ9G,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\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\nimport { loggerCategory } from \"./utils/misc\";\r\nimport { StageUsage } from \"./items/StageUsage\";\r\n\r\n/** Action taken by the application on item provided by a UiItemsProvider\r\n * @public @deprecated this was only used by the previously removed UiItemsArbiter.\r\n */\r\nexport enum UiItemsApplicationAction {\r\n  /** Allow the change to the item */\r\n  Allow,\r\n  /** Disallow the change to the item */\r\n  Disallow,\r\n  /** Update the item during the change */\r\n  Update,\r\n}\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\r\n/**\r\n * Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the\r\n * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.\r\n * @public\r\n */\r\nexport class BaseUiItemsProvider implements UiItemsProvider {\r\n  /*\r\n   * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want\r\n   * to set up custom stage with their own subset of standard tools.\r\n   * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and\r\n   * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.\r\n   */\r\n  constructor(protected _providerId: string, public isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider) => boolean) { }\r\n\r\n  public get id(): string { return this._providerId; }\r\n  public onUnregister(): void { }\r\n\r\n  public unregister() {\r\n    UiItemsManager.unregister(this._providerId);\r\n  }\r\n\r\n  /** Backstage items are not stage specific so no callback is used */\r\n  public provideBackstageItems(): BackstageItem[] {\r\n    return [];\r\n  }\r\n\r\n  public provideToolbarButtonItemsInternal(_stageId: string, _stageUsage: string, _toolbarUsage: ToolbarUsage, _toolbarOrientation: ToolbarOrientation, _stageAppData?: any): CommonToolbarItem[] {\r\n    return [];\r\n  }\r\n  public provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideToolbarButtonItemsInternal(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) : [];\r\n  }\r\n\r\n  public provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[] {\r\n    return [];\r\n  }\r\n  public provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideStatusBarItemsInternal(stageId, stageUsage, stageAppData) : [];\r\n  }\r\n\r\n  public provideWidgetsInternal(_stageId: string, _stageUsage: string, _location: StagePanelLocation, _section?: StagePanelSection, _stageAppData?: any): AbstractWidgetProps[] {\r\n    return [];\r\n  }\r\n\r\n  public provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection,\r\n    _zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    let provideToStage = false;\r\n\r\n    if (this.isSupportedStage) {\r\n      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);\r\n    } else {\r\n      provideToStage = (stageUsage === StageUsage.General);\r\n    }\r\n\r\n    return provideToStage ? this.provideWidgetsInternal(stageId, stageUsage, location, section, stageAppData) : [];\r\n  }\r\n}\r\n\r\n/** UIProvider Registered Event Args interface.\r\n * @public\r\n */\r\nexport interface UiItemProviderRegisteredEventArgs {\r\n  providerId: string;\r\n}\r\n\r\n/**\r\n * Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemsProvider> = new Map<string, UiItemsProvider>();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\r\n    UiItemsManager._registeredUiItemsProviders.clear();\r\n  }\r\n\r\n  /** Event raised any time a UiProvider is registered or unregistered. */\r\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds() {\r\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n    return ids;\r\n  }\r\n\r\n  /** Return true if there is any registered UiProvider. */\r\n  public static get hasRegisteredProviders(): boolean {\r\n    return this._registeredUiItemsProviders.size > 0;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a previously loaded UiItemsProvider.\r\n   * @param providerId id of the UiItemsProvider to get\r\n   */\r\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n    return UiItemsManager._registeredUiItemsProviders.get(providerId);\r\n  }\r\n\r\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\r\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\r\n  }\r\n\r\n  /**\r\n   * Registers a UiItemsProvider with the UiItemsManager.\r\n   * @param uiProvider the UI items provider to register.\r\n   */\r\n  public static register(uiProvider: UiItemsProvider): void {\r\n    if (UiItemsManager.getUiItemsProvider(uiProvider.id)) {\r\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProvider.id}) is already loaded`);\r\n    } else {\r\n      UiItemsManager._registeredUiItemsProviders.set(uiProvider.id, uiProvider);\r\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProvider.id}) loaded`);\r\n\r\n      UiItemsManager.sendRegisteredEvent({ providerId: uiProvider.id } as UiItemProviderRegisteredEventArgs);\r\n    }\r\n  }\r\n\r\n  /** Remove a specific UiItemsProvider from the list of available providers. */\r\n  public static unregister(uiProviderId: string): void {\r\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\r\n    if (!provider)\r\n      return;\r\n\r\n    provider.onUnregister && provider.onUnregister();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\r\n    Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\r\n\r\n    // trigger a refresh of the ui\r\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\r\n  }\r\n\r\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n   * an action or specify a registered ToolId into toolbar.\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param toolbarUsage usage of the toolbar\r\n   * @param toolbarOrientation orientation of the toolbar\r\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n   */\r\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\r\n    toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    const buttonItems: CommonToolbarItem[] = [];\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return buttonItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideToolbarButtonItems) {\r\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\r\n          .forEach((spec: CommonToolbarItem) => buttonItems.push({ ...spec, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n\r\n    return buttonItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n   */\r\n  public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return statusBarItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideStatusBarItems) {\r\n        uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\r\n          .forEach((item: CommonStatusBarItem) => statusBarItems.push({ ...item, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n    return statusBarItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n   */\r\n  public static getBackstageItems(): BackstageItem[] {\r\n    const backstageItems: BackstageItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return backstageItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideBackstageItems) {\r\n        uiProvider.provideBackstageItems()\r\n          .forEach((item: BackstageItem) => backstageItems.push({ ...item, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n    return backstageItems;\r\n  }\r\n\r\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param location the location within the stage.\r\n   * @param section the section within location.\r\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\r\n   */\r\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return widgets;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((uiProvider: UiItemsProvider) => {\r\n      // istanbul ignore else\r\n      if (uiProvider.provideWidgets) {\r\n        uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\r\n          .forEach((widget: AbstractWidgetProps) => widgets.push({ ...widget, providerId: uiProvider.id }));\r\n      }\r\n    });\r\n    return widgets;\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/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/esm/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/esm/appui-abstract/backstage/BackstageItem.js

@@ -36,6 +36,7 @@ export class 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,
@@ -48,6 +49,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/esm/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,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAwDD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC;AAC7D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC;AAChE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,sBAAsB;;AACjC,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,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAwDD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC;AAC7D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC;AAChE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,sBAAsB;;AACjC,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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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;