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

package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js

@@ -1,132 +1,132 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
-import { ConditionalStringValue } from "../items/ConditionalStringValue";
-const isInstance = (args) => {
-    return !Array.isArray(args);
-};
-/**
- * Controls status bar items.
- * @internal
- */
-export class StatusBarItemsManager {
-    constructor(items) {
-        this._items = [];
-        /** Event raised when StatusBar items are changed.
-         * @internal
-         */
-        this.onItemsChanged = new BeEvent();
-        if (items)
-            this.loadItemsInternal(items, true, false);
-    }
-    loadItemsInternal(items, processConditions, sendItemChanged) {
-        if (processConditions && items) {
-            const eventIds = StatusBarItemsManager.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 an array of the StatusBar items  */
-    get items() {
-        return this._items;
-    }
-    set items(items) {
-        // istanbul ignore else
-        if (items !== this._items)
-            this.loadItemsInternal(items, true, true);
-    }
-    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;
-    }
-    /** Remove StatusBar items based on id */
-    remove(itemIdOrItemIds) {
-        const items = this._items.filter((item) => {
-            return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);
-        });
-        this.items = items;
-    }
-    /** @internal */
-    removeAll() {
-        this._items = [];
-    }
-    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);
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+const isInstance = (args) => {
+    return !Array.isArray(args);
+};
+/**
+ * Controls status bar items.
+ * @internal
+ */
+export class StatusBarItemsManager {
+    constructor(items) {
+        this._items = [];
+        /** Event raised when StatusBar items are changed.
+         * @internal
+         */
+        this.onItemsChanged = new BeEvent();
+        if (items)
+            this.loadItemsInternal(items, true, false);
+    }
+    loadItemsInternal(items, processConditions, sendItemChanged) {
+        if (processConditions && items) {
+            const eventIds = StatusBarItemsManager.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 an array of the StatusBar items  */
+    get items() {
+        return this._items;
+    }
+    set items(items) {
+        // istanbul ignore else
+        if (items !== this._items)
+            this.loadItemsInternal(items, true, true);
+    }
+    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;
+    }
+    /** Remove StatusBar items based on id */
+    remove(itemIdOrItemIds) {
+        const items = this._items.filter((item) => {
+            return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);
+        });
+        this.items = items;
+    }
+    /** @internal */
+    removeAll() {
+        this._items = [];
+    }
+    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=StatusBarItemsManager.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"StatusBarItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItemsManager.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;AAOzE,MAAM,UAAU,GAAG,CAAgB,IAAwB,EAAa,EAAE;IACxE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AASF;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAGhC,YAAY,KAA0C;QAF9C,WAAM,GAAuC,EAAE,CAAC;QAOxD;;WAEG;QACa,mBAAc,GAAG,IAAI,OAAO,EAA6C,CAAC;QAPxF,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAOO,iBAAiB,CAAC,KAAyC,EAAE,iBAA0B,EAAE,eAAwB;QACvH,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,KAAyC;QACxD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,2CAA2C;IAC3C,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAyC;QACxD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEM,GAAG,CAAC,WAAqE;QAC9E,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,yCAAyC;IAClC,MAAM,CAAC,eACb;QACC,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,SAAS;QACd,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,KAAqC;QACtE,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,KAAqC,EAAE,QAAqB;QAC/F,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,GAA0B,EAAE,CAAC;QAC3C,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;CACF","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 { BeEvent } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { CommonStatusBarItem, StatusBarItemId } from \"./StatusBarItem\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\ntype InstanceOrArray<T> = T | ReadonlyArray<T>;\r\n\r\nconst isInstance = <T extends any>(args: InstanceOrArray<T>): args is T => {\r\n  return !Array.isArray(args);\r\n};\r\n\r\n/** Arguments of [[StatusBarItemsManager.onChanged]] event.\r\n * @internal\r\n */\r\nexport interface StatusBarItemsChangedArgs {\r\n  readonly items: ReadonlyArray<CommonStatusBarItem>;\r\n}\r\n\r\n/**\r\n * Controls status bar items.\r\n * @internal\r\n */\r\nexport class StatusBarItemsManager {\r\n  private _items: ReadonlyArray<CommonStatusBarItem> = [];\r\n\r\n  constructor(items?: ReadonlyArray<CommonStatusBarItem>) {\r\n    if (items)\r\n      this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Event raised when StatusBar items are changed.\r\n   * @internal\r\n   */\r\n  public readonly onItemsChanged = new BeEvent<(args: StatusBarItemsChangedArgs) => void>();\r\n\r\n  private loadItemsInternal(items: ReadonlyArray<CommonStatusBarItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n    if (processConditions && items) {\r\n      const eventIds = StatusBarItemsManager.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<CommonStatusBarItem>) {\r\n    this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Get an array of the StatusBar items  */\r\n  public get items(): ReadonlyArray<CommonStatusBarItem> {\r\n    return this._items;\r\n  }\r\n\r\n  public set items(items: ReadonlyArray<CommonStatusBarItem>) {\r\n    // istanbul ignore else\r\n    if (items !== this._items)\r\n      this.loadItemsInternal(items, true, true);\r\n  }\r\n\r\n  public add(itemOrItems: CommonStatusBarItem | ReadonlyArray<CommonStatusBarItem>) {\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  /** Remove StatusBar items based on id */\r\n  public remove(itemIdOrItemIds: StatusBarItemId | ReadonlyArray<StatusBarItemId\r\n  >) {\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 removeAll() {\r\n    this._items = [];\r\n  }\r\n\r\n  public static getSyncIdsOfInterest(items: readonly CommonStatusBarItem[]): 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 CommonStatusBarItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: CommonStatusBarItem[] } {\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: CommonStatusBarItem[] = [];\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"]}
+{"version":3,"file":"StatusBarItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItemsManager.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;AAOzE,MAAM,UAAU,GAAG,CAAI,IAAwB,EAAa,EAAE;IAC5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AASF;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAGhC,YAAY,KAA0C;QAF9C,WAAM,GAAuC,EAAE,CAAC;QAOxD;;WAEG;QACa,mBAAc,GAAG,IAAI,OAAO,EAA6C,CAAC;QAPxF,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAOO,iBAAiB,CAAC,KAAyC,EAAE,iBAA0B,EAAE,eAAwB;QACvH,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,KAAyC;QACxD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,2CAA2C;IAC3C,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAyC;QACxD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEM,GAAG,CAAC,WAAqE;QAC9E,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,yCAAyC;IAClC,MAAM,CAAC,eACb;QACC,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,SAAS;QACd,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAC,KAAqC;QACtE,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,KAAqC,EAAE,QAAqB;QAC/F,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,GAA0B,EAAE,CAAC;QAC3C,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;CACF","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 { BeEvent } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { CommonStatusBarItem, StatusBarItemId } from \"./StatusBarItem\";\r\n\r\n/* eslint-disable deprecation/deprecation */\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/** Arguments of [[StatusBarItemsManager.onChanged]] event.\r\n * @internal\r\n */\r\nexport interface StatusBarItemsChangedArgs {\r\n  readonly items: ReadonlyArray<CommonStatusBarItem>;\r\n}\r\n\r\n/**\r\n * Controls status bar items.\r\n * @internal\r\n */\r\nexport class StatusBarItemsManager {\r\n  private _items: ReadonlyArray<CommonStatusBarItem> = [];\r\n\r\n  constructor(items?: ReadonlyArray<CommonStatusBarItem>) {\r\n    if (items)\r\n      this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Event raised when StatusBar items are changed.\r\n   * @internal\r\n   */\r\n  public readonly onItemsChanged = new BeEvent<(args: StatusBarItemsChangedArgs) => void>();\r\n\r\n  private loadItemsInternal(items: ReadonlyArray<CommonStatusBarItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n    if (processConditions && items) {\r\n      const eventIds = StatusBarItemsManager.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<CommonStatusBarItem>) {\r\n    this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Get an array of the StatusBar items  */\r\n  public get items(): ReadonlyArray<CommonStatusBarItem> {\r\n    return this._items;\r\n  }\r\n\r\n  public set items(items: ReadonlyArray<CommonStatusBarItem>) {\r\n    // istanbul ignore else\r\n    if (items !== this._items)\r\n      this.loadItemsInternal(items, true, true);\r\n  }\r\n\r\n  public add(itemOrItems: CommonStatusBarItem | ReadonlyArray<CommonStatusBarItem>) {\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  /** Remove StatusBar items based on id */\r\n  public remove(itemIdOrItemIds: StatusBarItemId | ReadonlyArray<StatusBarItemId\r\n  >) {\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 removeAll() {\r\n    this._items = [];\r\n  }\r\n\r\n  public static getSyncIdsOfInterest(items: readonly CommonStatusBarItem[]): 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 CommonStatusBarItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: CommonStatusBarItem[] } {\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: CommonStatusBarItem[] = [];\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"]}

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

