@itwin/appui-abstract 4.1.0-dev.6 → 4.1.0-dev.7

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

@@ -0,0 +1,130 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+const isInstance = (args) => {
+    return !Array.isArray(args);
+};
+/**
+ * Controls backstage items.
+ * @internal
+ */
+export class BackstageItemsManager {
+    constructor(items) {
+        this._items = [];
+        /** Event raised when backstage items are changed.
+         * @internal
+         */
+        this.onItemsChanged = new BeEvent();
+        // istanbul ignore else
+        if (items)
+            this.loadItemsInternal(items, true, false);
+    }
+    loadItemsInternal(items, processConditions, sendItemChanged) {
+        if (processConditions && items) {
+            const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);
+            if (0 !== eventIds.length) {
+                const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));
+                // istanbul ignore else
+                if (itemsUpdated)
+                    items = updatedItems;
+            }
+        }
+        this._items = items;
+        if (sendItemChanged)
+            this.onItemsChanged.raiseEvent({ items });
+    }
+    /** load items but do not fire onItemsChanged
+     * @internal
+     */
+    loadItems(items) {
+        this.loadItemsInternal(items, true, false);
+    }
+    get items() {
+        return this._items;
+    }
+    set items(items) {
+        // istanbul ignore else
+        if (items !== this._items)
+            this.loadItemsInternal(items, true, true);
+    }
+    /** @internal */
+    add(itemOrItems) {
+        let itemsToAdd;
+        if (isInstance(itemOrItems))
+            itemsToAdd = [itemOrItems];
+        else {
+            itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);
+        }
+        itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);
+        if (itemsToAdd.length === 0)
+            return;
+        const items = [
+            ...this._items,
+            ...itemsToAdd,
+        ];
+        this.items = items;
+    }
+    /** @internal */
+    remove(itemIdOrItemIds) {
+        const items = this._items.filter((item) => {
+            return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);
+        });
+        this.items = items;
+    }
+    /** @internal */
+    static getSyncIdsOfInterest(items) {
+        const eventIds = new Set();
+        items.forEach((item) => {
+            for (const [, entry] of Object.entries(item)) {
+                if (entry instanceof ConditionalBooleanValue) {
+                    entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
+                }
+                else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {
+                    entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
+                }
+            }
+        });
+        return [...eventIds.values()];
+    }
+    internalRefreshAffectedItems(items, eventIds) {
+        // istanbul ignore next
+        if (0 === eventIds.size)
+            return { itemsUpdated: false, updatedItems: [] };
+        let updateRequired = false;
+        const newItems = [];
+        for (const item of items) {
+            const updatedItem = { ...item };
+            for (const [, entry] of Object.entries(updatedItem)) {
+                if (entry instanceof ConditionalBooleanValue) {
+                    // istanbul ignore else
+                    if (ConditionalBooleanValue.refreshValue(entry, eventIds))
+                        updateRequired = true;
+                }
+                else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {
+                    // istanbul ignore else
+                    if (ConditionalStringValue.refreshValue(entry, eventIds))
+                        updateRequired = true;
+                }
+            }
+            newItems.push(updatedItem);
+        }
+        return { itemsUpdated: updateRequired, updatedItems: newItems };
+    }
+    refreshAffectedItems(eventIds) {
+        // istanbul ignore next
+        if (0 === eventIds.size)
+            return;
+        const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);
+        // istanbul ignore else
+        if (itemsUpdated)
+            this.loadItemsInternal(updatedItems, false, true);
+    }
+}
+//# sourceMappingURL=BackstageItemsManager.js.map

