@itwin/appui-abstract 3.0.0-dev.98 → 3.0.0

package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts

@@ -0,0 +1,47 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { UiEvent } from "./UiEvent";
+/** UiSync Event arguments. Contains a set of lower case event Ids.
+ * @public
+ */
+export interface UiSyncEventArgs {
+    eventIds: Set<string>;
+}
+/** UiSync Event class.
+ * @public
+ */
+export declare class UiSyncEvent extends UiEvent<UiSyncEventArgs> {
+}
+/** This class is used to send eventIds to interested UI components so the component can determine if it needs
+ * to refresh its display by calling setState on itself.
+ * @public
+ */
+export declare class UiEventDispatcher {
+    private _syncEventTimerId;
+    private _eventIds;
+    private _eventIdAdded;
+    private _uiSyncEvent;
+    private _timeoutPeriod;
+    private _secondaryTimeoutPeriod;
+    constructor();
+    /** @internal - used for testing only */
+    setTimeoutPeriod(period: number): void;
+    /** The current timeout period */
+    get timeoutPeriod(): number;
+    /** Return set of event ids that will be sent to listeners/. */
+    get syncEventIds(): Set<string>;
+    /** Return UiSyncEvent so callers can register an event callback. */
+    get onSyncUiEvent(): UiSyncEvent;
+    /** Immediately trigger sync event processing. */
+    dispatchImmediateSyncUiEvent(eventId: string): void;
+    /** Save eventId in Set for processing. */
+    dispatchSyncUiEvent(eventId: string): void;
+    /** Save multiple eventIds in Set for processing. */
+    dispatchSyncUiEvents(eventIds: string[]): void;
+    /** Trigger registered event processing when timer has expired and no addition eventId are added. */
+    checkForAdditionalIds(): void;
+    /** Checks to see if an eventId of interest is contained in the set of eventIds */
+    hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]): boolean;
+}
+//# sourceMappingURL=UiEventDispatcher.d.ts.map

package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiEventDispatcher.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/UiEventDispatcher.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,OAAO,CAAC,eAAe,CAAC;CAAI;AAE7D;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,aAAa,CAAC;IACtB,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,cAAc,CAAC;IACvB,OAAO,CAAC,uBAAuB,CAAC;;IAUhC,wCAAwC;IAEjC,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAe7C,iCAAiC;IACjC,IAAW,aAAa,IAAI,MAAM,CAEjC;IACD,+DAA+D;IAC/D,IAAW,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,CAErC;IAED,oEAAoE;IACpE,IAAW,aAAa,IAAI,WAAW,CAEtC;IAED,iDAAiD;IAC1C,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM1D,0CAA0C;IACnC,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAcjD,oDAAoD;IAC7C,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAerD,oGAAoG;IAC7F,qBAAqB;IA+B5B,kFAAkF;IAC3E,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE;CAMzE"}

package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js

@@ -0,0 +1,132 @@
+"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 Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UiEventDispatcher = exports.UiSyncEvent = void 0;
+// cSpell:ignore configurableui
+const UiEvent_1 = require("./UiEvent");
+/** UiSync Event class.
+ * @public
+ */
+class UiSyncEvent extends UiEvent_1.UiEvent {
+}
+exports.UiSyncEvent = UiSyncEvent;
+/** This class is used to send eventIds to interested UI components so the component can determine if it needs
+ * to refresh its display by calling setState on itself.
+ * @public
+ */
+class UiEventDispatcher {
+    constructor() {
+        this._eventIds = new Set();
+        this._eventIdAdded = false;
+        this._uiSyncEvent = new UiSyncEvent();
+        this._timeoutPeriod = 100;
+        this._secondaryTimeoutPeriod = this._timeoutPeriod / 2;
+    }
+    /** @internal - used for testing only */
+    /* istanbul ignore next */
+    setTimeoutPeriod(period) {
+        this._timeoutPeriod = period;
+        this._secondaryTimeoutPeriod = Math.floor(this._timeoutPeriod / 2);
+        if (this._secondaryTimeoutPeriod < 1)
+            this._secondaryTimeoutPeriod = 1;
+        if (this._syncEventTimerId) {
+            window.clearTimeout(this._syncEventTimerId);
+            this._syncEventTimerId = undefined;
+        }
+        if (this._eventIds)
+            this._eventIds.clear();
+        this._eventIdAdded = false;
+    }
+    /** The current timeout period */
+    get timeoutPeriod() {
+        return this._timeoutPeriod;
+    }
+    /** Return set of event ids that will be sent to listeners/. */
+    get syncEventIds() {
+        return this._eventIds;
+    }
+    /** Return UiSyncEvent so callers can register an event callback. */
+    get onSyncUiEvent() {
+        return this._uiSyncEvent;
+    }
+    /** Immediately trigger sync event processing. */
+    dispatchImmediateSyncUiEvent(eventId) {
+        const eventIds = new Set();
+        eventIds.add(eventId.toLowerCase());
+        this.onSyncUiEvent.emit({ eventIds });
+    }
+    /** Save eventId in Set for processing. */
+    dispatchSyncUiEvent(eventId) {
+        // istanbul ignore if
+        if (0 === this._timeoutPeriod) {
+            return;
+        }
+        this.syncEventIds.add(eventId.toLowerCase());
+        if (!this._syncEventTimerId) { // if there is not a timer active, create one
+            this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._timeoutPeriod);
+        }
+        else {
+            this._eventIdAdded = true;
+        }
+    }
+    /** Save multiple eventIds in Set for processing. */
+    dispatchSyncUiEvents(eventIds) {
+        // istanbul ignore if
+        if (0 === this._timeoutPeriod) {
+            return;
+        }
+        eventIds.forEach((id) => this.syncEventIds.add(id.toLowerCase()));
+        // istanbul ignore else
+        if (!this._syncEventTimerId) { // if there is not a timer active, create one
+            this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._timeoutPeriod);
+        }
+        else {
+            this._eventIdAdded = true;
+        }
+    }
+    /** Trigger registered event processing when timer has expired and no addition eventId are added. */
+    checkForAdditionalIds() {
+        /* istanbul ignore else */
+        if (!this._eventIdAdded) {
+            // istanbul ignore else
+            if (this._syncEventTimerId) {
+                window.clearTimeout(this._syncEventTimerId);
+                this._syncEventTimerId = undefined;
+            }
+            this._eventIdAdded = false;
+            // istanbul ignore else
+            if (this.syncEventIds.size > 0) {
+                const eventIds = new Set();
+                this.syncEventIds.forEach((value) => eventIds.add(value));
+                this._eventIds.clear();
+                this.onSyncUiEvent.emit({ eventIds });
+            }
+            return;
+        }
+        // istanbul ignore next
+        if (this._syncEventTimerId) {
+            window.clearTimeout(this._syncEventTimerId);
+            this._syncEventTimerId = undefined;
+        }
+        // istanbul ignore next
+        this._eventIdAdded = false;
+        // if events have been added before the initial timer expired wait half that time to see if events are still being added.
+        // istanbul ignore next
+        this._syncEventTimerId = window.setTimeout(() => { this.checkForAdditionalIds(); }, this._secondaryTimeoutPeriod);
+    }
+    /** Checks to see if an eventId of interest is contained in the set of eventIds */
+    hasEventOfInterest(eventIds, idsOfInterest) {
+        /* istanbul ignore else */
+        if ((idsOfInterest.length > 0) && idsOfInterest.some((value) => eventIds.has(value.toLowerCase())))
+            return true;
+        return false;
+    }
+}
+exports.UiEventDispatcher = UiEventDispatcher;
+//# sourceMappingURL=UiEventDispatcher.js.map