@@ -1,122 +1,122 @@
-/** @packageDocumentation
- * @module Toolbar
- */
-import { BadgeType } from "../items/BadgeType";
-import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
-import { ConditionalStringValue } from "../items/ConditionalStringValue";
-import { ProvidedItem } from "../items/ProvidedItem";
-/** Used to specify the usage of the toolbar which determine the toolbar position.
- * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
- * @public
- */
-export declare enum ToolbarUsage {
-    /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */
-    ContentManipulation = 0,
-    /** Manipulate view/camera - in ninezone this is in top right of content area. */
-    ViewNavigation = 1
-}
-/** Used to specify the orientation of the toolbar.
- * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
- * @public
- */
-export declare enum ToolbarOrientation {
-    /** Horizontal toolbar. */
-    Horizontal = 0,
-    /** Vertical toolbar. */
-    Vertical = 1
-}
-/** Describes the data needed to insert a UI items into an existing set of UI items.
- * @public
- */
-export interface ToolbarItem extends ProvidedItem {
-    /** can be used by application to store miscellaneous data. */
-    readonly applicationData?: any;
-    /** Describes badge. Renders no badge if not specified. */
-    readonly badgeType?: BadgeType;
-    /** Optional description */
-    readonly description?: string | ConditionalStringValue;
-    /** Require uniqueId for 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>;
-    /** Defines if the item is active (shown with an active stripe/bar). */
-    readonly isActive?: boolean;
-    /** 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;
-    /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars
-     * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars
-     * the icon is usually changed to denote the state of a toggle.
-     */
-    readonly isPressed?: boolean;
-    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
-     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
-     * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.
-     */
-    readonly groupPriority?: number;
-    /** Priority within a toolbar or group. */
-    readonly itemPriority: number;
-    /** Optional parent tool group to add tool. */
-    readonly parentToolGroupId?: string;
-}
-/** Describes the data needed to insert an action button into a toolbar.
- * @public
- */
-export interface ActionButton extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
-    readonly icon: string | ConditionalStringValue;
-    /** label, shown as tool tip on a button or an item label in a group. */
-    readonly label: string | ConditionalStringValue;
-    /** function to run when the button is pressed. */
-    readonly execute: () => void;
-}
-/** Describes the data needed to insert a group button into a toolbar.
- * @public
- */
-export interface GroupButton extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
-    readonly icon: string | ConditionalStringValue;
-    /** label, shown as tool tip on group button or a group button label in a group panel. */
-    readonly label: string | ConditionalStringValue;
-    /** label shown as the title in at top of group panel. */
-    readonly panelLabel?: string | ConditionalStringValue;
-    /** children of the group */
-    readonly items: ReadonlyArray<ActionButton | GroupButton>;
-}
-/** Describes the data needed to insert a custom button into a toolbar.
- * @public
- */
-export interface CustomButtonDefinition extends ToolbarItem {
-    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
-    readonly icon?: string | ConditionalStringValue;
-    /** label, shown as tool tip on group button or a group button label in a group panel. */
-    readonly label?: string | ConditionalStringValue;
-    /** parameter that marks data as being a custom definition. */
-    readonly isCustom: true;
-}
-/** Any Button Type that can be inserted into a toolbar.
- * @public
- */
-export declare type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
-/** Type for Toolbar Item Id
- * @deprecated in 3.6. Please use `ToolbarItem["id"]` from @itwin/appui-react.
- * @public
- */
-export declare type ToolbarItemId = CommonToolbarItem["id"];
-/** Helper class to create Abstract StatusBar Item definitions.
- * @public
- */
-export declare class ToolbarItemUtilities {
-    /** Creates an Action Button */
-    static createActionButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton> | undefined) => ActionButton;
-    /** Creates a Group button. */
-    static createGroupButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton> | undefined) => GroupButton;
-    /** ActionButton type guard. */
-    static isActionButton(item: CommonToolbarItem): item is ActionButton;
-    /** GroupButton type guard. */
-    static isGroupButton(item: CommonToolbarItem): item is GroupButton;
-    /** CustomButtonDefinition type guard. */
-    static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition;
-}
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import { BadgeType } from "../items/BadgeType";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+import { ProvidedItem } from "../items/ProvidedItem";
+/** Used to specify the usage of the toolbar which determine the toolbar position.
+ * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
+ * @public
+ */
+export declare enum ToolbarUsage {
+    /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */
+    ContentManipulation = 0,
+    /** Manipulate view/camera - in ninezone this is in top right of content area. */
+    ViewNavigation = 1
+}
+/** Used to specify the orientation of the toolbar.
+ * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
+ * @public
+ */
+export declare enum ToolbarOrientation {
+    /** Horizontal toolbar. */
+    Horizontal = 0,
+    /** Vertical toolbar. */
+    Vertical = 1
+}
+/** Describes the data needed to insert a UI items into an existing set of UI items.
+ * @public
+ */
+export interface ToolbarItem extends ProvidedItem {
+    /** can be used by application to store miscellaneous data. */
+    readonly applicationData?: any;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badgeType?: BadgeType;
+    /** Optional description */
+    readonly description?: string | ConditionalStringValue;
+    /** Require uniqueId for 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>;
+    /** Defines if the item is active (shown with an active stripe/bar). */
+    readonly isActive?: boolean;
+    /** 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;
+    /** Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars
+     * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars
+     * the icon is usually changed to denote the state of a toggle.
+     */
+    readonly isPressed?: boolean;
+    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
+     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
+     * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.
+     */
+    readonly groupPriority?: number;
+    /** Priority within a toolbar or group. */
+    readonly itemPriority: number;
+    /** Optional parent tool group to add tool. */
+    readonly parentToolGroupId?: string;
+}
+/** Describes the data needed to insert an action button into a toolbar.
+ * @public
+ */
+export interface ActionButton extends ToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix  to imported symbol Id. */
+    readonly icon: string | ConditionalStringValue;
+    /** label, shown as tool tip on a button or an item label in a group. */
+    readonly label: string | ConditionalStringValue;
+    /** function to run when the button is pressed. */
+    readonly execute: () => void;
+}
+/** Describes the data needed to insert a group button into a toolbar.
+ * @public
+ */
+export interface GroupButton extends ToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon: string | ConditionalStringValue;
+    /** label, shown as tool tip on group button or a group button label in a group panel. */
+    readonly label: string | ConditionalStringValue;
+    /** label shown as the title in at top of group panel. */
+    readonly panelLabel?: string | ConditionalStringValue;
+    /** children of the group */
+    readonly items: ReadonlyArray<ActionButton | GroupButton>;
+}
+/** Describes the data needed to insert a custom button into a toolbar.
+ * @public
+ */
+export interface CustomButtonDefinition extends ToolbarItem {
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon?: string | ConditionalStringValue;
+    /** label, shown as tool tip on group button or a group button label in a group panel. */
+    readonly label?: string | ConditionalStringValue;
+    /** parameter that marks data as being a custom definition. */
+    readonly isCustom: true;
+}
+/** Any Button Type that can be inserted into a toolbar.
+ * @public
+ */
+export type CommonToolbarItem = ActionButton | GroupButton | CustomButtonDefinition;
+/** Type for Toolbar Item Id
+ * @deprecated in 3.6. Please use `ToolbarItem["id"]` from @itwin/appui-react.
+ * @public
+ */
+export type ToolbarItemId = CommonToolbarItem["id"];
+/** Helper class to create Abstract StatusBar Item definitions.
+ * @public
+ */
+export declare class ToolbarItemUtilities {
+    /** Creates an Action Button */
+    static createActionButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>) => ActionButton;
+    /** Creates a Group button. */
+    static createGroupButton: (id: string, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, items: ReadonlyArray<ActionButton | GroupButton>, overrides?: Partial<GroupButton>) => GroupButton;
+    /** ActionButton type guard. */
+    static isActionButton(item: CommonToolbarItem): item is ActionButton;
+    /** GroupButton type guard. */
+    static isGroupButton(item: CommonToolbarItem): item is GroupButton;
+    /** CustomButtonDefinition type guard. */
+    static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition;
+}
 //# sourceMappingURL=ToolbarItem.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,oBAAY,YAAY;IACtB,4GAA4G;IAC5G,mBAAmB,IAAI;IACvB,iFAAiF;IACjF,cAAc,IAAI;CACnB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,UAAU,IAAI;IACd,wBAAwB;IACxB,QAAQ,IAAI;CACb;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,8DAA8D;IAC9D,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,8CAA8C;IAC9C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,sHAAsH;IACtH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,qHAAqH;IACrH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yDAAyD;IACzD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACtD,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,sBAAsB,CAAC;AAEpF;;;GAGG;AACH,oBAAY,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAEpD;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,+BAA+B;IAC/B,OAAc,kBAAkB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,oDAAsC,YAAY,CAKvN;IAEH,8BAA8B;IAC9B,OAAc,iBAAiB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,SAAS,cAAc,YAAY,GAAG,WAAW,CAAC,mDAAqC,WAAW,CAKjP;IAEH,+BAA+B;WACjB,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,YAAY;IAI3E,8BAA8B;WAChB,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,WAAW;IAIzE,yCAAyC;WAC3B,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,sBAAsB;CAG1F"}