package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAczE,MAAM,UAAU,GAAG,CAAI,IAAwB,EAAa,EAAE;IAC5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAGhC,YAAY,KAAoC;QAFxC,WAAM,GAAiC,EAAE,CAAC;QAgClD;;WAEG;QACa,mBAAc,GAAG,IAAI,OAAO,EAA6C,CAAC;QAhCxF,uBAAuB;QACvB,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEO,iBAAiB,CAAC,KAAmC,EAAE,iBAA0B,EAAE,eAAwB;QACjH,IAAI,iBAAiB,IAAI,KAAK,EAAE;YAC9B,MAAM,QAAQ,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE;gBACzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAEnG,uBAAuB;gBACvB,IAAI,YAAY;oBACd,KAAK,GAAG,YAAY,CAAC;aACxB;SACF;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,eAAe;YACjB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAmC;QAClD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAOD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAmC;QAClD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,WAAyD;QAClE,IAAI,UAAU,CAAC;QACf,IAAI,UAAU,CAAC,WAAW,CAAC;YACzB,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;aACxB;YACH,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;SAC5H;QACD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;QAClH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO;QACT,MAAM,KAAK,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,UAAU;SACd,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAyE;QACrF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3H,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAA+B;QAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC5C,IAAI,KAAK,YAAY,uBAAuB,EAAE;oBAC5C,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;iBACtF;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE;oBAC7E,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;iBACtF;aACF;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,4BAA4B,CAAC,KAA+B,EAAE,QAAqB;QACzF,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAEnD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YAEhC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBACnD,IAAI,KAAK,YAAY,uBAAuB,EAAE;oBAC5C,uBAAuB;oBACvB,IAAI,uBAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACvD,cAAc,GAAG,IAAI,CAAC;iBACzB;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE;oBAC7E,uBAAuB;oBACvB,IAAI,sBAAsB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACtD,cAAc,GAAG,IAAI,CAAC;iBACzB;aACF;YAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC5B;QAED,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IAClE,CAAC;IAEM,oBAAoB,CAAC,QAAqB;QAC/C,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAE/F,uBAAuB;QACvB,IAAI,YAAY;YACd,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;CAEF","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 { BeEvent } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BackstageItem } from \"./BackstageItem\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Arguments of [[BackstageItemsManager.onChanged]] event.\r\n * @internal\r\n */\r\nexport interface BackstageItemsChangedArgs {\r\n  readonly items: ReadonlyArray<BackstageItem>;\r\n}\r\n\r\ntype InstanceOrArray<T> = T | ReadonlyArray<T>;\r\n\r\nconst isInstance = <T>(args: InstanceOrArray<T>): args is T => {\r\n  return !Array.isArray(args);\r\n};\r\n\r\n/**\r\n * Controls backstage items.\r\n * @internal\r\n */\r\nexport class BackstageItemsManager {\r\n  private _items: ReadonlyArray<BackstageItem> = [];\r\n\r\n  constructor(items?: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items)\r\n      this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  private loadItemsInternal(items: ReadonlyArray<BackstageItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n    if (processConditions && items) {\r\n      const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);\r\n      if (0 !== eventIds.length) {\r\n        const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));\r\n\r\n        // istanbul ignore else\r\n        if (itemsUpdated)\r\n          items = updatedItems;\r\n      }\r\n    }\r\n\r\n    this._items = items;\r\n    if (sendItemChanged)\r\n      this.onItemsChanged.raiseEvent({ items });\r\n  }\r\n\r\n  /** load items but do not fire onItemsChanged\r\n   * @internal\r\n   */\r\n  public loadItems(items: ReadonlyArray<BackstageItem>) {\r\n    this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Event raised when backstage items are changed.\r\n   * @internal\r\n   */\r\n  public readonly onItemsChanged = new BeEvent<(args: BackstageItemsChangedArgs) => void>();\r\n\r\n  public get items(): ReadonlyArray<BackstageItem> {\r\n    return this._items;\r\n  }\r\n\r\n  public set items(items: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items !== this._items)\r\n      this.loadItemsInternal(items, true, true);\r\n  }\r\n\r\n  /** @internal */\r\n  public add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>) {\r\n    let itemsToAdd;\r\n    if (isInstance(itemOrItems))\r\n      itemsToAdd = [itemOrItems];\r\n    else {\r\n      itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);\r\n    }\r\n    itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);\r\n    if (itemsToAdd.length === 0)\r\n      return;\r\n    const items = [\r\n      ...this._items,\r\n      ...itemsToAdd,\r\n    ];\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public remove(itemIdOrItemIds: BackstageItem[\"id\"] | ReadonlyArray<BackstageItem[\"id\"]>) {\r\n    const items = this._items.filter((item) => {\r\n      return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);\r\n    });\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[] {\r\n    const eventIds = new Set<string>();\r\n    items.forEach((item) => {\r\n      for (const [, entry] of Object.entries(item)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        }\r\n      }\r\n    });\r\n    return [...eventIds.values()];\r\n  }\r\n\r\n  private internalRefreshAffectedItems(items: readonly BackstageItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: BackstageItem[] } {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return { itemsUpdated: false, updatedItems: [] };\r\n\r\n    let updateRequired = false;\r\n\r\n    const newItems: BackstageItem[] = [];\r\n    for (const item of items) {\r\n      const updatedItem = { ...item };\r\n\r\n      for (const [, entry] of Object.entries(updatedItem)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalBooleanValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalStringValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        }\r\n      }\r\n\r\n      newItems.push(updatedItem);\r\n    }\r\n\r\n    return { itemsUpdated: updateRequired, updatedItems: newItems };\r\n  }\r\n\r\n  public refreshAffectedItems(eventIds: Set<string>) {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return;\r\n\r\n    const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);\r\n\r\n    // istanbul ignore else\r\n    if (itemsUpdated)\r\n      this.loadItemsInternal(updatedItems, false, true);\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-abstract/items/ProvidedItem.d.ts