package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/UiEventDispatcher.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,uCAAoC;AASpC;;GAEG;AACH,MAAa,WAAY,SAAQ,iBAAwB;CAAI;AAA7D,kCAA6D;AAE7D;;;GAGG;AACH,MAAa,iBAAiB;IAQ5B;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;QAC1B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;IACzD,CAAC;IAED,wCAAwC;IACxC,0BAA0B;IACnB,gBAAgB,CAAC,MAAc;QACpC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;QAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,uBAAuB,GAAG,CAAC;YAClC,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,SAAS;YAChB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAEzB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC7B,CAAC;IAED,iCAAiC;IACjC,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,+DAA+D;IAC/D,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,oEAAoE;IACpE,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,iDAAiD;IAC1C,4BAA4B,CAAC,OAAe;QACjD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,0CAA0C;IACnC,mBAAmB,CAAC,OAAe;QACxC,qBAAqB;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;YAC7B,OAAO;SACR;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAG,6CAA6C;YAC3E,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACxG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;IACH,CAAC;IAED,oDAAoD;IAC7C,oBAAoB,CAAC,QAAkB;QAC5C,qBAAqB;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;YAC7B,OAAO;SACR;QAED,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAClE,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAG,6CAA6C;YAC3E,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACxG;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;SAC3B;IACH,CAAC;IAED,oGAAoG;IAC7F,qBAAqB;QAC1B,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,uBAAuB;YACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE;gBAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;aACpC;YACD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,uBAAuB;YACvB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE;gBAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;gBACnC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;aACvC;YACD,OAAO;SACR;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,uBAAuB;QACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,yHAAyH;QACzH,uBAAuB;QACvB,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,GAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAA,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IAClH,CAAC;IAED,kFAAkF;IAC3E,kBAAkB,CAAC,QAAqB,EAAE,aAAuB;QACtE,0BAA0B;QAC1B,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;YACjH,OAAO,IAAI,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA5HD,8CA4HC","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 Utilities\r\n */\r\n\r\n// cSpell:ignore configurableui\r\nimport { UiEvent } from \"./UiEvent\";\r\n\r\n/** UiSync Event arguments. Contains a set of lower case event Ids.\r\n * @public\r\n */\r\nexport interface UiSyncEventArgs {\r\n  eventIds: Set<string>;\r\n}\r\n\r\n/** UiSync Event class.\r\n * @public\r\n */\r\nexport class UiSyncEvent extends UiEvent<UiSyncEventArgs> { }\r\n\r\n/** This class is used to send eventIds to interested UI components so the component can determine if it needs\r\n * to refresh its display by calling setState on itself.\r\n * @public\r\n */\r\nexport class UiEventDispatcher {\r\n  private _syncEventTimerId: number | undefined;\r\n  private _eventIds: Set<string>;\r\n  private _eventIdAdded;\r\n  private _uiSyncEvent: UiSyncEvent;\r\n  private _timeoutPeriod;\r\n  private _secondaryTimeoutPeriod;\r\n\r\n  constructor() {\r\n    this._eventIds = new Set<string>();\r\n    this._eventIdAdded = false;\r\n    this._uiSyncEvent = new UiSyncEvent();\r\n    this._timeoutPeriod = 100;\r\n    this._secondaryTimeoutPeriod = this._timeoutPeriod / 2;\r\n  }\r\n\r\n  /** @internal - used for testing only */\r\n  /* istanbul ignore next */\r\n  public setTimeoutPeriod(period: number): void {\r\n    this._timeoutPeriod = period;\r\n    this._secondaryTimeoutPeriod = Math.floor(this._timeoutPeriod / 2);\r\n    if (this._secondaryTimeoutPeriod < 1)\r\n      this._secondaryTimeoutPeriod = 1;\r\n    if (this._syncEventTimerId) {\r\n      window.clearTimeout(this._syncEventTimerId);\r\n      this._syncEventTimerId = undefined;\r\n    }\r\n    if (this._eventIds)\r\n      this._eventIds.clear();\r\n\r\n    this._eventIdAdded = false;\r\n  }\r\n\r\n  /** The current timeout period */\r\n  public get timeoutPeriod(): number {\r\n    return this._timeoutPeriod;\r\n  }\r\n  /** Return set of event ids that will be sent to listeners/. */\r\n  public get syncEventIds(): Set<string> {\r\n    return this._eventIds;\r\n  }\r\n\r\n  /** Return UiSyncEvent so callers can register an event callback. */\r\n  public get onSyncUiEvent(): UiSyncEvent {\r\n    return this._uiSyncEvent;\r\n  }\r\n\r\n  /** Immediately trigger sync event processing. */\r\n  public dispatchImmediateSyncUiEvent(eventId: string): void {\r\n    const eventIds = new Set<string>();\r\n    eventIds.add(eventId.toLowerCase());\r\n    this.onSyncUiEvent.emit({ eventIds });\r\n  }\r\n\r\n  /** Save eventId in Set for processing. */\r\n  public dispatchSyncUiEvent(eventId: string): void {\r\n    // istanbul ignore if\r\n    if (0 === this._timeoutPeriod) {\r\n      return;\r\n    }\r\n\r\n    this.syncEventIds.add(eventId.toLowerCase());\r\n    if (!this._syncEventTimerId) {  // if there is not a timer active, create one\r\n      this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._timeoutPeriod);\r\n    } else {\r\n      this._eventIdAdded = true;\r\n    }\r\n  }\r\n\r\n  /** Save multiple eventIds in Set for processing. */\r\n  public dispatchSyncUiEvents(eventIds: string[]): void {\r\n    // istanbul ignore if\r\n    if (0 === this._timeoutPeriod) {\r\n      return;\r\n    }\r\n\r\n    eventIds.forEach((id) => this.syncEventIds.add(id.toLowerCase()));\r\n    // istanbul ignore else\r\n    if (!this._syncEventTimerId) {  // if there is not a timer active, create one\r\n      this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._timeoutPeriod);\r\n    } else {\r\n      this._eventIdAdded = true;\r\n    }\r\n  }\r\n\r\n  /** Trigger registered event processing when timer has expired and no addition eventId are added. */\r\n  public checkForAdditionalIds() {\r\n    /* istanbul ignore else */\r\n    if (!this._eventIdAdded) {\r\n      // istanbul ignore else\r\n      if (this._syncEventTimerId) {\r\n        window.clearTimeout(this._syncEventTimerId);\r\n        this._syncEventTimerId = undefined;\r\n      }\r\n      this._eventIdAdded = false;\r\n      // istanbul ignore else\r\n      if (this.syncEventIds.size > 0) {\r\n        const eventIds = new Set<string>();\r\n        this.syncEventIds.forEach((value) => eventIds.add(value));\r\n        this._eventIds.clear();\r\n        this.onSyncUiEvent.emit({ eventIds });\r\n      }\r\n      return;\r\n    }\r\n\r\n    // istanbul ignore next\r\n    if (this._syncEventTimerId) {\r\n      window.clearTimeout(this._syncEventTimerId);\r\n      this._syncEventTimerId = undefined;\r\n    }\r\n    // istanbul ignore next\r\n    this._eventIdAdded = false;\r\n    // if events have been added before the initial timer expired wait half that time to see if events are still being added.\r\n    // istanbul ignore next\r\n    this._syncEventTimerId = window.setTimeout(() => {this.checkForAdditionalIds();}, this._secondaryTimeoutPeriod);\r\n  }\r\n\r\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\r\n  public hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]) {\r\n    /* istanbul ignore else */\r\n    if ((idsOfInterest.length > 0) && idsOfInterest.some((value: string): boolean => eventIds.has(value.toLowerCase())))\r\n      return true;\r\n    return false;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts

