npm - @itwin/appui-abstract - Versions diffs - 4.1.0-dev.6 → 4.1.0-dev.7 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (129) hide show

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

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

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

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

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

@@ -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/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts.map ADDED Viewed

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

package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js ADDED Viewed

@@ -0,0 +1,136 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module StatusBar
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusBarItemsManager = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const ConditionalBooleanValue_1 = require("../items/ConditionalBooleanValue");
+const ConditionalStringValue_1 = require("../items/ConditionalStringValue");
+const isInstance = (args) => {
+    return !Array.isArray(args);
+};
+/**
+ * Controls status bar items.
+ * @internal
+ */
+class StatusBarItemsManager {
+    constructor(items) {
+        this._items = [];
+        /** Event raised when StatusBar items are changed.
+         * @internal
+         */
+        this.onItemsChanged = new core_bentley_1.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_1.ConditionalBooleanValue) {
+                    entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
+                }
+                else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue_1.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_1.ConditionalBooleanValue) {
+                    // istanbul ignore else
+                    if (ConditionalBooleanValue_1.ConditionalBooleanValue.refreshValue(entry, eventIds))
+                        updateRequired = true;
+                }
+                else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue_1.ConditionalStringValue) {
+                    // istanbul ignore else
+                    if (ConditionalStringValue_1.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);
+    }
+}
+exports.StatusBarItemsManager = StatusBarItemsManager;
+//# sourceMappingURL=StatusBarItemsManager.js.map

package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"StatusBarItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItemsManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA8C;AAC9C,8EAA2E;AAC3E,4EAAyE;AAOzE,MAAM,UAAU,GAAG,CAAI,IAAwB,EAAa,EAAE;IAC5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AASF;;;GAGG;AACH,MAAa,qBAAqB;IAGhC,YAAY,KAA0C;QAF9C,WAAM,GAAuC,EAAE,CAAC;QAOxD;;WAEG;QACa,mBAAc,GAAG,IAAI,sBAAO,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,iDAAuB,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,+CAAsB,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,iDAAuB,EAAE;oBAC5C,uBAAuB;oBACvB,IAAI,iDAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACvD,cAAc,GAAG,IAAI,CAAC;iBACzB;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,+CAAsB,EAAE;oBAC7E,uBAAuB;oBACvB,IAAI,+CAAsB,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;AArID,sDAqIC","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/cjs/appui-abstract/toolbars/ToolbarItem.d.ts CHANGED Viewed

