@itwin/appui-abstract 3.6.0-dev.8 → 4.0.0-dev.2

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

@@ -1,84 +1,84 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { BadgeType } from "../items/BadgeType";
-import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
-import { ConditionalStringValue } from "../items/ConditionalStringValue";
-import { ProvidedItem } from "../items/ProvidedItem";
-/** Used to specify the item type added to the backstage menu.
- * @public
- */
-export declare enum BackstageItemType {
-    /** Item that executes an action function */
-    ActionItem = 1,
-    /** Item that activate a stage. */
-    StageLauncher = 2
-}
-/** Describes the data needed to insert a button into the backstage menu.
- * @public
- */
-export interface CommonBackstageItem extends ProvidedItem {
-    /** can be used by application to store miscellaneous data. */
-    applicationData?: any;
-    /** Describes badge. Renders no badge if not specified. */
-    readonly badgeType?: BadgeType;
-    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
-     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
-     * allows extensions enough gaps to insert their own groups.
-     */
-    readonly groupPriority: number;
-    /** 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;
-    /** optional data to be used by item implementor. */
-    readonly internalData?: Map<string, any>;
-    /** Describes if the item is visible or hidden. The default is for the item to be visible. */
-    readonly isHidden?: boolean | ConditionalBooleanValue;
-    /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
-    readonly isDisabled?: boolean | ConditionalBooleanValue;
-    /** Priority within a group (recommend using values 1 through 100). */
-    readonly itemPriority: number;
-    /** Label. */
-    readonly label: string | ConditionalStringValue;
-    /** Subtitle. */
-    readonly subtitle?: string | ConditionalStringValue;
-    /** Tooltip. */
-    readonly tooltip?: string | ConditionalStringValue;
-    /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */
-    readonly isActive?: boolean | ConditionalBooleanValue;
-}
-/** Describes the data needed to insert an action button into the backstage menu.
- * @public
- */
-export interface BackstageActionItem extends CommonBackstageItem {
-    readonly execute: () => void;
-}
-/** Describes the data needed to insert an action button into the backstage menu.
- * @public
- */
-export interface BackstageStageLauncher extends CommonBackstageItem {
-    readonly stageId: string;
-}
-/** Describes the data needed to insert a button into the backstage menu.
- * @public
- */
-export declare type BackstageItem = BackstageActionItem | BackstageStageLauncher;
-/** BackstageActionItem type guard.
- * @public
- */
-export declare const isActionItem: (item: BackstageItem) => item is BackstageActionItem;
-/** BackstageStageLauncher type guard.
- * @public
- */
-export declare const isStageLauncher: (item: BackstageItem) => item is BackstageStageLauncher;
-/** Utilities for creating and maintaining backstage items
- * @public
- */
-export declare class BackstageItemUtilities {
-    /** Creates a stage launcher backstage item */
-    static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue | undefined, icon?: string | ConditionalStringValue | undefined, overrides?: Partial<BackstageStageLauncher> | undefined) => BackstageStageLauncher;
-    /** Creates an action backstage item */
-    static createActionItem: (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue | undefined, icon?: string | ConditionalStringValue | undefined, overrides?: Partial<BackstageActionItem> | undefined) => BackstageActionItem;
-}
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BadgeType } from "../items/BadgeType";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+import { ProvidedItem } from "../items/ProvidedItem";
+/** Used to specify the item type added to the backstage menu.
+ * @public
+ */
+export declare enum BackstageItemType {
+    /** Item that executes an action function */
+    ActionItem = 1,
+    /** Item that activate a stage. */
+    StageLauncher = 2
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @public
+ */
+export interface CommonBackstageItem extends ProvidedItem {
+    /** can be used by application to store miscellaneous data. */
+    applicationData?: any;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badgeType?: BadgeType;
+    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
+     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
+     * allows extensions enough gaps to insert their own groups.
+     */
+    readonly groupPriority: number;
+    /** 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;
+    /** optional data to be used by item implementor. */
+    readonly internalData?: Map<string, any>;
+    /** Describes if the item is visible or hidden. The default is for the item to be visible. */
+    readonly isHidden?: boolean | ConditionalBooleanValue;
+    /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
+    readonly isDisabled?: boolean | ConditionalBooleanValue;
+    /** Priority within a group (recommend using values 1 through 100). */
+    readonly itemPriority: number;
+    /** Label. */
+    readonly label: string | ConditionalStringValue;
+    /** Subtitle. */
+    readonly subtitle?: string | ConditionalStringValue;
+    /** Tooltip. */
+    readonly tooltip?: string | ConditionalStringValue;
+    /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */
+    readonly isActive?: boolean | ConditionalBooleanValue;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @public
+ */
+export interface BackstageActionItem extends CommonBackstageItem {
+    readonly execute: () => void;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @public
+ */
+export interface BackstageStageLauncher extends CommonBackstageItem {
+    readonly stageId: string;
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @public
+ */
+export declare type BackstageItem = BackstageActionItem | BackstageStageLauncher;
+/** BackstageActionItem type guard.
+ * @public
+ */
+export declare const isActionItem: (item: BackstageItem) => item is BackstageActionItem;
+/** BackstageStageLauncher type guard.
+ * @public
+ */
+export declare const isStageLauncher: (item: BackstageItem) => item is BackstageStageLauncher;
+/** Utilities for creating and maintaining backstage items
+ * @public
+ */
+export declare class BackstageItemUtilities {
+    /** Creates a stage launcher backstage item */
+    static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue | undefined, icon?: string | ConditionalStringValue | undefined, overrides?: Partial<BackstageStageLauncher> | undefined) => BackstageStageLauncher;
+    /** Creates an action backstage item */
+    static createActionItem: (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue | undefined, icon?: string | ConditionalStringValue | undefined, overrides?: Partial<BackstageActionItem> | undefined) => BackstageActionItem;
+}
 //# sourceMappingURL=BackstageItem.d.ts.map

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

@@ -1,59 +1,59 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Backstage
- */
-/** Used to specify the item type added to the backstage menu.
- * @public
- */
-export var BackstageItemType;
-(function (BackstageItemType) {
-    /** Item that executes an action function */
-    BackstageItemType[BackstageItemType["ActionItem"] = 1] = "ActionItem";
-    /** Item that activate a stage. */
-    BackstageItemType[BackstageItemType["StageLauncher"] = 2] = "StageLauncher";
-})(BackstageItemType || (BackstageItemType = {}));
-/** BackstageActionItem type guard.
- * @public
- */
-export const isActionItem = (item) => {
-    return item.execute !== undefined;
-};
-/** BackstageStageLauncher type guard.
- * @public
- */
-export const isStageLauncher = (item) => {
-    return item.stageId !== undefined;
-};
-/** Utilities for creating and maintaining backstage items
- * @public
- */
-export class BackstageItemUtilities {
-}
-/** Creates a stage launcher backstage item */
-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,
-    stageId: frontstageId,
-    subtitle,
-    ...overrides,
-});
-/** Creates an action backstage item */
-BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, icon, overrides) => ({
-    execute,
-    groupPriority,
-    icon,
-    internalData: overrides === null || overrides === void 0 ? void 0 : overrides.internalData,
-    id: itemId,
-    itemPriority,
-    label,
-    subtitle,
-    ...overrides,
-});
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+/** Used to specify the item type added to the backstage menu.
+ * @public
+ */
+export var BackstageItemType;
+(function (BackstageItemType) {
+    /** Item that executes an action function */
+    BackstageItemType[BackstageItemType["ActionItem"] = 1] = "ActionItem";
+    /** Item that activate a stage. */
+    BackstageItemType[BackstageItemType["StageLauncher"] = 2] = "StageLauncher";
+})(BackstageItemType || (BackstageItemType = {}));
+/** BackstageActionItem type guard.
+ * @public
+ */
+export const isActionItem = (item) => {
+    return item.execute !== undefined;
+};
+/** BackstageStageLauncher type guard.
+ * @public
+ */
+export const isStageLauncher = (item) => {
+    return item.stageId !== undefined;
+};
+/** Utilities for creating and maintaining backstage items
+ * @public
+ */
+export class BackstageItemUtilities {
+}
+/** Creates a stage launcher backstage item */
+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,
+    stageId: frontstageId,
+    subtitle,
+    ...overrides,
+});
+/** Creates an action backstage item */
+BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, icon, overrides) => ({
+    execute,
+    groupPriority,
+    icon,
+    internalData: overrides === null || overrides === void 0 ? void 0 : overrides.internalData,
+    id: itemId,
+    itemPriority,
+    label,
+    subtitle,
+    ...overrides,
+});
 //# sourceMappingURL=BackstageItem.js.map

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,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"]}
+{"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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Backstage\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Used to specify the item type added to the backstage menu.\n * @public\n */\nexport enum BackstageItemType {\n  /** Item that executes an action function */\n  ActionItem = 1,\n  /** Item that activate a stage. */\n  StageLauncher = 2,\n}\n\n/** Describes the data needed to insert a button into the backstage menu.\n * @public\n */\nexport interface CommonBackstageItem extends ProvidedItem {\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Describes badge. Renders no badge if not specified. */\n  readonly badgeType?: BadgeType;\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\n   * allows extensions enough gaps to insert their own groups.\n   */\n  readonly groupPriority: number;\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n  readonly icon?: string | ConditionalStringValue;\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n  readonly id: string;\n  /** optional data to be used by item implementor. */\n  readonly internalData?: Map<string, any>;\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n  readonly isHidden?: boolean | ConditionalBooleanValue;\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\n  /** Priority within a group (recommend using values 1 through 100). */\n  readonly itemPriority: number;\n  /** Label. */\n  readonly label: string | ConditionalStringValue;\n  /** Subtitle. */\n  readonly subtitle?: string | ConditionalStringValue;\n  /** Tooltip. */\n  readonly tooltip?: string | ConditionalStringValue;\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\n  readonly isActive?: boolean | ConditionalBooleanValue;\n}\n\n/** Describes the data needed to insert an action button into the backstage menu.\n * @public\n */\nexport interface BackstageActionItem extends CommonBackstageItem {\n  readonly execute: () => void;\n}\n\n/** Describes the data needed to insert an action button into the backstage menu.\n * @public\n */\nexport interface BackstageStageLauncher extends CommonBackstageItem {\n  readonly stageId: string;\n}\n\n/** Describes the data needed to insert a button into the backstage menu.\n * @public\n */\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher;\n\n/** BackstageActionItem type guard.\n * @public\n */\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => {\n  return (item as BackstageActionItem).execute !== undefined;\n};\n\n/** BackstageStageLauncher type guard.\n * @public\n */\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => {\n  return (item as BackstageStageLauncher).stageId !== undefined;\n};\n\n/** Utilities for creating and maintaining backstage items\n * @public\n */\nexport class BackstageItemUtilities {\n  /** Creates a stage launcher backstage item */\n  public static createStageLauncher = (\n    frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>\n  ): BackstageStageLauncher => ({\n    groupPriority,\n    icon,\n    internalData: overrides?.internalData,\n    id: frontstageId,\n    itemPriority,\n    label,\n    stageId: frontstageId,\n    subtitle,\n    ...overrides,\n  });\n\n  /** Creates an action backstage item */\n  public static createActionItem = (\n    itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>\n  ): BackstageActionItem => ({\n    execute,\n    groupPriority,\n    icon,\n    internalData: overrides?.internalData,\n    id: itemId,\n    itemPriority,\n    label,\n    subtitle,\n    ...overrides,\n  });\n}\n"]}