@@ -0,0 +1,12 @@
+/** @packageDocumentation
+ * @module Item
+ */
+/** Properties for an item provided by UiItemsProvider
+ * @deprecated in 3.6. Use [ProviderItem]($appui-react) instead.
+ * @public
+ */
+export interface ProvidedItem {
+    /** id of UiItemsProvider */
+    readonly providerId?: string;
+}
+//# sourceMappingURL=ProvidedItem.d.ts.map

package/lib/esm/appui-abstract/items/ProvidedItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvidedItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ProvidedItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,4BAA4B;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B"}

package/lib/esm/appui-abstract/items/ProvidedItem.js

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+export {};
+//# sourceMappingURL=ProvidedItem.js.map

package/lib/esm/appui-abstract/items/ProvidedItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvidedItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ProvidedItem.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\n/** Properties for an item provided by UiItemsProvider\r\n * @deprecated in 3.6. Use [ProviderItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface ProvidedItem {\r\n  /** id of UiItemsProvider */\r\n  readonly providerId?: string;\r\n}\r\n"]}

package/lib/esm/appui-abstract/items/StageUsage.d.ts

@@ -0,0 +1,17 @@
+/** @packageDocumentation
+ * @module Item
+ */
+/** Standard stage uses. Allows extension to target ui item to include on a stage without
+ * knowing the stage name defined in the host application.
+ * @deprecated in 3.6. Use [StageUsage]($appui-react) instead.
+ * @public
+ */
+export declare enum StageUsage {
+    Private = "Private",
+    General = "General",
+    Redline = "Redline",
+    ViewOnly = "ViewOnly",
+    Edit = "Edit",
+    Settings = "Settings"
+}
+//# sourceMappingURL=StageUsage.d.ts.map

package/lib/esm/appui-abstract/items/StageUsage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StageUsage.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/items/StageUsage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;GAIG;AACH,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,QAAQ,aAAa;CACtB"}

