@itwin/appui-abstract 4.0.0-dev.9 → 4.0.0-dev.91

package/lib/esm/appui-abstract/utils/IconSpecUtilities.js

@@ -1,29 +1,49 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.
- * @public
- */
-export class IconSpecUtilities {
-    /** Create an IconSpec for an SVG loaded into web component with svg-loader
-     * @public
-    */
-    static createWebComponentIconSpec(srcString) {
-        return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;
-    }
-    /** Get the SVG Source from an svg-loader IconSpec
-     * @public
-    */
-    static getWebComponentSource(iconSpec) {
-        if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {
-            return iconSpec.slice(7);
-        }
-        return undefined;
-    }
-}
-IconSpecUtilities.WEB_COMPONENT_PREFIX = "webSvg:";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.
+ * @public
+ */
+class IconSpecUtilities {
+    /** Create an IconSpec for an SVG loaded into web component with sprite loader
+     * This method is deprecated --  use createWebComponentIconSpec()
+     * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.
+    */
+    static createSvgIconSpec(svgSrc) {
+        return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;
+    }
+    /** Create an IconSpec for an SVG loaded into web component with svg-loader
+     * @public
+    */
+    static createWebComponentIconSpec(srcString) {
+        return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;
+    }
+    /** Get the SVG Source from an sprite IconSpec
+     * This method is deprecated -- use getWebComponentSource()
+     * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.
+    */
+    static getSvgSource(iconSpec) {
+        if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {
+            return iconSpec.slice(4);
+        }
+        return undefined;
+    }
+    /** Get the SVG Source from an svg-loader IconSpec
+     * @public
+    */
+    static getWebComponentSource(iconSpec) {
+        if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {
+            return iconSpec.slice(7);
+        }
+        return undefined;
+    }
+}
+/** Prefix for an SVG IconSpec loaded with the Sprite loader */
+IconSpecUtilities.SVG_PREFIX = "svg:";
+IconSpecUtilities.WEB_COMPONENT_PREFIX = "webSvg:";
+export { IconSpecUtilities };
 //# sourceMappingURL=IconSpecUtilities.js.map