@@ -13,7 +13,7 @@ export interface AbstractWidgetProps extends ProvidedItem {
     readonly getWidgetContent: () => any;
     /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. */
     readonly icon?: string | ConditionalStringValue;
-    /** Optional Id used to uniquely identify the widget.
+    /** Id used to uniquely identify the widget.
      * @note It is recommended to provide unique widget id to correctly save/restore App layout.
      */
     readonly id?: string;
@@ -23,7 +23,7 @@ export interface AbstractWidgetProps extends ProvidedItem {
     readonly label?: string | ConditionalStringValue;
     /** used to explicitly set the tooltip shown by a component. */
     readonly tooltip?: string | ConditionalStringValue;
-    /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false. */
+    /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false. @deprecated */
     readonly isFreeform?: boolean;
     /** Application data attached to the Widget. */
     readonly applicationData?: any;

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8BAA8B;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC;IACrC,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC;IACpC,2KAA2K;IAC3K,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,yHAAyH;IACzH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;4GACwG;IACxG,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,oDAAoD;IACpD,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,iDAAiD;IACjD,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,gHAAgH;IAChH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;IACnE,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,qDAAqD;IACrD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC;CAChD"}
+{"version":3,"file":"AbstractWidgetProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8BAA8B;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,CAAC;IACrC,0HAA0H;IAC1H,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC;IACpC,2KAA2K;IAC3K,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,qIAAqI;IACrI,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,+CAA+C;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,GAAG,CAAC;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;4GACwG;IACxG,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,oDAAoD;IACpD,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAC5C,iDAAiD;IACjD,QAAQ,CAAC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAClD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5D,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,gHAAgH;IAChH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC;IACnE,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3C,qDAAqD;IACrD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC;CAChD"}

package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\nimport { WidgetState } from \"./WidgetState\";\r\n\r\n/** Properties for a Widget.\r\n * @public\r\n */\r\nexport interface AbstractWidgetProps extends ProvidedItem {\r\n  /** Gets the widget content */\r\n  readonly getWidgetContent: () => any;\r\n  /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Optional Id used to uniquely identify the widget.\r\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\r\n   */\r\n  readonly id?: string;\r\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\r\n  readonly defaultState?: WidgetState;\r\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false. */\r\n  readonly isFreeform?: boolean;\r\n  /** Application data attached to the Widget. */\r\n  readonly applicationData?: any;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Indicates whether this Widget is for the Tool Settings. */\r\n  readonly isToolSettings?: boolean;\r\n  /** Indicates whether this Widget is for the Status Bar. */\r\n  readonly isStatusBar?: boolean;\r\n  /** Indicates whether this Widget should fill the available space in the Zone. */\r\n  readonly fillZone?: boolean;\r\n  /** Indicates if widget can be popped out to a child window. */\r\n  readonly canPopout?: boolean;\r\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined then the widget will be added to a\r\n   * floating panel by that name. If no name is specified the current practice of using a GUID is used. */\r\n  readonly floatingContainerId?: string;\r\n  /** Indicates if widget can be in floating state. */\r\n  readonly isFloatingStateSupported?: boolean;\r\n  /** Indicates if floating widget is resizable. */\r\n  readonly isFloatingStateWindowResizable?: boolean;\r\n  /** Defines that default Top Left position when widget is floated via API calls */\r\n  readonly defaultFloatingPosition?: { x: number, y: number };\r\n  /** Widget priority */\r\n  readonly priority?: number;\r\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\r\n  readonly syncEventIds?: string[];\r\n  /** Function executed to determine the state of the widget. */\r\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;\r\n  /** Badge to be overlaid on the widget tab. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Handler for widget state changed event */\r\n  readonly onWidgetStateChanged?: () => void;\r\n  /** Save transient DOM state (i.e. scroll offset). */\r\n  readonly saveTransientState?: () => void;\r\n  /** Restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  readonly restoreTransientState?: () => boolean;\r\n}\r\n"]}
+{"version":3,"file":"AbstractWidgetProps.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/AbstractWidgetProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\nimport { WidgetState } from \"./WidgetState\";\r\n\r\n/** Properties for a Widget.\r\n * @public\r\n */\r\nexport interface AbstractWidgetProps extends ProvidedItem {\r\n  /** Gets the widget content */\r\n  readonly getWidgetContent: () => any;\r\n  /** Name of icon WebFont entry or if specifying an SVG symbol added by plug on use \"svg:\" prefix to imported symbol Id. */\r\n  readonly icon?: string | ConditionalStringValue;\r\n  /** Id used to uniquely identify the widget.\r\n   * @note It is recommended to provide unique widget id to correctly save/restore App layout.\r\n   */\r\n  readonly id?: string;\r\n  /** Default Widget state. Controls how the Widget is initially displayed. Defaults to WidgetState.Unloaded. */\r\n  readonly defaultState?: WidgetState;\r\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\r\n  readonly label?: string | ConditionalStringValue;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Indicates whether the Widget is free-form or rectangular. Defaults to false for rectangular. The default is false. @deprecated */\r\n  readonly isFreeform?: boolean;\r\n  /** Application data attached to the Widget. */\r\n  readonly applicationData?: any;\r\n  /** optional data to used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\r\n  /** Indicates whether this Widget is for the Tool Settings. */\r\n  readonly isToolSettings?: boolean;\r\n  /** Indicates whether this Widget is for the Status Bar. */\r\n  readonly isStatusBar?: boolean;\r\n  /** Indicates whether this Widget should fill the available space in the Zone. */\r\n  readonly fillZone?: boolean;\r\n  /** Indicates if widget can be popped out to a child window. */\r\n  readonly canPopout?: boolean;\r\n  /** If the widget state is changed to `floating` and the floatingContainerId is defined then the widget will be added to a\r\n   * floating panel by that name. If no name is specified the current practice of using a GUID is used. */\r\n  readonly floatingContainerId?: string;\r\n  /** Indicates if widget can be in floating state. */\r\n  readonly isFloatingStateSupported?: boolean;\r\n  /** Indicates if floating widget is resizable. */\r\n  readonly isFloatingStateWindowResizable?: boolean;\r\n  /** Defines that default Top Left position when widget is floated via API calls */\r\n  readonly defaultFloatingPosition?: { x: number, y: number };\r\n  /** Widget priority */\r\n  readonly priority?: number;\r\n  /** Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget. */\r\n  readonly syncEventIds?: string[];\r\n  /** Function executed to determine the state of the widget. */\r\n  readonly stateFunc?: (state: Readonly<WidgetState>) => WidgetState;\r\n  /** Badge to be overlaid on the widget tab. */\r\n  readonly badgeType?: BadgeType;\r\n  /** Handler for widget state changed event */\r\n  readonly onWidgetStateChanged?: () => void;\r\n  /** Save transient DOM state (i.e. scroll offset). */\r\n  readonly saveTransientState?: () => void;\r\n  /** Restore transient DOM state.\r\n   * @note Return true if the state is restored or the Widget will remount.\r\n   */\r\n  readonly restoreTransientState?: () => boolean;\r\n}\r\n"]}

