@itwin/appui-abstract 4.0.0-dev.52 → 4.0.0-dev.55

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

@@ -1,129 +1,129 @@
-/** @packageDocumentation
- * @module StatusBar
- */
-import { BadgeType } from "../items/BadgeType";
-import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
-import { ConditionalStringValue } from "../items/ConditionalStringValue";
-import { ProvidedItem } from "../items/ProvidedItem";
-/** Status bar Groups/Sections from Left to Right
- * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
- * @public
- */
-export declare enum StatusBarSection {
-    /** area for tool assistance and messages */
-    Message = 0,
-    /** area for tool assistance and messages */
-    Left = 0,
-    /** items specific to stage/task */
-    Stage = 1,
-    /** items specific to stage/task */
-    Center = 1,
-    /** Select scope and selection info */
-    Selection = 2,
-    /** Select scope and selection info */
-    Right = 2,
-    /** items that only show based on context */
-    Context = 3
-}
-/** Defines which side of Icon where label is placed
- * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
- * @public
- */
-export declare enum StatusBarLabelSide {
-    /** Label is placed left side of icon. This is the default if not specified */
-    Left = 0,
-    /** Label is placed on right side of icon. */
-    Right = 1
-}
-/** Type for StatusBar Item Id
- * @deprecated in 3.6. Please use `CommonStatusBarItem["id"]` from @itwin/appui-react.
- * @public
- */
-export declare type StatusBarItemId = CommonStatusBarItem["id"];
-/** Describes the data needed to insert a button into the status bar.
- * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.
- * @public
- */
-export interface AbstractStatusBarItem extends ProvidedItem {
-    /** can be used by application to store miscellaneous data. */
-    applicationData?: any;
-    /** Describes badge. Renders no badge if not specified. */
-    readonly badgeType?: BadgeType;
-    /** 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 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 section (recommend using values 1 through 100). */
-    readonly itemPriority: number;
-    /** status bar section */
-    readonly section: StatusBarSection;
-}
-/** Describes the data needed to insert an action item into the status bar.
- * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.
- * @public
- */
-export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
-    /** method to execute when icon is pressed */
-    readonly execute: () => void;
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
-    readonly icon?: string | ConditionalStringValue;
-    /** Label. */
-    readonly label?: string | ConditionalStringValue;
-    /** tooltip. */
-    readonly tooltip?: string | ConditionalStringValue;
-}
-/** Describes the data needed to insert a label item with an optional icon into the status bar.
- * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.
- * @public
- */
-export interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
-    readonly icon?: string | ConditionalStringValue;
-    /** Label. */
-    readonly label: string | ConditionalStringValue;
-    /** Defines which side of icon to display label if icon is defined. */
-    readonly labelSide?: StatusBarLabelSide;
-}
-/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension
- *  implementer to create a framework specific component.
- * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.
- * @public
- */
-export interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {
-    readonly isCustom: true;
-}
-/** Describes the data needed to insert a button into the status bar.
- * @deprecated in 3.6. Use [StatusBarItem]($appui-react) instead.
- * @public
- */
-export declare type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;
-/** AbstractStatusBarActionItem type guard.
- * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
- * @public
- */
-export declare const isAbstractStatusBarActionItem: (item: CommonStatusBarItem) => item is AbstractStatusBarActionItem;
-/** AbstractStatusBarLabelItem type guard.
- * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
- * @public
- */
-export declare const isAbstractStatusBarLabelItem: (item: CommonStatusBarItem) => item is AbstractStatusBarLabelItem;
-/** AbstractStatusBarCustomItem type guard.
- * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
- * @public
- */
-export declare const isAbstractStatusBarCustomItem: (item: CommonStatusBarItem) => item is AbstractStatusBarCustomItem;
-/** Helper class to create Abstract StatusBar Item definitions.
- * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.
- * @public
- */
-export declare class AbstractStatusBarItemUtilities {
-    /** Creates a StatusBar item to perform an action */
-    static createActionItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem> | undefined) => AbstractStatusBarActionItem;
-    /** Creates a StatusBar item to display a label */
-    static createLabelItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide?: StatusBarLabelSide, overrides?: Partial<AbstractStatusBarLabelItem> | undefined) => AbstractStatusBarLabelItem;
-}
+/** @packageDocumentation
+ * @module StatusBar
+ */
+import { BadgeType } from "../items/BadgeType";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+import { ProvidedItem } from "../items/ProvidedItem";
+/** Status bar Groups/Sections from Left to Right
+ * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
+ * @public
+ */
+export declare enum StatusBarSection {
+    /** area for tool assistance and messages */
+    Message = 0,
+    /** area for tool assistance and messages */
+    Left = 0,
+    /** items specific to stage/task */
+    Stage = 1,
+    /** items specific to stage/task */
+    Center = 1,
+    /** Select scope and selection info */
+    Selection = 2,
+    /** Select scope and selection info */
+    Right = 2,
+    /** items that only show based on context */
+    Context = 3
+}
+/** Defines which side of Icon where label is placed
+ * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
+ * @public
+ */
+export declare enum StatusBarLabelSide {
+    /** Label is placed left side of icon. This is the default if not specified */
+    Left = 0,
+    /** Label is placed on right side of icon. */
+    Right = 1
+}
+/** Type for StatusBar Item Id
+ * @deprecated in 3.6. Please use `CommonStatusBarItem["id"]` from @itwin/appui-react.
+ * @public
+ */
+export type StatusBarItemId = CommonStatusBarItem["id"];
+/** Describes the data needed to insert a button into the status bar.
+ * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.
+ * @public
+ */
+export interface AbstractStatusBarItem extends ProvidedItem {
+    /** can be used by application to store miscellaneous data. */
+    applicationData?: any;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badgeType?: BadgeType;
+    /** 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 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 section (recommend using values 1 through 100). */
+    readonly itemPriority: number;
+    /** status bar section */
+    readonly section: StatusBarSection;
+}
+/** Describes the data needed to insert an action item into the status bar.
+ * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.
+ * @public
+ */
+export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
+    /** method to execute when icon is pressed */
+    readonly execute: () => void;
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
+    readonly icon?: string | ConditionalStringValue;
+    /** Label. */
+    readonly label?: string | ConditionalStringValue;
+    /** tooltip. */
+    readonly tooltip?: string | ConditionalStringValue;
+}
+/** Describes the data needed to insert a label item with an optional icon into the status bar.
+ * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.
+ * @public
+ */
+export interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
+    readonly icon?: string | ConditionalStringValue;
+    /** Label. */
+    readonly label: string | ConditionalStringValue;
+    /** Defines which side of icon to display label if icon is defined. */
+    readonly labelSide?: StatusBarLabelSide;
+}
+/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension
+ *  implementer to create a framework specific component.
+ * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.
+ * @public
+ */
+export interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {
+    readonly isCustom: true;
+}
+/** Describes the data needed to insert a button into the status bar.
+ * @deprecated in 3.6. Use [StatusBarItem]($appui-react) instead.
+ * @public
+ */
+export type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;
+/** AbstractStatusBarActionItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
+ * @public
+ */
+export declare const isAbstractStatusBarActionItem: (item: CommonStatusBarItem) => item is AbstractStatusBarActionItem;
+/** AbstractStatusBarLabelItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
+ * @public
+ */
+export declare const isAbstractStatusBarLabelItem: (item: CommonStatusBarItem) => item is AbstractStatusBarLabelItem;
+/** AbstractStatusBarCustomItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
+ * @public
+ */
+export declare const isAbstractStatusBarCustomItem: (item: CommonStatusBarItem) => item is AbstractStatusBarCustomItem;
+/** Helper class to create Abstract StatusBar Item definitions.
+ * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.
+ * @public
+ */
+export declare class AbstractStatusBarItemUtilities {
+    /** Creates a StatusBar item to perform an action */
+    static createActionItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>) => AbstractStatusBarActionItem;
+    /** Creates a StatusBar item to display a label */
+    static createLabelItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide?: StatusBarLabelSide, overrides?: Partial<AbstractStatusBarLabelItem>) => AbstractStatusBarLabelItem;
+}
 //# sourceMappingURL=StatusBarItem.d.ts.map

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

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

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