package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAG5B;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AApBsB,sCAAoB,GAAG,SAAS,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utilities\r\n */\r\n\r\n/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\r\n * @public\r\n */\r\nexport class IconSpecUtilities {\r\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\r\n\r\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\r\n   * @public\r\n  */\r\n  public static createWebComponentIconSpec(srcString: string): string {\r\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\r\n  }\r\n\r\n  /** Get the SVG Source from an svg-loader IconSpec\r\n   * @public\r\n  */\r\n\r\n  public static getWebComponentSource(iconSpec: string): string | undefined {\r\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\r\n      return iconSpec.slice(7);\r\n    }\r\n\r\n    return undefined;\r\n\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IconSpecUtilities.js","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/IconSpecUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;GAEG;AACH,MAAa,iBAAiB;IAK5B;;;MAGE;IACK,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,GAAG,iBAAiB,CAAC,UAAU,GAAG,MAAM,EAAE,CAAC;IACpD,CAAC;IACD;;MAEE;IACK,MAAM,CAAC,0BAA0B,CAAC,SAAiB;QACxD,OAAO,GAAG,iBAAiB,CAAC,oBAAoB,GAAG,SAAS,EAAE,CAAC;IACjE,CAAC;IAED;;;MAGE;IACK,MAAM,CAAC,YAAY,CAAC,QAAgB;QACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5E,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IAEK,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,IAAI,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACtF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC1B;QAED,OAAO,SAAS,CAAC;IAEnB,CAAC;;AAxCD,+DAA+D;AACxC,4BAAU,GAAG,MAAM,CAAC;AACpB,sCAAoB,GAAG,SAAS,CAAC;SAH7C,iBAAiB","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/** Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.\r\n * @public\r\n */\r\nexport class IconSpecUtilities {\r\n  /** Prefix for an SVG IconSpec loaded with the Sprite loader */\r\n  public static readonly SVG_PREFIX = \"svg:\";\r\n  public static readonly WEB_COMPONENT_PREFIX = \"webSvg:\";\r\n\r\n  /** Create an IconSpec for an SVG loaded into web component with sprite loader\r\n   * This method is deprecated --  use createWebComponentIconSpec()\r\n   * @public @deprecated in 3.2. Please avoid using the Sprite loader and use IconSpecUtilities.createWebComponentIconSpec() instead.\r\n  */\r\n  public static createSvgIconSpec(svgSrc: string): string {\r\n    return `${IconSpecUtilities.SVG_PREFIX}${svgSrc}`;\r\n  }\r\n  /** Create an IconSpec for an SVG loaded into web component with svg-loader\r\n   * @public\r\n  */\r\n  public static createWebComponentIconSpec(srcString: string): string {\r\n    return `${IconSpecUtilities.WEB_COMPONENT_PREFIX}${srcString}`;\r\n  }\r\n\r\n  /** Get the SVG Source from an sprite IconSpec\r\n   * This method is deprecated -- use getWebComponentSource()\r\n   * @public @deprecated in 3.2. avoid using the Sprite loader and use IconSpecUtilities.getWebComponentSource() instead.\r\n  */\r\n  public static getSvgSource(iconSpec: string): string | undefined {\r\n    if (iconSpec.startsWith(IconSpecUtilities.SVG_PREFIX) && iconSpec.length > 4) {\r\n      return iconSpec.slice(4);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n  /** Get the SVG Source from an svg-loader IconSpec\r\n   * @public\r\n  */\r\n\r\n  public static getWebComponentSource(iconSpec: string): string | undefined {\r\n    if (iconSpec.startsWith(IconSpecUtilities.WEB_COMPONENT_PREFIX) && iconSpec.length > 7) {\r\n      return iconSpec.slice(7);\r\n    }\r\n\r\n    return undefined;\r\n\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-abstract/utils/PointProps.d.ts

@@ -1,11 +1,11 @@
-/** @packageDocumentation
- * @module Utilities
- */
-/** Describes 2d points.
- * @public
- */
-export interface PointProps {
-    readonly x: number;
-    readonly y: number;
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+/** Describes 2d points.
+ * @public
+ */
+export interface PointProps {
+    readonly x: number;
+    readonly y: number;
+}
 //# sourceMappingURL=PointProps.d.ts.map

package/lib/esm/appui-abstract/utils/PointProps.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=PointProps.js.map

package/lib/esm/appui-abstract/utils/UiError.d.ts

@@ -1,13 +1,13 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import { BentleyError, GetMetaDataFunction } from "@itwin/core-bentley";
-/** iTwin.js UI UiError class is a subclass of BentleyError. Errors are logged.
- * @public
- */
-export declare class UiError extends BentleyError {
-    category: string;
-    /** Constructs UiError using BentleyError. */
-    constructor(category: string, message: string, errorNumber?: number, getMetaData?: GetMetaDataFunction);
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { BentleyError, GetMetaDataFunction } from "@itwin/core-bentley";
+/** iTwin.js UI UiError class is a subclass of BentleyError. Errors are logged.
+ * @public
+ */
+export declare class UiError extends BentleyError {
+    category: string;
+    /** Constructs UiError using BentleyError. */
+    constructor(category: string, message: string, errorNumber?: number, getMetaData?: GetMetaDataFunction);
+}
 //# sourceMappingURL=UiError.d.ts.map

package/lib/esm/appui-abstract/utils/UiError.js

@@ -1,19 +1,19 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { BentleyError, BentleyStatus } from "@itwin/core-bentley";
-/** iTwin.js UI UiError class is a subclass of BentleyError. Errors are logged.
- * @public
- */
-export class UiError extends BentleyError {
-    /** Constructs UiError using BentleyError. */
-    constructor(category, message, errorNumber = BentleyStatus.ERROR, getMetaData) {
-        super(errorNumber, message, getMetaData);
-        this.category = category;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BentleyError, BentleyStatus } from "@itwin/core-bentley";
+/** iTwin.js UI UiError class is a subclass of BentleyError. Errors are logged.
+ * @public
+ */
+export class UiError extends BentleyError {
+    /** Constructs UiError using BentleyError. */
+    constructor(category, message, errorNumber = BentleyStatus.ERROR, getMetaData) {
+        super(errorNumber, message, getMetaData);
+        this.category = category;
+    }
+}
 //# sourceMappingURL=UiError.js.map

package/lib/esm/appui-abstract/utils/UiEvent.d.ts

@@ -1,10 +1,10 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import { BeUiEvent } from "@itwin/core-bentley";
-/** iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.
- * @public
- */
-export declare class UiEvent<TEventArgs> extends BeUiEvent<TEventArgs> {
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+/** iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.
+ * @public
+ */
+export declare class UiEvent<TEventArgs> extends BeUiEvent<TEventArgs> {
+}
 //# sourceMappingURL=UiEvent.d.ts.map

package/lib/esm/appui-abstract/utils/UiEvent.js

@@ -1,14 +1,14 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { BeUiEvent } from "@itwin/core-bentley";
-/** iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.
- * @public
- */
-export class UiEvent extends BeUiEvent {
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BeUiEvent } from "@itwin/core-bentley";
+/** iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.
+ * @public
+ */
+export class UiEvent extends BeUiEvent {
+}
 //# sourceMappingURL=UiEvent.js.map

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

@@ -1,47 +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;
-}
+/** @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/esm/appui-abstract/utils/UiEventDispatcher.js

@@ -1,127 +1,127 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-// cSpell:ignore configurableui
-import { UiEvent } from "./UiEvent";
-/** UiSync Event class.
- * @public
- */
-export class UiSyncEvent extends UiEvent {
-}
-/** 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 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;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+// cSpell:ignore configurableui
+import { UiEvent } from "./UiEvent";
+/** UiSync Event class.
+ * @public
+ */
+export class UiSyncEvent extends UiEvent {
+}
+/** 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 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;
+    }
+}
 //# sourceMappingURL=UiEventDispatcher.js.map

package/lib/esm/appui-abstract/utils/callbacks.d.ts

@@ -1,21 +1,21 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import { Primitives } from "../properties/PrimitiveTypes";
-/** Signature for number onCommit function.
- * @public
- */
-export declare type OnNumberCommitFunc = (value: number) => void;
-/** Signature for value onCommit function.
- * @public
- */
-export declare type OnValueCommitFunc = (value: Primitives.Value) => void;
-/** Signature for onCancel function.
- * @public
- */
-export declare type OnCancelFunc = () => void;
-/** Signature for onItemExecuted function.
- * @public
- */
-export declare type OnItemExecutedFunc = (item: any) => void;
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { Primitives } from "../properties/PrimitiveTypes";
+/** Signature for number onCommit function.
+ * @public
+ */
+export type OnNumberCommitFunc = (value: number) => void;
+/** Signature for value onCommit function.
+ * @public
+ */
+export type OnValueCommitFunc = (value: Primitives.Value) => void;
+/** Signature for onCancel function.
+ * @public
+ */
+export type OnCancelFunc = () => void;
+/** Signature for onItemExecuted function.
+ * @public
+ */
+export type OnItemExecutedFunc = (item: any) => void;
 //# sourceMappingURL=callbacks.d.ts.map

package/lib/esm/appui-abstract/utils/callbacks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"callbacks.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/callbacks.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,oBAAY,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzD;;GAEG;AACH,oBAAY,iBAAiB,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,KAAK,IAAI,CAAC;AAElE;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,IAAI,CAAC;AAEtC;;GAEG;AACH,oBAAY,kBAAkB,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC"}
+{"version":3,"file":"callbacks.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/utils/callbacks.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,KAAK,IAAI,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC"}