package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts

@@ -1,39 +1,39 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { BackstageItem } from "./BackstageItem";
-/** Arguments of [[BackstageItemsManager.onChanged]] event.
- * @internal
- */
-export interface BackstageItemsChangedArgs {
-    readonly items: ReadonlyArray<BackstageItem>;
-}
-/**
- * Controls backstage items.
- * @internal
- */
-export declare class BackstageItemsManager {
-    private _items;
-    constructor(items?: ReadonlyArray<BackstageItem>);
-    private loadItemsInternal;
-    /** load items but do not fire onItemsChanged
-     * @internal
-     */
-    loadItems(items: ReadonlyArray<BackstageItem>): void;
-    /** Event raised when backstage items are changed.
-     * @internal
-     */
-    readonly onItemsChanged: BeEvent<(args: BackstageItemsChangedArgs) => void>;
-    get items(): ReadonlyArray<BackstageItem>;
-    set items(items: ReadonlyArray<BackstageItem>);
-    /** @internal */
-    add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>): void;
-    /** @internal */
-    remove(itemIdOrItemIds: BackstageItem["id"] | ReadonlyArray<BackstageItem["id"]>): void;
-    /** @internal */
-    static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[];
-    private internalRefreshAffectedItems;
-    refreshAffectedItems(eventIds: Set<string>): void;
-}
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { BackstageItem } from "./BackstageItem";
+/** Arguments of [[BackstageItemsManager.onChanged]] event.
+ * @internal
+ */
+export interface BackstageItemsChangedArgs {
+    readonly items: ReadonlyArray<BackstageItem>;
+}
+/**
+ * Controls backstage items.
+ * @internal
+ */
+export declare class BackstageItemsManager {
+    private _items;
+    constructor(items?: ReadonlyArray<BackstageItem>);
+    private loadItemsInternal;
+    /** load items but do not fire onItemsChanged
+     * @internal
+     */
+    loadItems(items: ReadonlyArray<BackstageItem>): void;
+    /** Event raised when backstage items are changed.
+     * @internal
+     */
+    readonly onItemsChanged: BeEvent<(args: BackstageItemsChangedArgs) => void>;
+    get items(): ReadonlyArray<BackstageItem>;
+    set items(items: ReadonlyArray<BackstageItem>);
+    /** @internal */
+    add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>): void;
+    /** @internal */
+    remove(itemIdOrItemIds: BackstageItem["id"] | ReadonlyArray<BackstageItem["id"]>): void;
+    /** @internal */
+    static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[];
+    private internalRefreshAffectedItems;
+    refreshAffectedItems(eventIds: Set<string>): void;
+}
 //# sourceMappingURL=BackstageItemsManager.d.ts.map