@@ -1,88 +1,88 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module StatusBar
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractStatusBarItemUtilities = exports.isAbstractStatusBarCustomItem = exports.isAbstractStatusBarLabelItem = exports.isAbstractStatusBarActionItem = exports.StatusBarLabelSide = exports.StatusBarSection = void 0;
-/** Status bar Groups/Sections from Left to Right
- * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
- * @public
- */
-var StatusBarSection;
-(function (StatusBarSection) {
-    /** area for tool assistance and messages */
-    StatusBarSection[StatusBarSection["Message"] = 0] = "Message";
-    /** area for tool assistance and messages */
-    StatusBarSection[StatusBarSection["Left"] = 0] = "Left";
-    /** items specific to stage/task */
-    StatusBarSection[StatusBarSection["Stage"] = 1] = "Stage";
-    /** items specific to stage/task */
-    StatusBarSection[StatusBarSection["Center"] = 1] = "Center";
-    /** Select scope and selection info */
-    StatusBarSection[StatusBarSection["Selection"] = 2] = "Selection";
-    /** Select scope and selection info */
-    StatusBarSection[StatusBarSection["Right"] = 2] = "Right";
-    /** items that only show based on context */
-    StatusBarSection[StatusBarSection["Context"] = 3] = "Context";
-})(StatusBarSection = exports.StatusBarSection || (exports.StatusBarSection = {}));
-/** Defines which side of Icon where label is placed
- * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
- * @public
- */
-var StatusBarLabelSide;
-(function (StatusBarLabelSide) {
-    /** Label is placed left side of icon. This is the default if not specified */
-    StatusBarLabelSide[StatusBarLabelSide["Left"] = 0] = "Left";
-    /** Label is placed on right side of icon. */
-    StatusBarLabelSide[StatusBarLabelSide["Right"] = 1] = "Right";
-})(StatusBarLabelSide = exports.StatusBarLabelSide || (exports.StatusBarLabelSide = {}));
-/** AbstractStatusBarActionItem type guard.
- * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
- * @public
- */
-const isAbstractStatusBarActionItem = (item) => {
-    return item.execute !== undefined; // eslint-disable-line deprecation/deprecation
-};
-exports.isAbstractStatusBarActionItem = isAbstractStatusBarActionItem;
-/** AbstractStatusBarLabelItem type guard.
- * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
- * @public
- */
-const isAbstractStatusBarLabelItem = (item) => {
-    return item.label !== undefined && item.execute === undefined; // eslint-disable-line deprecation/deprecation
-};
-exports.isAbstractStatusBarLabelItem = isAbstractStatusBarLabelItem;
-/** AbstractStatusBarCustomItem type guard.
- * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
- * @public
- */
-const isAbstractStatusBarCustomItem = (item) => {
-    return !!item.isCustom; // eslint-disable-line deprecation/deprecation
-};
-exports.isAbstractStatusBarCustomItem = isAbstractStatusBarCustomItem;
-/** Helper class to create Abstract StatusBar Item definitions.
- * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.
- * @public
- */
-class AbstractStatusBarItemUtilities {
-}
-exports.AbstractStatusBarItemUtilities = AbstractStatusBarItemUtilities;
-/** Creates a StatusBar item to perform an action */
-AbstractStatusBarItemUtilities.createActionItem = (id, section, itemPriority, icon, tooltip, execute, overrides) => ({
-    id, section, itemPriority,
-    icon, tooltip,
-    execute,
-    ...overrides,
-});
-/** Creates a StatusBar item to display a label */
-AbstractStatusBarItemUtilities.createLabelItem = (id, section, itemPriority, icon, label, labelSide = StatusBarLabelSide.Right, overrides) => ({
-    id, section, itemPriority,
-    icon, label,
-    labelSide,
-    ...overrides,
-});
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module StatusBar
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractStatusBarItemUtilities = exports.isAbstractStatusBarCustomItem = exports.isAbstractStatusBarLabelItem = exports.isAbstractStatusBarActionItem = exports.StatusBarLabelSide = exports.StatusBarSection = void 0;
+/** Status bar Groups/Sections from Left to Right
+ * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
+ * @public
+ */
+var StatusBarSection;
+(function (StatusBarSection) {
+    /** area for tool assistance and messages */
+    StatusBarSection[StatusBarSection["Message"] = 0] = "Message";
+    /** area for tool assistance and messages */
+    StatusBarSection[StatusBarSection["Left"] = 0] = "Left";
+    /** items specific to stage/task */
+    StatusBarSection[StatusBarSection["Stage"] = 1] = "Stage";
+    /** items specific to stage/task */
+    StatusBarSection[StatusBarSection["Center"] = 1] = "Center";
+    /** Select scope and selection info */
+    StatusBarSection[StatusBarSection["Selection"] = 2] = "Selection";
+    /** Select scope and selection info */
+    StatusBarSection[StatusBarSection["Right"] = 2] = "Right";
+    /** items that only show based on context */
+    StatusBarSection[StatusBarSection["Context"] = 3] = "Context";
+})(StatusBarSection = exports.StatusBarSection || (exports.StatusBarSection = {}));
+/** Defines which side of Icon where label is placed
+ * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
+ * @public
+ */
+var StatusBarLabelSide;
+(function (StatusBarLabelSide) {
+    /** Label is placed left side of icon. This is the default if not specified */
+    StatusBarLabelSide[StatusBarLabelSide["Left"] = 0] = "Left";
+    /** Label is placed on right side of icon. */
+    StatusBarLabelSide[StatusBarLabelSide["Right"] = 1] = "Right";
+})(StatusBarLabelSide = exports.StatusBarLabelSide || (exports.StatusBarLabelSide = {}));
+/** AbstractStatusBarActionItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
+ * @public
+ */
+const isAbstractStatusBarActionItem = (item) => {
+    return item.execute !== undefined; // eslint-disable-line deprecation/deprecation
+};
+exports.isAbstractStatusBarActionItem = isAbstractStatusBarActionItem;
+/** AbstractStatusBarLabelItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
+ * @public
+ */
+const isAbstractStatusBarLabelItem = (item) => {
+    return item.label !== undefined && item.execute === undefined; // eslint-disable-line deprecation/deprecation
+};
+exports.isAbstractStatusBarLabelItem = isAbstractStatusBarLabelItem;
+/** AbstractStatusBarCustomItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
+ * @public
+ */
+const isAbstractStatusBarCustomItem = (item) => {
+    return !!item.isCustom; // eslint-disable-line deprecation/deprecation
+};
+exports.isAbstractStatusBarCustomItem = isAbstractStatusBarCustomItem;
+/** Helper class to create Abstract StatusBar Item definitions.
+ * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.
+ * @public
+ */
+class AbstractStatusBarItemUtilities {
+}
+/** Creates a StatusBar item to perform an action */
+AbstractStatusBarItemUtilities.createActionItem = (id, section, itemPriority, icon, tooltip, execute, overrides) => ({
+    id, section, itemPriority,
+    icon, tooltip,
+    execute,
+    ...overrides,
+});
+/** Creates a StatusBar item to display a label */
+AbstractStatusBarItemUtilities.createLabelItem = (id, section, itemPriority, icon, label, labelSide = StatusBarLabelSide.Right, overrides) => ({
+    id, section, itemPriority,
+    icon, label,
+    labelSide,
+    ...overrides,
+});
+exports.AbstractStatusBarItemUtilities = AbstractStatusBarItemUtilities;
 //# sourceMappingURL=StatusBarItem.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAe3B;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AA0ED;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAChL,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACH,MAAa,8BAA8B;;AAA3C,wEAgBC;AAfC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module StatusBar\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Status bar Groups/Sections from Left to Right\r\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StatusBarSection {\r\n  /** area for tool assistance and messages */\r\n  Message = 0,\r\n  /** area for tool assistance and messages */\r\n  Left = 0,\r\n  /** items specific to stage/task */\r\n  Stage = 1,\r\n  /** items specific to stage/task */\r\n  Center = 1,\r\n  /** Select scope and selection info */\r\n  Selection = 2,\r\n  /** Select scope and selection info */\r\n  Right = 2,\r\n  /** items that only show based on context */\r\n  Context = 3,\r\n}\r\n\r\n/** Defines which side of Icon where label is placed\r\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StatusBarLabelSide {\r\n  /** Label is placed left side of icon. This is the default if not specified */\r\n  Left,\r\n  /** Label is placed on right side of icon. */\r\n  Right,\r\n}\r\n\r\n/** Type for StatusBar Item Id\r\n * @deprecated in 3.6. Please use `CommonStatusBarItem[\"id\"]` from @itwin/appui-react.\r\n * @public\r\n */\r\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Priority within a section (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** status bar section */\r\n  readonly section: StatusBarSection; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Describes the data needed to insert an action item into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\r\n  /** method to execute when icon is pressed */\r\n  readonly execute: () => void;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Label. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Defines which side of icon to display label if icon is defined. */\r\n  readonly labelSide?: StatusBarLabelSide; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\r\n *  implementer to create a framework specific component.\r\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\r\n  readonly isCustom: true;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** AbstractStatusBarActionItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** AbstractStatusBarLabelItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** AbstractStatusBarCustomItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line deprecation/deprecation\r\n  return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class AbstractStatusBarItemUtilities {\r\n  /** Creates a StatusBar item to perform an action */\r\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n    id, section, itemPriority,\r\n    icon, tooltip,\r\n    execute,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates a StatusBar item to display a label */\r\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line deprecation/deprecation\r\n    id, section, itemPriority,\r\n    icon, label,\r\n    labelSide,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}