package/lib/cjs/appui-abstract/widget/StagePanel.d.ts

@@ -2,7 +2,7 @@
  * @module Widget
  */
 /** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public
+ * @public @deprecated
  */
 export declare enum AbstractZoneLocation {
     CenterLeft = 4,

package/lib/cjs/appui-abstract/widget/StagePanel.js

@@ -9,7 +9,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StagePanelSection = exports.StagePanelLocation = exports.AbstractZoneLocation = void 0;
 /** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].
- * @public
+ * @public @deprecated
  */
 var AbstractZoneLocation;
 (function (AbstractZoneLocation) {

package/lib/cjs/appui-abstract/widget/StagePanel.js.map

@@ -1 +1 @@
-{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,yEAAU,CAAA;AACZ,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAED;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B","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 Widget\r\n */\r\n\r\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\r\n * @public\r\n */\r\nexport enum AbstractZoneLocation {\r\n  CenterLeft = 4,\r\n  CenterRight = 6,\r\n  BottomLeft = 7,\r\n  BottomRight = 9,\r\n}\r\n\r\n/** Available Stage Panel locations.\r\n * @public\r\n */\r\nexport enum StagePanelLocation {\r\n  Top = 101,\r\n  TopMost,\r\n  Left,\r\n  Right,\r\n  Bottom,\r\n  BottomMost,\r\n}\r\n\r\n/** Enum for Stage Panel Sections\r\n * @public\r\n */\r\nexport enum StagePanelSection {\r\n  Start,\r\n  Middle,\r\n  End,\r\n}\r\n"]}
+{"version":3,"file":"StagePanel.js","sourceRoot":"","sources":["../../../../src/appui-abstract/widget/StagePanel.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;GAEG;AACH,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2EAAc,CAAA;IACd,6EAAe,CAAA;IACf,2EAAc,CAAA;IACd,6EAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED;;GAEG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,2DAAS,CAAA;IACT,mEAAO,CAAA;IACP,6DAAI,CAAA;IACJ,+DAAK,CAAA;IACL,iEAAM,CAAA;IACN,yEAAU,CAAA;AACZ,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAED;;GAEG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,2DAAK,CAAA;IACL,6DAAM,CAAA;IACN,uDAAG,CAAA;AACL,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B","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 Widget\r\n */\r\n\r\n/** Enum for AppUi 1 `Zone` locations that can have widgets added to them at run-time via [[UiItemsProvider]].\r\n * @public @deprecated\r\n */\r\nexport enum AbstractZoneLocation {\r\n  CenterLeft = 4,\r\n  CenterRight = 6,\r\n  BottomLeft = 7,\r\n  BottomRight = 9,\r\n}\r\n\r\n/** Available Stage Panel locations.\r\n * @public\r\n */\r\nexport enum StagePanelLocation {\r\n  Top = 101,\r\n  TopMost,\r\n  Left,\r\n  Right,\r\n  Bottom,\r\n  BottomMost,\r\n}\r\n\r\n/** Enum for Stage Panel Sections\r\n * @public\r\n */\r\nexport enum StagePanelSection {\r\n  Start,\r\n  Middle,\r\n  End,\r\n}\r\n"]}

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

@@ -41,6 +41,8 @@ export * from "./appui-abstract/utils/isLetter";
 export * from "./appui-abstract/utils/IconSpecUtilities";
 export * from "./appui-abstract/utils/PointProps";
 export * from "./appui-abstract/utils/UiError";
+export * from "./appui-abstract/utils/UiEventDispatcher";
+export * from "./appui-abstract/utils/UiEvent";
 export * from "./appui-abstract/utils/filter/charCode";
 export * from "./appui-abstract/utils/filter/filters";
 export * from "./appui-abstract/utils/filter/strings";
@@ -55,10 +57,6 @@ export * from "./appui-abstract/widget/WidgetState";
  * @docs-group-description Backstage
  * Abstractions used by appui-react package to create and manage the display Backstage menu items.
  */
-/**
- * @docs-group-description Common
- * Common enums and functions used throughout the UI packages.
- */
 /**
  * @docs-group-description ContentView
  * Classes and interfaces used with Content Layouts.
@@ -87,10 +85,6 @@ export * from "./appui-abstract/widget/WidgetState";
  * @docs-group-description Toolbar
  * Classes for creating and managing items in a toolbar.
  */
-/**
- * @docs-group-description StandardContentLayouts
- * Class that contains standard layout definitions for frontstage content/views.
- */
 /**
  * @docs-group-description UiAdmin
  * Abstractions for UI controls, such as toolbars, buttons and menus and are callable from IModelApp.uiAdmin in core-frontend.

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

@@ -1 +1 @@
-{"version":3,"file":"appui-abstract.d.ts","sourceRoot":"","sources":["../../src/appui-abstract.ts"],"names":[],"mappings":"AAKA,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAEhD,cAAc,0CAA0C,CAAC;AACzD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,qCAAqC,CAAC;AAEpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAEhE,cAAc,qCAAqC,CAAC;AACpD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AAExD,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,qCAAqC,CAAC;AACpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kCAAkC,CAAC;AAEjD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,mCAAmC,CAAC;AAElD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAE9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,mCAAmC,CAAC;AAElD,cAAc,mDAAmD,CAAC;AAClE,cAAc,0CAA0C,CAAC;AACzD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,uCAAuC,CAAC;AACtD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,0CAA0C,CAAC;AACzD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0CAA0C,CAAC;AACzD,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AAEtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AAEpD;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG"}
+{"version":3,"file":"appui-abstract.d.ts","sourceRoot":"","sources":["../../src/appui-abstract.ts"],"names":[],"mappings":"AAKA,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAEhD,cAAc,0CAA0C,CAAC;AACzD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,qCAAqC,CAAC;AAEpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAEhE,cAAc,qCAAqC,CAAC;AACpD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AAExD,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,qCAAqC,CAAC;AACpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kCAAkC,CAAC;AAEjD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,mCAAmC,CAAC;AAElD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAE9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,mCAAmC,CAAC;AAElD,cAAc,mDAAmD,CAAC;AAClE,cAAc,0CAA0C,CAAC;AACzD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,uCAAuC,CAAC;AACtD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,0CAA0C,CAAC;AACzD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0CAA0C,CAAC;AACzD,cAAc,mCAAmC,CAAC;AAClD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0CAA0C,CAAC;AACzD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AAEtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AAEpD;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG"}

package/lib/cjs/appui-abstract.js

@@ -57,6 +57,8 @@ __exportStar(require("./appui-abstract/utils/isLetter"), exports);
 __exportStar(require("./appui-abstract/utils/IconSpecUtilities"), exports);
 __exportStar(require("./appui-abstract/utils/PointProps"), exports);
 __exportStar(require("./appui-abstract/utils/UiError"), exports);
+__exportStar(require("./appui-abstract/utils/UiEventDispatcher"), exports);
+__exportStar(require("./appui-abstract/utils/UiEvent"), exports);
 __exportStar(require("./appui-abstract/utils/filter/charCode"), exports);
 __exportStar(require("./appui-abstract/utils/filter/filters"), exports);
 __exportStar(require("./appui-abstract/utils/filter/strings"), exports);
@@ -71,10 +73,6 @@ __exportStar(require("./appui-abstract/widget/WidgetState"), exports);
  * @docs-group-description Backstage
  * Abstractions used by appui-react package to create and manage the display Backstage menu items.
  */
-/**
- * @docs-group-description Common
- * Common enums and functions used throughout the UI packages.
- */
 /**
  * @docs-group-description ContentView
  * Classes and interfaces used with Content Layouts.
@@ -103,10 +101,6 @@ __exportStar(require("./appui-abstract/widget/WidgetState"), exports);
  * @docs-group-description Toolbar
  * Classes for creating and managing items in a toolbar.
  */
-/**
- * @docs-group-description StandardContentLayouts
- * Class that contains standard layout definitions for frontstage content/views.
- */
 /**
  * @docs-group-description UiAdmin
  * Abstractions for UI controls, such as toolbars, buttons and menus and are callable from IModelApp.uiAdmin in core-frontend.

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

@@ -1 +1 @@
-{"version":3,"file":"appui-abstract.js","sourceRoot":"","sources":["../../src/appui-abstract.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,2DAAyC;AACzC,kEAAgD;AAEhD,2EAAyD;AACzD,mFAAiE;AAEjE,sEAAoD;AAEpD,8EAA4D;AAC5D,kFAAgE;AAEhE,sEAAoD;AACpD,gFAA8D;AAC9D,0EAAwD;AAExD,2EAAyD;AACzD,+EAA6D;AAC7D,sEAAoD;AACpD,8EAA4D;AAC5D,mEAAiD;AAEjD,iFAA+D;AAC/D,gFAA8D;AAC9D,0EAAwD;AACxD,sEAAoD;AACpD,0EAAwD;AACxD,oEAAkD;AAElD,iFAA+D;AAC/D,gFAA8D;AAE9D,0EAAwD;AACxD,2EAAyD;AACzD,6EAA2D;AAC3D,qEAAmD;AACnD,kFAAgE;AAChE,gFAA8D;AAC9D,oEAAkD;AAElD,oFAAkE;AAClE,2EAAyD;AACzD,mFAAiE;AAEjE,wEAAsD;AACtD,gFAA8D;AAE9D,2EAAyD;AACzD,mFAAiE;AAEjE,mEAAiD;AACjD,8DAA4C;AAC5C,kEAAgD;AAChD,2EAAyD;AACzD,oEAAkD;AAClD,iEAA+C;AAC/C,yEAAuD;AACvD,wEAAsD;AACtD,wEAAsD;AAEtD,8EAA4D;AAC5D,qEAAmD;AACnD,sEAAoD;AAEpD;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG","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\r\nexport * from \"./appui-abstract/UiAdmin\";\r\nexport * from \"./appui-abstract/UiItemsManager\";\r\n\r\nexport * from \"./appui-abstract/backstage/BackstageItem\";\r\nexport * from \"./appui-abstract/backstage/BackstageItemsManager\";\r\n\r\nexport * from \"./appui-abstract/common/KeyboardKey\";\r\n\r\nexport * from \"./appui-abstract/content/ContentLayoutProps\";\r\nexport * from \"./appui-abstract/content/StandardContentLayouts\";\r\n\r\nexport * from \"./appui-abstract/dialogs/DialogItem\";\r\nexport * from \"./appui-abstract/dialogs/UiLayoutDataProvider\";\r\nexport * from \"./appui-abstract/dialogs/UiDataProvider\";\r\n\r\nexport * from \"./appui-abstract/items/AbstractItemProps\";\r\nexport * from \"./appui-abstract/items/AbstractMenuItemProps\";\r\nexport * from \"./appui-abstract/items/ProvidedItem\";\r\nexport * from \"./appui-abstract/items/AbstractToolbarProps\";\r\nexport * from \"./appui-abstract/items/BadgeType\";\r\n\r\nexport * from \"./appui-abstract/items/ConditionalBooleanValue\";\r\nexport * from \"./appui-abstract/items/ConditionalStringValue\";\r\nexport * from \"./appui-abstract/items/RelativePosition\";\r\nexport * from \"./appui-abstract/items/ProvidedItem\";\r\nexport * from \"./appui-abstract/items/RelativePosition\";\r\nexport * from \"./appui-abstract/items/StageUsage\";\r\n\r\nexport * from \"./appui-abstract/notification/MessagePresenter\";\r\nexport * from \"./appui-abstract/notification/MessageSeverity\";\r\n\r\nexport * from \"./appui-abstract/properties/Description\";\r\nexport * from \"./appui-abstract/properties/EditorParams\";\r\nexport * from \"./appui-abstract/properties/PrimitiveTypes\";\r\nexport * from \"./appui-abstract/properties/Record\";\r\nexport * from \"./appui-abstract/properties/StandardEditorNames\";\r\nexport * from \"./appui-abstract/properties/StandardTypeNames\";\r\nexport * from \"./appui-abstract/properties/Value\";\r\n\r\nexport * from \"./appui-abstract/quantity/BaseQuantityDescription\";\r\nexport * from \"./appui-abstract/statusbar/StatusBarItem\";\r\nexport * from \"./appui-abstract/statusbar/StatusBarItemsManager\";\r\n\r\nexport * from \"./appui-abstract/toolbars/ToolbarItem\";\r\nexport * from \"./appui-abstract/toolbars/ToolbarItemsManager\";\r\n\r\nexport * from \"./appui-abstract/statusbar/StatusBarItem\";\r\nexport * from \"./appui-abstract/statusbar/StatusBarItemsManager\";\r\n\r\nexport * from \"./appui-abstract/utils/callbacks\";\r\nexport * from \"./appui-abstract/utils/misc\";\r\nexport * from \"./appui-abstract/utils/isLetter\";\r\nexport * from \"./appui-abstract/utils/IconSpecUtilities\";\r\nexport * from \"./appui-abstract/utils/PointProps\";\r\nexport * from \"./appui-abstract/utils/UiError\";\r\nexport * from \"./appui-abstract/utils/filter/charCode\";\r\nexport * from \"./appui-abstract/utils/filter/filters\";\r\nexport * from \"./appui-abstract/utils/filter/strings\";\r\n\r\nexport * from \"./appui-abstract/widget/AbstractWidgetProps\";\r\nexport * from \"./appui-abstract/widget/StagePanel\";\r\nexport * from \"./appui-abstract/widget/WidgetState\";\r\n\r\n/** @docs-package-description\r\n * The appui-abstract package contains abstractions for UI controls, such as toolbars, buttons and menus.\r\n * For more information, see [learning about appui-abstract]($docs/learning/ui/abstract/index.md).\r\n */\r\n/**\r\n * @docs-group-description Backstage\r\n * Abstractions used by appui-react package to create and manage the display Backstage menu items.\r\n */\r\n/**\r\n * @docs-group-description Common\r\n * Common enums and functions used throughout the UI packages.\r\n */\r\n/**\r\n * @docs-group-description ContentView\r\n * Classes and interfaces used with Content Layouts.\r\n */\r\n/**\r\n * @docs-group-description Dialog\r\n * Interfaces and classes for generating UI items for Dialogs.\r\n */\r\n/**\r\n * @docs-group-description Item\r\n * Classes for working with an Item in a Toolbar, Widget, Backstage or Context Menu\r\n */\r\n/**\r\n * @docs-group-description Notification\r\n * Interfaces and enums for working with a message\r\n */\r\n/**\r\n * @docs-group-description Properties\r\n * Properties system for data input and formatting.\r\n */\r\n/**\r\n * @docs-group-description StatusBar\r\n * Classes for creating and managing items in the status bar.\r\n */\r\n/**\r\n * @docs-group-description Toolbar\r\n * Classes for creating and managing items in a toolbar.\r\n */\r\n/**\r\n * @docs-group-description StandardContentLayouts\r\n * Class that contains standard layout definitions for frontstage content/views.\r\n */\r\n/**\r\n * @docs-group-description UiAdmin\r\n * Abstractions for UI controls, such as toolbars, buttons and menus and are callable from IModelApp.uiAdmin in core-frontend.\r\n */\r\n/**\r\n * @docs-group-description UiItemsProvider\r\n * Interface for specifying UI items to be inserted at runtime.\r\n */\r\n/**\r\n * @docs-group-description Utilities\r\n * Various utility classes for working with a UI.\r\n */\r\n/**\r\n * @docs-group-description Widget\r\n * Classes for creating and providing Widgets.\r\n */\r\n"]}
+{"version":3,"file":"appui-abstract.js","sourceRoot":"","sources":["../../src/appui-abstract.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,2DAAyC;AACzC,kEAAgD;AAEhD,2EAAyD;AACzD,mFAAiE;AAEjE,sEAAoD;AAEpD,8EAA4D;AAC5D,kFAAgE;AAEhE,sEAAoD;AACpD,gFAA8D;AAC9D,0EAAwD;AAExD,2EAAyD;AACzD,+EAA6D;AAC7D,sEAAoD;AACpD,8EAA4D;AAC5D,mEAAiD;AAEjD,iFAA+D;AAC/D,gFAA8D;AAC9D,0EAAwD;AACxD,sEAAoD;AACpD,0EAAwD;AACxD,oEAAkD;AAElD,iFAA+D;AAC/D,gFAA8D;AAE9D,0EAAwD;AACxD,2EAAyD;AACzD,6EAA2D;AAC3D,qEAAmD;AACnD,kFAAgE;AAChE,gFAA8D;AAC9D,oEAAkD;AAElD,oFAAkE;AAClE,2EAAyD;AACzD,mFAAiE;AAEjE,wEAAsD;AACtD,gFAA8D;AAE9D,2EAAyD;AACzD,mFAAiE;AAEjE,mEAAiD;AACjD,8DAA4C;AAC5C,kEAAgD;AAChD,2EAAyD;AACzD,oEAAkD;AAClD,iEAA+C;AAC/C,2EAAyD;AACzD,iEAA+C;AAC/C,yEAAuD;AACvD,wEAAsD;AACtD,wEAAsD;AAEtD,8EAA4D;AAC5D,qEAAmD;AACnD,sEAAoD;AAEpD;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG;AACH;;;GAGG","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\r\nexport * from \"./appui-abstract/UiAdmin\";\r\nexport * from \"./appui-abstract/UiItemsManager\";\r\n\r\nexport * from \"./appui-abstract/backstage/BackstageItem\";\r\nexport * from \"./appui-abstract/backstage/BackstageItemsManager\";\r\n\r\nexport * from \"./appui-abstract/common/KeyboardKey\";\r\n\r\nexport * from \"./appui-abstract/content/ContentLayoutProps\";\r\nexport * from \"./appui-abstract/content/StandardContentLayouts\";\r\n\r\nexport * from \"./appui-abstract/dialogs/DialogItem\";\r\nexport * from \"./appui-abstract/dialogs/UiLayoutDataProvider\";\r\nexport * from \"./appui-abstract/dialogs/UiDataProvider\";\r\n\r\nexport * from \"./appui-abstract/items/AbstractItemProps\";\r\nexport * from \"./appui-abstract/items/AbstractMenuItemProps\";\r\nexport * from \"./appui-abstract/items/ProvidedItem\";\r\nexport * from \"./appui-abstract/items/AbstractToolbarProps\";\r\nexport * from \"./appui-abstract/items/BadgeType\";\r\n\r\nexport * from \"./appui-abstract/items/ConditionalBooleanValue\";\r\nexport * from \"./appui-abstract/items/ConditionalStringValue\";\r\nexport * from \"./appui-abstract/items/RelativePosition\";\r\nexport * from \"./appui-abstract/items/ProvidedItem\";\r\nexport * from \"./appui-abstract/items/RelativePosition\";\r\nexport * from \"./appui-abstract/items/StageUsage\";\r\n\r\nexport * from \"./appui-abstract/notification/MessagePresenter\";\r\nexport * from \"./appui-abstract/notification/MessageSeverity\";\r\n\r\nexport * from \"./appui-abstract/properties/Description\";\r\nexport * from \"./appui-abstract/properties/EditorParams\";\r\nexport * from \"./appui-abstract/properties/PrimitiveTypes\";\r\nexport * from \"./appui-abstract/properties/Record\";\r\nexport * from \"./appui-abstract/properties/StandardEditorNames\";\r\nexport * from \"./appui-abstract/properties/StandardTypeNames\";\r\nexport * from \"./appui-abstract/properties/Value\";\r\n\r\nexport * from \"./appui-abstract/quantity/BaseQuantityDescription\";\r\nexport * from \"./appui-abstract/statusbar/StatusBarItem\";\r\nexport * from \"./appui-abstract/statusbar/StatusBarItemsManager\";\r\n\r\nexport * from \"./appui-abstract/toolbars/ToolbarItem\";\r\nexport * from \"./appui-abstract/toolbars/ToolbarItemsManager\";\r\n\r\nexport * from \"./appui-abstract/statusbar/StatusBarItem\";\r\nexport * from \"./appui-abstract/statusbar/StatusBarItemsManager\";\r\n\r\nexport * from \"./appui-abstract/utils/callbacks\";\r\nexport * from \"./appui-abstract/utils/misc\";\r\nexport * from \"./appui-abstract/utils/isLetter\";\r\nexport * from \"./appui-abstract/utils/IconSpecUtilities\";\r\nexport * from \"./appui-abstract/utils/PointProps\";\r\nexport * from \"./appui-abstract/utils/UiError\";\r\nexport * from \"./appui-abstract/utils/UiEventDispatcher\";\r\nexport * from \"./appui-abstract/utils/UiEvent\";\r\nexport * from \"./appui-abstract/utils/filter/charCode\";\r\nexport * from \"./appui-abstract/utils/filter/filters\";\r\nexport * from \"./appui-abstract/utils/filter/strings\";\r\n\r\nexport * from \"./appui-abstract/widget/AbstractWidgetProps\";\r\nexport * from \"./appui-abstract/widget/StagePanel\";\r\nexport * from \"./appui-abstract/widget/WidgetState\";\r\n\r\n/** @docs-package-description\r\n * The appui-abstract package contains abstractions for UI controls, such as toolbars, buttons and menus.\r\n * For more information, see [learning about appui-abstract]($docs/learning/ui/abstract/index.md).\r\n */\r\n/**\r\n * @docs-group-description Backstage\r\n * Abstractions used by appui-react package to create and manage the display Backstage menu items.\r\n */\r\n/**\r\n * @docs-group-description ContentView\r\n * Classes and interfaces used with Content Layouts.\r\n */\r\n/**\r\n * @docs-group-description Dialog\r\n * Interfaces and classes for generating UI items for Dialogs.\r\n */\r\n/**\r\n * @docs-group-description Item\r\n * Classes for working with an Item in a Toolbar, Widget, Backstage or Context Menu\r\n */\r\n/**\r\n * @docs-group-description Notification\r\n * Interfaces and enums for working with a message\r\n */\r\n/**\r\n * @docs-group-description Properties\r\n * Properties system for data input and formatting.\r\n */\r\n/**\r\n * @docs-group-description StatusBar\r\n * Classes for creating and managing items in the status bar.\r\n */\r\n/**\r\n * @docs-group-description Toolbar\r\n * Classes for creating and managing items in a toolbar.\r\n */\r\n/**\r\n * @docs-group-description UiAdmin\r\n * Abstractions for UI controls, such as toolbars, buttons and menus and are callable from IModelApp.uiAdmin in core-frontend.\r\n */\r\n/**\r\n * @docs-group-description UiItemsProvider\r\n * Interface for specifying UI items to be inserted at runtime.\r\n */\r\n/**\r\n * @docs-group-description Utilities\r\n * Various utility classes for working with a UI.\r\n */\r\n/**\r\n * @docs-group-description Widget\r\n * Classes for creating and providing Widgets.\r\n */\r\n"]}

package/lib/esm/appui-abstract/UiItemsManager.d.ts

@@ -34,14 +34,29 @@ export interface UiItemsProvider {
      * @note Returned widgets must provide unique `AbstractWidgetProps["id"]` to correctly save/restore App layout.
      */
     provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;
-    /** Called if the application changed the Toolbar button item */
-    onToolbarButtonItemArbiterChange?: (item: CommonToolbarItem, action: UiItemsApplicationAction) => void;
-    /** Called if the application changed the StatusBar item */
-    onStatusBarItemArbiterChange?: (item: CommonStatusBarItem, action: UiItemsApplicationAction) => void;
-    /** Called if the application changed the Backstage item */
-    onBackstageItemArbiterChange?: (item: BackstageItem, action: UiItemsApplicationAction) => void;
-    /** Called if the application changed the Widget */
-    onWidgetArbiterChange?: (widget: AbstractWidgetProps, action: UiItemsApplicationAction) => void;
+    /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */
+    onUnregister?: () => void;
+}
+/**
+ * Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the
+ * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.
+ * @public
+ */
+export declare class BaseUiItemsProvider implements UiItemsProvider {
+    protected _providerId: string;
+    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined;
+    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined);
+    get id(): string;
+    onUnregister(): void;
+    unregister(): void;
+    /** Backstage items are not stage specific so no callback is used */
+    provideBackstageItems(): BackstageItem[];
+    provideToolbarButtonItemsInternal(_stageId: string, _stageUsage: string, _toolbarUsage: ToolbarUsage, _toolbarOrientation: ToolbarOrientation, _stageAppData?: any): CommonToolbarItem[];
+    provideToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[];
+    provideStatusBarItemsInternal(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[];
+    provideStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[];
+    provideWidgetsInternal(_stageId: string, _stageUsage: string, _location: StagePanelLocation, _section?: StagePanelSection, _stageAppData?: any): AbstractWidgetProps[];
+    provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, _zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps>;
 }
 /** UIProvider Registered Event Args interface.
  * @public

package/lib/esm/appui-abstract/UiItemsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGlG;;GAEG;AACH,oBAAY,wBAAwB;IAClC,mCAAmC;IACnC,KAAK,IAAA;IACL,sCAAsC;IACtC,QAAQ,IAAA;IACR,wCAAwC;IACxC,MAAM,IAAA;CACP;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,uFAAuF;IACvF,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,iBAAiB,EAAE,CAAC;IACjL,gGAAgG;IAChG,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,mBAAmB,EAAE,CAAC;IAC3G,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,MAAM,aAAa,EAAE,CAAC;IAC9C;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAC9G,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACjG,gEAAgE;IAChE,gCAAgC,CAAC,EAAE,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;IACvG,2DAA2D;IAC3D,4BAA4B,CAAC,EAAE,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;IACrG,2DAA2D;IAC3D,4BAA4B,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAC/F,mDAAmD;IACnD,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACjG;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAoE;IAE9G,wEAAwE;IACxE,gBAAuB,2BAA2B,eAAoB,iCAAiC,KAAK,IAAI,EAAI;IAEpH,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI;IAWzD,8EAA8E;WAChE,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAWpD;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EACjG,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAgBlF;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAgB/G;;OAEG;WACW,iBAAiB,IAAI,aAAa,EAAE;IAgBlD;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAgBtN"}
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAU,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIlG;;GAEG;AACH,oBAAY,wBAAwB;IAClC,mCAAmC;IACnC,KAAK,IAAA;IACL,sCAAsC;IACtC,QAAQ,IAAA;IACR,wCAAwC;IACxC,MAAM,IAAA;CACP;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,uFAAuF;IACvF,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,iBAAiB,EAAE,CAAC;IACjL,gGAAgG;IAChG,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,mBAAmB,EAAE,CAAC;IAC3G,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,MAAM,aAAa,EAAE,CAAC;IAC9C;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAC9G,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACjG,uHAAuH;IACvH,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO7C,SAAS,CAAC,WAAW,EAAE,MAAM;IAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,KAAK,OAAO;gBAAnH,WAAW,EAAE,MAAM,EAAS,gBAAgB,CAAC,aAAY,MAAM,cAAc,MAAM,iBAAiB,GAAG,KAAK,OAAO,aAAA;IAEzI,IAAW,EAAE,IAAI,MAAM,CAA6B;IAC7C,YAAY,IAAI,IAAI;IAEpB,UAAU;IAIjB,oEAAoE;IAC7D,qBAAqB,IAAI,aAAa,EAAE;IAIxC,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAGxL,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAY3K,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAGhH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAYrG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,QAAQ,CAAC,EAAE,iBAAiB,EAAE,aAAa,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAItK,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAClH,aAAa,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAWhG;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAoE;IAE9G,wEAAwE;IACxE,gBAAuB,2BAA2B,eAAoB,iCAAiC,KAAK,IAAI,EAAI;IAEpH,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI;IAWzD,8EAA8E;WAChE,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAcpD;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EACjG,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE;IAgBlF;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,mBAAmB,EAAE;IAgB/G;;OAEG;WACW,iBAAiB,IAAI,aAAa,EAAE;IAgBlD;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAgBtN"}

package/lib/esm/appui-abstract/UiItemsManager.js

@@ -2,11 +2,13 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
 /** @packageDocumentation
  * @module UiItemsProvider
  */
 import { BeEvent, Logger } from "@itwin/core-bentley";
 import { loggerCategory } from "./utils/misc";
+import { StageUsage } from "./items/StageUsage";
 /** Action taken by the application on item provided by a UiItemsProvider
  * @public
  */
@@ -19,6 +21,71 @@ export var UiItemsApplicationAction;
     /** Update the item during the change */
     UiItemsApplicationAction[UiItemsApplicationAction["Update"] = 2] = "Update";
 })(UiItemsApplicationAction || (UiItemsApplicationAction = {}));
+/**
+ * Base implementation of a UiItemsProvider. The base class allows the user to pass in a function that is used to determine if the
+ * active stage should be provided items. Derived provider classes should override the `xxxInternal` methods to provide items.
+ * @public
+ */
+export class BaseUiItemsProvider {
+    /*
+     * @param providerId - unique identifier for this instance of the provider. This is required in case separate packages want
+     * to set up custom stage with their own subset of standard tools.
+     * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
+     * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
+     */
+    constructor(_providerId, isSupportedStage) {
+        this._providerId = _providerId;
+        this.isSupportedStage = isSupportedStage;
+    }
+    get id() { return this._providerId; }
+    onUnregister() { }
+    unregister() {
+        UiItemsManager.unregister(this._providerId);
+    }
+    /** Backstage items are not stage specific so no callback is used */
+    provideBackstageItems() {
+        return [];
+    }
+    provideToolbarButtonItemsInternal(_stageId, _stageUsage, _toolbarUsage, _toolbarOrientation, _stageAppData) {
+        return [];
+    }
+    provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage.General);
+        }
+        return provideToStage ? this.provideToolbarButtonItemsInternal(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) : [];
+    }
+    provideStatusBarItemsInternal(_stageId, _stageUsage, _stageAppData) {
+        return [];
+    }
+    provideStatusBarItems(stageId, stageUsage, stageAppData) {
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage.General);
+        }
+        return provideToStage ? this.provideStatusBarItemsInternal(stageId, stageUsage, stageAppData) : [];
+    }
+    provideWidgetsInternal(_stageId, _stageUsage, _location, _section, _stageAppData) {
+        return [];
+    }
+    provideWidgets(stageId, stageUsage, location, section, _zoneLocation, stageAppData) {
+        let provideToStage = false;
+        if (this.isSupportedStage) {
+            provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+        }
+        else {
+            provideToStage = (stageUsage === StageUsage.General);
+        }
+        return provideToStage ? this.provideWidgetsInternal(stageId, stageUsage, location, section, stageAppData) : [];
+    }
+}
 /**
  * Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
  * @public
@@ -59,8 +126,10 @@ export class UiItemsManager {
     }
     /** Remove a specific UiItemsProvider from the list of available providers. */
     static unregister(uiProviderId) {
-        if (!UiItemsManager.getUiItemsProvider(uiProviderId))
+        const provider = UiItemsManager.getUiItemsProvider(uiProviderId);
+        if (!provider)
             return;
+        provider.onUnregister && provider.onUnregister();
         UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);
         Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);
         // trigger a refresh of the ui