@@ -4,10 +4,31 @@
 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 {
+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. */
@@ -78,6 +99,11 @@ export interface CustomButtonDefinition extends ToolbarItem {
  * @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
  */

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts.map CHANGED Viewed

	@@ -1 +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;~~AAEzE~~;;GAEG;AACH,MAAM,WAAW,~~WAAW~~;~~IAC1B~~,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;;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"}
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,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"}

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js CHANGED Viewed

@@ -7,7 +7,29 @@
  * @module Toolbar
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolbarItemUtilities = void 0;
+exports.ToolbarItemUtilities = exports.ToolbarOrientation = exports.ToolbarUsage = void 0;
+/** Used to specify the usage of the toolbar which determine the toolbar position.
+ * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.
+ * @public
+ */
+var ToolbarUsage;
+(function (ToolbarUsage) {
+    /** Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. */
+    ToolbarUsage[ToolbarUsage["ContentManipulation"] = 0] = "ContentManipulation";
+    /** Manipulate view/camera - in ninezone this is in top right of content area. */
+    ToolbarUsage[ToolbarUsage["ViewNavigation"] = 1] = "ViewNavigation";
+})(ToolbarUsage = exports.ToolbarUsage || (exports.ToolbarUsage = {}));
+/** Used to specify the orientation of the toolbar.
+ * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.
+ * @public
+ */
+var ToolbarOrientation;
+(function (ToolbarOrientation) {
+    /** Horizontal toolbar. */
+    ToolbarOrientation[ToolbarOrientation["Horizontal"] = 0] = "Horizontal";
+    /** Vertical toolbar. */
+    ToolbarOrientation[ToolbarOrientation["Vertical"] = 1] = "Vertical";
+})(ToolbarOrientation = exports.ToolbarOrientation || (exports.ToolbarOrientation = {}));
 /** Helper class to create Abstract StatusBar Item definitions.
  * @public
  */

package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;~~AAqFH~~;;GAEG;AACH,MAAa,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA7BD,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,CAAC;AAfQ,oDAAoB","sourcesContent":["/---------------------------------------------------------------------------------------------\r\n Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n--------------------------------------------------------------------------------------------/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n /\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\n\r\n/* Describes the data needed to insert a UI items into an existing set of UI items.\r\n * @public\r\n /\r\nexport interface ToolbarItem {\r\n /* can be used by application to store miscellaneous data. /\r\n readonly applicationData?: any;\r\n /* Describes badge. Renders no badge if not specified. /\r\n readonly badgeType?: BadgeType;\r\n /* Optional description /\r\n readonly description?: string \| ConditionalStringValue;\r\n /* Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. /\r\n readonly id: string;\r\n /* optional data to used by item implementor. /\r\n readonly internalData?: Map<string, any>;\r\n /* Defines if the item is active (shown with an active stripe/bar). /\r\n readonly isActive?: boolean;\r\n /* Describes if the item is visible or hidden. The default is for the item to be visible. /\r\n readonly isHidden?: boolean \| ConditionalBooleanValue;\r\n /* Describes if the item is enabled or disabled. The default is for the item to be enabled. /\r\n readonly isDisabled?: boolean \| ConditionalBooleanValue;\r\n /* Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\r\n * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\r\n * the icon is usually changed to denote the state of a toggle.\r\n /\r\n readonly isPressed?: boolean;\r\n /* Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\r\n /\r\n readonly groupPriority?: number;\r\n /* Priority within a toolbar or group. /\r\n readonly itemPriority: number;\r\n /* Optional parent tool group to add tool. /\r\n readonly parentToolGroupId?: string;\r\n}\r\n\r\n/* Describes the data needed to insert an action button into a toolbar.\r\n * @public\r\n /\r\nexport interface ActionButton extends ToolbarItem {\r\n /* Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. /\r\n readonly icon: string \| ConditionalStringValue;\r\n /* label, shown as tool tip on a button or an item label in a group. /\r\n readonly label: string \| ConditionalStringValue;\r\n /* function to run when the button is pressed. /\r\n readonly execute: () => void;\r\n}\r\n\r\n/* Describes the data needed to insert a group button into a toolbar.\r\n * @public\r\n /\r\nexport interface GroupButton extends ToolbarItem {\r\n /* Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. /\r\n readonly icon: string \| ConditionalStringValue;\r\n /* label, shown as tool tip on group button or a group button label in a group panel. /\r\n readonly label: string \| ConditionalStringValue;\r\n /* label shown as the title in at top of group panel. /\r\n readonly panelLabel?: string \| ConditionalStringValue;\r\n /* children of the group /\r\n readonly items: ReadonlyArray<ActionButton \| GroupButton>; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/* Describes the data needed to insert a custom button into a toolbar.\r\n * @public\r\n /\r\nexport interface CustomButtonDefinition extends ToolbarItem {\r\n /* Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. /\r\n readonly icon?: string \| ConditionalStringValue;\r\n /* label, shown as tool tip on group button or a group button label in a group panel. /\r\n readonly label?: string \| ConditionalStringValue;\r\n /* parameter that marks data as being a custom definition. /\r\n readonly isCustom: true;\r\n}\r\n\r\n/* Any Button Type that can be inserted into a toolbar.\r\n * @public\r\n /\r\nexport type CommonToolbarItem = ActionButton \| GroupButton \| CustomButtonDefinition;\r\n\r\n/* Helper class to create Abstract StatusBar Item definitions.\r\n * @public\r\n /\r\nexport class ToolbarItemUtilities {\r\n /* Creates an Action Button /\r\n public static createActionButton = (id: string, itemPriority: number, icon: string \| ConditionalStringValue, label: string \| ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\r\n id, itemPriority,\r\n icon, label,\r\n execute,\r\n ...overrides,\r\n });\r\n\r\n /* Creates a Group button. /\r\n public static createGroupButton = (id: string, itemPriority: number, icon: string \| ConditionalStringValue, label: string \| ConditionalStringValue, items: ReadonlyArray<ActionButton \| GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\r\n id, itemPriority,\r\n icon, label,\r\n items,\r\n ...overrides,\r\n });\r\n\r\n /* ActionButton type guard. /\r\n public static isActionButton(item: CommonToolbarItem): item is ActionButton {\r\n return (item as ActionButton).execute !== undefined;\r\n }\r\n\r\n /* GroupButton type guard. /\r\n public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\r\n return (item as GroupButton).items !== undefined;\r\n }\r\n\r\n /* CustomButtonDefinition type guard. */\r\n public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\r\n return !!(item as CustomButtonDefinition).isCustom;\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"ToolbarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,4GAA4G;IAC5G,6EAAuB,CAAA;IACvB,iFAAiF;IACjF,mEAAkB,CAAA;AACpB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uEAAc,CAAA;IACd,wBAAwB;IACxB,mEAAY,CAAA;AACd,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B;AAuFD;;GAEG;AACH,MAAa,oBAAoB;IAiB/B,+BAA+B;IACxB,MAAM,CAAC,cAAc,CAAC,IAAuB;QAClD,OAAQ,IAAqB,CAAC,OAAO,KAAK,SAAS,CAAC;IACtD,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,aAAa,CAAC,IAAuB;QACjD,OAAQ,IAAoB,CAAC,KAAK,KAAK,SAAS,CAAC;IACnD,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB,CAAC,IAAuB;QACtD,OAAO,CAAC,CAAE,IAA+B,CAAC,QAAQ,CAAC;IACrD,CAAC;;AA7BD,+BAA+B;AACjB,uCAAkB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,OAAmB,EAAE,SAAiC,EAAgB,EAAE,CAAC,CAAC;IAC7N,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,8BAA8B;AAChB,sCAAiB,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,KAAgD,EAAE,SAAgC,EAAe,EAAE,CAAC,CAAC;IACvP,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,KAAK;IACX,KAAK;IACL,GAAG,SAAS;CACb,CAAC,CAAC;AAfQ,oDAAoB","sourcesContent":["/---------------------------------------------------------------------------------------------\r\n Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n--------------------------------------------------------------------------------------------/\r\n/** @packageDocumentation\r\n * @module Toolbar\r\n /\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/* Used to specify the usage of the toolbar which determine the toolbar position.\r\n * @deprecated in 3.6. Use [ToolbarUsage]($appui-react) instead.\r\n * @public\r\n /\r\nexport enum ToolbarUsage {\r\n /* Contains tools to Create Update and Delete content - in ninezone this is in top left of content area. /\r\n ContentManipulation = 0,\r\n /* Manipulate view/camera - in ninezone this is in top right of content area. /\r\n ViewNavigation = 1,\r\n}\r\n\r\n/* Used to specify the orientation of the toolbar.\r\n * @deprecated in 3.6. Use [ToolbarOrientation]($appui-react) instead.\r\n * @public\r\n /\r\nexport enum ToolbarOrientation {\r\n /* Horizontal toolbar. /\r\n Horizontal = 0,\r\n /* Vertical toolbar. /\r\n Vertical = 1,\r\n}\r\n\r\n/* Describes the data needed to insert a UI items into an existing set of UI items.\r\n * @public\r\n /\r\nexport interface ToolbarItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n /* can be used by application to store miscellaneous data. /\r\n readonly applicationData?: any;\r\n /* Describes badge. Renders no badge if not specified. /\r\n readonly badgeType?: BadgeType;\r\n /* Optional description /\r\n readonly description?: string \| ConditionalStringValue;\r\n /* Require uniqueId for the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. /\r\n readonly id: string;\r\n /* optional data to used by item implementor. /\r\n readonly internalData?: Map<string, any>;\r\n /* Defines if the item is active (shown with an active stripe/bar). /\r\n readonly isActive?: boolean;\r\n /* Describes if the item is visible or hidden. The default is for the item to be visible. /\r\n readonly isHidden?: boolean \| ConditionalBooleanValue;\r\n /* Describes if the item is enabled or disabled. The default is for the item to be enabled. /\r\n readonly isDisabled?: boolean \| ConditionalBooleanValue;\r\n /* Describes if the item should appear pressed (used for displaying toggle state). This property is NOT used by Toolbars\r\n * constructed using the `ToolbarWithOverflow` component, which are used in AppUi 2.0 and later. For these later toolbars\r\n * the icon is usually changed to denote the state of a toggle.\r\n /\r\n readonly isPressed?: boolean;\r\n /* Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n * allows extensions enough gaps to insert their own groups. If the value is not specified a groupPriority of 0 is used.\r\n /\r\n readonly groupPriority?: number;\r\n /* Priority within a toolbar or group. /\r\n readonly itemPriority: number;\r\n /* Optional parent tool group to add tool. /\r\n readonly parentToolGroupId?: string;\r\n}\r\n\r\n/* Describes the data needed to insert an action button into a toolbar.\r\n * @public\r\n /\r\nexport interface ActionButton extends ToolbarItem {\r\n /* Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. /\r\n readonly icon: string \| ConditionalStringValue;\r\n /* label, shown as tool tip on a button or an item label in a group. /\r\n readonly label: string \| ConditionalStringValue;\r\n /* function to run when the button is pressed. /\r\n readonly execute: () => void;\r\n}\r\n\r\n/* Describes the data needed to insert a group button into a toolbar.\r\n * @public\r\n /\r\nexport interface GroupButton extends ToolbarItem {\r\n /* Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. /\r\n readonly icon: string \| ConditionalStringValue;\r\n /* label, shown as tool tip on group button or a group button label in a group panel. /\r\n readonly label: string \| ConditionalStringValue;\r\n /* label shown as the title in at top of group panel. /\r\n readonly panelLabel?: string \| ConditionalStringValue;\r\n /* children of the group /\r\n readonly items: ReadonlyArray<ActionButton \| GroupButton>; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/* Describes the data needed to insert a custom button into a toolbar.\r\n * @public\r\n /\r\nexport interface CustomButtonDefinition extends ToolbarItem {\r\n /* Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. /\r\n readonly icon?: string \| ConditionalStringValue;\r\n /* label, shown as tool tip on group button or a group button label in a group panel. /\r\n readonly label?: string \| ConditionalStringValue;\r\n /* parameter that marks data as being a custom definition. /\r\n readonly isCustom: true;\r\n}\r\n\r\n/* Any Button Type that can be inserted into a toolbar.\r\n * @public\r\n /\r\nexport type CommonToolbarItem = ActionButton \| GroupButton \| CustomButtonDefinition;\r\n\r\n/* Type for Toolbar Item Id\r\n * @deprecated in 3.6. Please use `ToolbarItem[\"id\"]` from @itwin/appui-react.\r\n * @public\r\n /\r\nexport type ToolbarItemId = CommonToolbarItem[\"id\"]; // eslint-disable-line deprecation/deprecation\r\n\r\n/* Helper class to create Abstract StatusBar Item definitions.\r\n * @public\r\n /\r\nexport class ToolbarItemUtilities {\r\n /* Creates an Action Button /\r\n public static createActionButton = (id: string, itemPriority: number, icon: string \| ConditionalStringValue, label: string \| ConditionalStringValue, execute: () => void, overrides?: Partial<ActionButton>): ActionButton => ({\r\n id, itemPriority,\r\n icon, label,\r\n execute,\r\n ...overrides,\r\n });\r\n\r\n /* Creates a Group button. /\r\n public static createGroupButton = (id: string, itemPriority: number, icon: string \| ConditionalStringValue, label: string \| ConditionalStringValue, items: ReadonlyArray<ActionButton \| GroupButton>, overrides?: Partial<GroupButton>): GroupButton => ({\r\n id, itemPriority,\r\n icon, label,\r\n items,\r\n ...overrides,\r\n });\r\n\r\n /* ActionButton type guard. /\r\n public static isActionButton(item: CommonToolbarItem): item is ActionButton {\r\n return (item as ActionButton).execute !== undefined;\r\n }\r\n\r\n /* GroupButton type guard. /\r\n public static isGroupButton(item: CommonToolbarItem): item is GroupButton {\r\n return (item as GroupButton).items !== undefined;\r\n }\r\n\r\n /* CustomButtonDefinition type guard. */\r\n public static isCustomDefinition(item: CommonToolbarItem): item is CustomButtonDefinition {\r\n return !!(item as CustomButtonDefinition).isCustom;\r\n }\r\n}\r\n"]}

package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts ADDED Viewed

@@ -0,0 +1,46 @@
+/** @packageDocumentation
+ * @module Toolbar
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { CommonToolbarItem, ToolbarItemId } from "./ToolbarItem";
+/** Arguments of [[ToolbarItemsManager.onChanged]] event.
+ * @internal
+ */
+export interface ToolbarItemsChangedArgs {
+    readonly items: ReadonlyArray<CommonToolbarItem>;
+}
+/**
+ * Controls status bar items.
+ * @internal
+ */
+export declare class ToolbarItemsManager {
+    protected _items: ReadonlyArray<CommonToolbarItem>;
+    constructor(items?: ReadonlyArray<CommonToolbarItem>);
+    /** Event raised when Toolbar items are changed.
+     * @internal
+     */
+    readonly onItemsChanged: BeEvent<(args: ToolbarItemsChangedArgs) => void>;
+    private loadItemsInternal;
+    /** load items but do not fire onItemsChanged
+     * @internal
+     */
+    loadItems(items: ReadonlyArray<CommonToolbarItem>): void;
+    /** Get an array of the Toolbar items  */
+    get items(): ReadonlyArray<CommonToolbarItem>;
+    set items(items: ReadonlyArray<CommonToolbarItem>);
+    add(itemOrItems: CommonToolbarItem | ReadonlyArray<CommonToolbarItem>): void;
+    /** Remove Toolbar items based on id */
+    remove(itemIdOrItemIds: ToolbarItemId | ReadonlyArray<ToolbarItemId>): void;
+    /** @internal */
+    removeAll(): void;
+    private static gatherSyncIds;
+    static getSyncIdsOfInterest(items: readonly CommonToolbarItem[]): string[];
+    private static refreshChildItems;
+    private internalRefreshAffectedItems;
+    refreshAffectedItems(eventIds: Set<string>): void;
+    private static isActiveToolIdRefreshRequiredForChildren;
+    private isActiveToolIdRefreshRequired;
+    private static refreshActiveToolIdInChildItems;
+    setActiveToolId(toolId: string): void;
+}
+//# sourceMappingURL=ToolbarItemsManager.d.ts.map

package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"ToolbarItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/toolbars/ToolbarItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAgB,iBAAiB,EAAe,aAAa,EAAwB,MAAM,eAAe,CAAC;AAUlH;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;CAClD;AAED;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAM;gBAE5C,KAAK,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;IAKpD;;OAEG;IACH,SAAgB,cAAc,iBAAsB,uBAAuB,KAAK,IAAI,EAAI;IAExF,OAAO,CAAC,iBAAiB;IAiBzB;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,CAAC;IAIxD,yCAAyC;IACzC,IAAW,KAAK,IAAI,aAAa,CAAC,iBAAiB,CAAC,CAEnD;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,CAAC,EAIvD;IAEM,GAAG,CAAC,WAAW,EAAE,iBAAiB,GAAG,aAAa,CAAC,iBAAiB,CAAC;IAiB5E,uCAAuC;IAChC,MAAM,CAAC,eAAe,EAAE,aAAa,GAAG,aAAa,CAAC,aAAa,CACzE;IAOD,gBAAgB;IACT,SAAS;IAIhB,OAAO,CAAC,MAAM,CAAC,aAAa;WAiBd,oBAAoB,CAAC,KAAK,EAAE,SAAS,iBAAiB,EAAE,GAAG,MAAM,EAAE;IAMjF,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAiChC,OAAO,CAAC,4BAA4B;IAsC7B,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC;IAYjD,OAAO,CAAC,MAAM,CAAC,wCAAwC;IAcvD,OAAO,CAAC,6BAA6B;IAerC,OAAO,CAAC,MAAM,CAAC,+BAA+B;IAevC,eAAe,CAAC,MAAM,EAAE,MAAM;CAoBtC"}