+{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAe3B;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AA0ED;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAChL,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACH,MAAa,8BAA8B;;AACzC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,CAAC;AAfQ,wEAA8B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module StatusBar\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Status bar Groups/Sections from Left to Right\r\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StatusBarSection {\r\n  /** area for tool assistance and messages */\r\n  Message = 0,\r\n  /** area for tool assistance and messages */\r\n  Left = 0,\r\n  /** items specific to stage/task */\r\n  Stage = 1,\r\n  /** items specific to stage/task */\r\n  Center = 1,\r\n  /** Select scope and selection info */\r\n  Selection = 2,\r\n  /** Select scope and selection info */\r\n  Right = 2,\r\n  /** items that only show based on context */\r\n  Context = 3,\r\n}\r\n\r\n/** Defines which side of Icon where label is placed\r\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StatusBarLabelSide {\r\n  /** Label is placed left side of icon. This is the default if not specified */\r\n  Left,\r\n  /** Label is placed on right side of icon. */\r\n  Right,\r\n}\r\n\r\n/** Type for StatusBar Item Id\r\n * @deprecated in 3.6. Please use `CommonStatusBarItem[\"id\"]` from @itwin/appui-react.\r\n * @public\r\n */\r\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Priority within a section (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** status bar section */\r\n  readonly section: StatusBarSection; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Describes the data needed to insert an action item into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\r\n  /** method to execute when icon is pressed */\r\n  readonly execute: () => void;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Label. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix  to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Defines which side of icon to display label if icon is defined. */\r\n  readonly labelSide?: StatusBarLabelSide; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\r\n *  implementer to create a framework specific component.\r\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line deprecation/deprecation\r\n  readonly isCustom: true;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** AbstractStatusBarActionItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** AbstractStatusBarLabelItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** AbstractStatusBarCustomItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line deprecation/deprecation\r\n  return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class AbstractStatusBarItemUtilities {\r\n  /** Creates a StatusBar item to perform an action */\r\n  public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n    id, section, itemPriority,\r\n    icon, tooltip,\r\n    execute,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates a StatusBar item to display a label */\r\n  public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line deprecation/deprecation\r\n    id, section, itemPriority,\r\n    icon, label,\r\n    labelSide,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}

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

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