package/lib/esm/appui-abstract/items/StageUsage.js

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+/** Standard stage uses. Allows extension to target ui item to include on a stage without
+ * knowing the stage name defined in the host application.
+ * @deprecated in 3.6. Use [StageUsage]($appui-react) instead.
+ * @public
+ */
+export var StageUsage;
+(function (StageUsage) {
+    StageUsage["Private"] = "Private";
+    StageUsage["General"] = "General";
+    StageUsage["Redline"] = "Redline";
+    StageUsage["ViewOnly"] = "ViewOnly";
+    StageUsage["Edit"] = "Edit";
+    StageUsage["Settings"] = "Settings";
+})(StageUsage || (StageUsage = {}));
+//# sourceMappingURL=StageUsage.js.map

package/lib/esm/appui-abstract/items/StageUsage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StageUsage.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/StageUsage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,mCAAqB,CAAA;AACvB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB","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\n/** Standard stage uses. Allows extension to target ui item to include on a stage without\r\n * knowing the stage name defined in the host application.\r\n * @deprecated in 3.6. Use [StageUsage]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StageUsage {\r\n  Private = \"Private\",\r\n  General = \"General\",\r\n  Redline = \"Redline\",\r\n  ViewOnly = \"ViewOnly\",\r\n  Edit = \"Edit\",\r\n  Settings = \"Settings\",\r\n}\r\n"]}

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

@@ -0,0 +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 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/esm/appui-abstract/statusbar/StatusBarItem.d.ts.map

@@ -0,0 +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,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/esm/appui-abstract/statusbar/StatusBarItem.js

@@ -0,0 +1,82 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Status bar Groups/Sections from Left to Right
+ * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
+ * @public
+ */
+export 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 || (StatusBarSection = {}));
+/** Defines which side of Icon where label is placed
+ * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
+ * @public
+ */
+export 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 || (StatusBarLabelSide = {}));
+/** AbstractStatusBarActionItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
+ * @public
+ */
+export const isAbstractStatusBarActionItem = (item) => {
+    return item.execute !== undefined; // eslint-disable-line deprecation/deprecation
+};
+/** AbstractStatusBarLabelItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
+ * @public
+ */
+export const isAbstractStatusBarLabelItem = (item) => {
+    return item.label !== undefined && item.execute === undefined; // eslint-disable-line deprecation/deprecation
+};
+/** AbstractStatusBarCustomItem type guard.
+ * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
+ * @public
+ */
+export const isAbstractStatusBarCustomItem = (item) => {
+    return !!item.isCustom; // eslint-disable-line deprecation/deprecation
+};
+/** 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,
+});
+export { AbstractStatusBarItemUtilities };
+//# sourceMappingURL=StatusBarItem.js.map

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

@@ -0,0 +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,MAAM,CAAN,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,KAAhB,gBAAgB,QAe3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA0ED;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AACpH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,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;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,8CAA8C;AACzG,CAAC,CAAC;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;SAfQ,8BAA8B","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/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts

@@ -0,0 +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;
+}
+//# sourceMappingURL=StatusBarItemsManager.d.ts.map

package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusBarItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAUvE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACpD;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAA0C;gBAE5C,KAAK,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC;IAKtD;;OAEG;IACH,SAAgB,cAAc,iBAAsB,yBAAyB,KAAK,IAAI,EAAI;IAE1F,OAAO,CAAC,iBAAiB;IAiBzB;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,mBAAmB,CAAC;IAI1D,2CAA2C;IAC3C,IAAW,KAAK,IAAI,aAAa,CAAC,mBAAmB,CAAC,CAErD;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAIzD;IAEM,GAAG,CAAC,WAAW,EAAE,mBAAmB,GAAG,aAAa,CAAC,mBAAmB,CAAC;IAiBhF,yCAAyC;IAClC,MAAM,CAAC,eAAe,EAAE,eAAe,GAAG,aAAa,CAAC,eAAe,CAC7E;IAOD,gBAAgB;IACT,SAAS;WAIF,oBAAoB,CAAC,KAAK,EAAE,SAAS,mBAAmB,EAAE,GAAG,MAAM,EAAE;IAcnF,OAAO,CAAC,4BAA4B;IA6B7B,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC;CAWlD"}