+{"version":3,"file":"ToolbarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,oBAAY,YAAY;IACtB,4GAA4G;IAC5G,mBAAmB,IAAI;IACvB,iFAAiF;IACjF,cAAc,IAAI;CACnB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,UAAU,IAAI;IACd,wBAAwB;IACxB,QAAQ,IAAI;CACb;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,8DAA8D;IAC9D,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACvD,iIAAiI;IACjI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,8CAA8C;IAC9C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,sHAAsH;IACtH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,qHAAqH;IACrH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAC/C,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yDAAyD;IACzD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACtD,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,GAAG,WAAW,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,yFAAyF;IACzF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,sBAAsB,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAEpD;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,+BAA+B;IAC/B,OAAc,kBAAkB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,cAAc,QAAQ,YAAY,CAAC,KAAG,YAAY,CAKvN;IAEH,8BAA8B;IAC9B,OAAc,iBAAiB,OAAQ,MAAM,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,SAAS,cAAc,YAAY,GAAG,WAAW,CAAC,cAAc,QAAQ,WAAW,CAAC,KAAG,WAAW,CAKjP;IAEH,+BAA+B;WACjB,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,YAAY;IAI3E,8BAA8B;WAChB,aAAa,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,WAAW;IAIzE,yCAAyC;WAC3B,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,sBAAsB;CAG1F"}