@itwin/appui-react 4.3.1 → 4.5.0

package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.js

@@ -59,6 +59,7 @@ export var SyncUiEventId;
     SyncUiEventId["ShowHideManagerSettingChange"] = "show-hide-setting-change";
     /** The list of feature overrides applied has been changed */
     SyncUiEventId["FeatureOverridesChanged"] = "featureoverrideschanged";
+    SyncUiEventId["ViewedModelsChanged"] = "viewedmodelschanged";
 })(SyncUiEventId || (SyncUiEventId = {}));
 /** 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.
@@ -110,106 +111,76 @@ class SyncUiEventDispatcher {
     static _dispatchFeatureOverridesChange() {
         SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FeatureOverridesChanged);
     }
+    // istanbul ignore next
+    static _dispatchViewedModelsChanged() {
+        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ViewedModelsChanged);
+    }
     /** Initializes the Monitoring of Events that trigger dispatching sync events */
     static initialize() {
         // clear any registered listeners - this should only be encountered in unit test scenarios
-        this._unregisterListenerFuncs.forEach((unregisterListenerFunc) => unregisterListenerFunc());
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {
+        this._unregisterFuncs.forEach((unregister) => unregister());
+        this._unregisterFuncs = [];
+        this._unregisterFuncs.push(UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {
             SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentControlActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {
+        }), UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ContentLayoutActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {
+        }), UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageActivating);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {
+        }), UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.FrontstageReady);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {
+        }), UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ModalFrontstageChanged);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {
+        }), UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.NavigationAidActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onToolActivatedEvent.addListener(() => {
+        }), UiFramework.frontstages.onToolActivatedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ToolActivated);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {
+        }), UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.WidgetStateChanged);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.backstage.onToggled.addListener(() => {
+        }), UiFramework.backstage.onToggled.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.BackstageEvent);
-        }));
-        this._unregisterListenerFuncs.push(UiFramework.content.onActiveContentChangedEvent.addListener(() => {
+        }), UiFramework.content.onActiveContentChangedEvent.addListener(() => {
             SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveContentChanged);
+        }), IModelApp.viewManager.onSelectedViewportChanged.addListener((args) => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);
+            // if this is the first view being opened up start the default tool so tool admin is happy.
+            if (undefined === args.previous) {
+                void IModelApp.toolAdmin.startDefaultTool();
+            }
+            else {
+                args.previous.onViewChanged.removeListener(SyncUiEventDispatcher._dispatchViewChange);
+                args.previous.onFeatureOverridesChanged.removeListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);
+                args.previous.onViewedModelsChanged.removeListener(SyncUiEventDispatcher._dispatchViewedModelsChanged);
+            }
+            // istanbul ignore next
+            if (args.current) {
+                args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);
+                args.current.onFeatureOverridesChanged.addListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);
+                args.current.onViewedModelsChanged.addListener(SyncUiEventDispatcher._dispatchViewedModelsChanged);
+            }
         }));
-        // istanbul ignore else
-        if (IModelApp && IModelApp.viewManager) {
-            this._unregisterListenerFuncs.push(IModelApp.viewManager.onSelectedViewportChanged.addListener((args) => {
-                SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.ActiveViewportChanged);
-                // if this is the first view being opened up start the default tool so tool admin is happy.
-                if (undefined === args.previous) {
-                    void IModelApp.toolAdmin.startDefaultTool();
-                }
-                else {
-                    // istanbul ignore next
-                    if (args.previous.onViewChanged &&
-                        typeof args.previous.onViewChanged.removeListener === "function")
-                        // not set during unit test
-                        args.previous.onViewChanged.removeListener(SyncUiEventDispatcher._dispatchViewChange);
-                    // istanbul ignore next
-                    if (args.previous.onFeatureOverridesChanged &&
-                        typeof args.previous.onFeatureOverridesChanged
-                            .removeListener === "function")
-                        // not set during unit test
-                        args.previous.onFeatureOverridesChanged.removeListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);
-                }
-                // istanbul ignore next
-                if (args.current) {
-                    if (args.current.onViewChanged &&
-                        typeof args.current.onViewChanged.addListener === "function")
-                        // not set during unit test
-                        args.current.onViewChanged.addListener(SyncUiEventDispatcher._dispatchViewChange);
-                    // istanbul ignore next
-                    if (args.current.onFeatureOverridesChanged &&
-                        typeof args.current.onFeatureOverridesChanged.addListener ===
-                            "function")
-                        // not set during unit test
-                        args.current.onFeatureOverridesChanged.addListener(SyncUiEventDispatcher._dispatchFeatureOverridesChange);
-                }
-            }));
-        }
-    }
-    static selectionChangedHandler(_ev) {
-        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);
     }
     /** This should be called by IModelApp when the active IModelConnection is closed. */
     static clearConnectionEvents(iModelConnection) {
-        iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);
-        SyncUiEventDispatcher._unregisterListenerFunc &&
-            SyncUiEventDispatcher._unregisterListenerFunc();
+        if (this._iModelConnection !== iModelConnection)
+            return;
+        this._connectionUnregisterFuncs.forEach((unregister) => unregister());
+        this._connectionUnregisterFuncs = [];
     }
     /** This should be called by IModelApp when the active IModelConnection is established. */
     static initializeConnectionEvents(iModelConnection) {
-        if (SyncUiEventDispatcher._unregisterListenerFunc)
-            SyncUiEventDispatcher._unregisterListenerFunc();
-        if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {
-            UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, 0);
-            return;
-        }
-        iModelConnection.selectionSet.onChanged.removeListener(SyncUiEventDispatcher.selectionChangedHandler);
-        iModelConnection.selectionSet.onChanged.addListener(SyncUiEventDispatcher.selectionChangedHandler);
-        iModelConnection.iModelId &&
-            UiFramework.setActiveIModelId(iModelConnection.iModelId);
-        SyncUiEventDispatcher._unregisterListenerFunc =
-            iModelConnection.selectionSet.onChanged.addListener((ev) => {
-                const numSelected = ev.set.elements.size;
-                UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, numSelected);
-            });
+        this._iModelConnection &&
+            this.clearConnectionEvents(this._iModelConnection);
+        this._iModelConnection = iModelConnection;
+        this._connectionUnregisterFuncs.push(iModelConnection.selectionSet.onChanged.addListener(() => {
+            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SelectionSetChanged);
+        }), iModelConnection.selectionSet.onChanged.addListener((ev) => {
+            const numSelected = ev.set.elements.size;
+            UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, numSelected);
+        }));
     }
 }
 SyncUiEventDispatcher._uiEventDispatcher = new UiEventDispatcher();
-SyncUiEventDispatcher._unregisterListenerFuncs = [];
+SyncUiEventDispatcher._unregisterFuncs = new Array();
+SyncUiEventDispatcher._connectionUnregisterFuncs = new Array();
 export { SyncUiEventDispatcher };
 //# sourceMappingURL=SyncUiEventDispatcher.js.map

package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"SyncUiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAM7C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,yJAAyJ;AACzJ,yJAAyJ;AACzJ,2JAA2J;AAC3J,wHAAwH;AACxH,6HAA6H;AAE7H;;GAEG;AACH,MAAM,CAAN,IAAY,aAwCX;AAxCD,WAAY,aAAa;IACvB,yCAAyC;IACzC,0EAAyD,CAAA;IACzD,qCAAqC;IACrC,oEAAmD,CAAA;IACnD,8EAA8E;IAC9E,8DAA6C,CAAA;IAC7C,iEAAiE;IACjE,gEAA+C,CAAA;IAC/C,kCAAkC;IAClC,kDAAiC,CAAA;IACjC,4CAA4C;IAC5C,kEAAiD,CAAA;IACjD,kFAAkF;IAClF,oEAAmD,CAAA;IACnD,kCAAkC;IAClC,8DAA6C,CAAA;IAC7C,yEAAyE;IACzE,oDAAmC,CAAA;IACnC,oDAAoD;IACpD,kEAAiD,CAAA;IACjD,gDAAgD;IAChD,0DAAyC,CAAA;IACzC,0CAA0C;IAC1C,kEAAiD,CAAA;IACjD,+DAA+D;IAC/D,gDAA+B,CAAA;IAC/B,yCAAyC;IACzC,0DAAyC,CAAA;IACzC,oEAAoE;IACpE,4DAA2C,CAAA;IAC3C,kFAAkF;IAClF,sEAAqD,CAAA;IACrD,mFAAmF;IACnF,sDAAqC,CAAA;IACrC,mEAAmE;IACnE,gEAA+C,CAAA;IAC/C,0EAAyD,CAAA;IACzD,6DAA6D;IAC7D,oEAAmD,CAAA;AACrD,CAAC,EAxCW,aAAa,KAAb,aAAa,QAwCxB;AAED;;;GAGG;AACH,MAAa,qBAAqB;IAKhC,wCAAwC;IACxC,0BAA0B;IACnB,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC3C,qBAAqB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,+DAA+D;IACxD,MAAM,KAAK,YAAY;QAC5B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,YAAY,CAAC;IAC/D,CAAC;IAED,oEAAoE;IAC7D,MAAM,KAAK,aAAa;QAC7B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CAAC;IAChE,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,4BAA4B,CAAC,OAAe;QACxD,qBAAqB,CAAC,kBAAkB,CAAC,4BAA4B,CACnE,OAAO,CACR,CAAC;IACJ,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,mBAAmB,CAAC,OAAe;QAC/C,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CACZ,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,6DAA6D,CAC9D,CAAC;YACF,OAAO;SACR;QACD,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB,CAAC,QAAkB;QACnD,qBAAqB;QACrB,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CACZ,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,+DAA+D,CAChE,CAAC;SACH;QACD,qBAAqB,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,kBAAkB,CAC9B,QAAqB,EACrB,aAAuB;QAEvB,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAChE,QAAQ,EACR,aAAa,CACd,CAAC;IACJ,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,mBAAmB;QAChC,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,gBAAgB,CAC/B,CAAC;IACJ,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,+BAA+B;QAC5C,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,uBAAuB,CACtC,CAAC;IACJ,CAAC;IAED,gFAAgF;IACzE,MAAM,CAAC,UAAU;QACtB,0FAA0F;QAC1F,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,sBAAsB,EAAE,EAAE,CAC/D,sBAAsB,EAAE,CACzB,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,WAAW,CAAC,GAAG,EAAE;YACtE,qBAAqB,CAAC,mBAAmB,CACvC,aAAa,CAAC,uBAAuB,CACtC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,sBAAsB,CACrC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,oBAAoB,CACnC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,sBAAsB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC9D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,eAAe,CAC9B,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,sBAAsB,CACrC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,sBAAsB,CACrC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC5D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,aAAa,CAC5B,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,GAAG,EAAE;YACjE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,kBAAkB,CACjC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/C,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,cAAc,CAC7B,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,oBAAoB,CACnC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,uBAAuB;QACvB,IAAI,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE;YACtC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAChC,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CACzD,CAAC,IAAiC,EAAE,EAAE;gBACpC,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,qBAAqB,CACpC,CAAC;gBAEF,2FAA2F;gBAC3F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;oBAC/B,KAAK,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;iBAC7C;qBAAM;oBACL,uBAAuB;oBACvB,IACE,IAAI,CAAC,QAAQ,CAAC,aAAa;wBAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,KAAK,UAAU;wBAEhE,2BAA2B;wBAC3B,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CACxC,qBAAqB,CAAC,mBAAmB,CAC1C,CAAC;oBACJ,uBAAuB;oBACvB,IACE,IAAI,CAAC,QAAQ,CAAC,yBAAyB;wBACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,yBAAyB;6BAC3C,cAAc,KAAK,UAAU;wBAEhC,2BAA2B;wBAC3B,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,cAAc,CACpD,qBAAqB,CAAC,+BAA+B,CACtD,CAAC;iBACL;gBACD,uBAAuB;gBACvB,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,IACE,IAAI,CAAC,OAAO,CAAC,aAAa;wBAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,KAAK,UAAU;wBAE5D,2BAA2B;wBAC3B,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CACpC,qBAAqB,CAAC,mBAAmB,CAC1C,CAAC;oBACJ,uBAAuB;oBACvB,IACE,IAAI,CAAC,OAAO,CAAC,yBAAyB;wBACtC,OAAO,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW;4BACvD,UAAU;wBAEZ,2BAA2B;wBAC3B,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW,CAChD,qBAAqB,CAAC,+BAA+B,CACtD,CAAC;iBACL;YACH,CAAC,CACF,CACF,CAAC;SACH;IACH,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,GAAsB;QAC3D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,mBAAmB,CAClC,CAAC;IACJ,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,qBAAqB,CAAC,gBAAkC;QACpE,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,cAAc,CACpD,qBAAqB,CAAC,uBAAuB,CAC9C,CAAC;QACF,qBAAqB,CAAC,uBAAuB;YAC3C,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;IACpD,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,0BAA0B,CAAC,gBAAkC;QACzE,IAAI,qBAAqB,CAAC,uBAAuB;YAC/C,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;QAElD,IAAI,gBAAgB,CAAC,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YACpE,WAAW,CAAC,qBAAqB,CAC/B,oBAAoB,CAAC,mBAAmB,EACxC,CAAC,CACF,CAAC;YACF,OAAO;SACR;QAED,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,cAAc,CACpD,qBAAqB,CAAC,uBAAuB,CAC9C,CAAC;QACF,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CACjD,qBAAqB,CAAC,uBAAuB,CAC9C,CAAC;QACF,gBAAgB,CAAC,QAAQ;YACvB,WAAW,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAE3D,qBAAqB,CAAC,uBAAuB;YAC3C,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE;gBACzD,MAAM,WAAW,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACzC,WAAW,CAAC,qBAAqB,CAC/B,oBAAoB,CAAC,mBAAmB,EACxC,WAAW,CACZ,CAAC;YACJ,CAAC,CAAC,CAAC;IACP,CAAC;;AA5Qc,wCAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAE7C,8CAAwB,GAAsB,EAAE,CAAC;SAHrD,qBAAqB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module SyncUi\n */\n\nimport type { UiSyncEvent } from \"@itwin/appui-abstract\";\nimport { UiEventDispatcher } from \"@itwin/appui-abstract\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport type {\n  IModelConnection,\n  SelectedViewportChangedArgs,\n  SelectionSetEvent,\n} from \"@itwin/core-frontend\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { SessionStateActionId } from \"../redux/SessionState\";\nimport { UiFramework } from \"../UiFramework\";\n\n// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstageevent, contentlayoutactivated, contentcontrolactivated,\n// cSpell:ignore elementtooltipchanged, frontstageactivated, inputfieldmessageadded, inputfieldmessageremoved, modalfrontstagechanged, modaldialogchanged\n// cSpell:ignore navigationaidactivated, notificationmessageadded, toolactivated, taskactivated, widgetstatechanged, workflowactivated frontstageactivating\n// cSpell:ignore frontstageready activeviewportchanged selectionsetchanged presentationselectionchanged viewstatechanged\n// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged configurableui\n\n/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.\n * @public\n */\nexport enum SyncUiEventId {\n  /** AccuDraw compass mode has changed. */\n  AccuDrawCompassModeChanged = \"accudrawcompassmodechanged\",\n  /** AccuDraw rotation has changed. */\n  AccuDrawRotationChanged = \"accudrawrotationchanged\",\n  /** The active content as maintained by the ContentViewManager has changed. */\n  ActiveContentChanged = \"activecontentchanged\",\n  /** The active view maintained by the ViewManager has changed. */\n  ActiveViewportChanged = \"activeviewportchanged\",\n  /** Backstage has been toggled. */\n  BackstageEvent = \"backstageevent\",\n  /** A Content Layout has been activated.  */\n  ContentLayoutActivated = \"contentlayoutactivated\",\n  /** A Content Control maintained by UiFramework.frontstages has been activated. */\n  ContentControlActivated = \"contentcontrolactivated\",\n  /** A Frontstage is activating. */\n  FrontstageActivating = \"frontstageactivating\",\n  /** A Frontstage has been activated and the content has been assigned. */\n  FrontstageReady = \"frontstageready\",\n  /** A Modal Frontstage has been opened or closed. */\n  ModalFrontstageChanged = \"modalfrontstagechanged\",\n  /** A Modal Dialog has been opened or closed. */\n  ModalDialogChanged = \"modaldialogchanged\",\n  /** A NavigationAid has been activated. */\n  NavigationAidActivated = \"navigationaidactivated\",\n  /** An InteractiveTool has been activated via the ToolAdmin. */\n  ToolActivated = \"toolactivated\",\n  /** The state of a Widget has changed. */\n  WidgetStateChanged = \"widgetstatechanged\",\n  /** The SelectionSet for the active IModelConnection has changed. */\n  SelectionSetChanged = \"selectionsetchanged\",\n  /** The list of settings providers registered with SettingsManager has changed. */\n  SettingsProvidersChanged = \"settingsproviderschanged\",\n  /** The current view state has changed (used by view undo/redo toolbar buttons). */\n  ViewStateChanged = \"viewstatechanged\",\n  /** The current object the reads and write UI State has changed. */\n  UiStateStorageChanged = \"uistatestoragechanged\",\n  ShowHideManagerSettingChange = \"show-hide-setting-change\",\n  /** The list of feature overrides applied has been changed */\n  FeatureOverridesChanged = \"featureoverrideschanged\",\n}\n\n/** This class is used to send eventIds to interested UI components so the component can determine if it needs\n * to refresh its display by calling setState on itself.\n * @public\n */\nexport class SyncUiEventDispatcher {\n  private static _uiEventDispatcher = new UiEventDispatcher();\n  private static _unregisterListenerFunc?: () => void;\n  private static _unregisterListenerFuncs: Array<() => void> = [];\n\n  /** @internal - used for testing only */\n  /* istanbul ignore next */\n  public static setTimeoutPeriod(period: number): void {\n    SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);\n  }\n\n  /** Return set of event ids that will be sent to listeners/. */\n  public static get syncEventIds(): Set<string> {\n    return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;\n  }\n\n  /** Return SyncUiEvent so callers can register an event callback. */\n  public static get onSyncUiEvent(): UiSyncEvent {\n    return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;\n  }\n\n  /** Immediately trigger sync event processing. */\n  public static dispatchImmediateSyncUiEvent(eventId: string): void {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(\n      eventId\n    );\n  }\n\n  /** Save eventId in Set for processing. */\n  public static dispatchSyncUiEvent(eventId: string): void {\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`\n      );\n      return;\n    }\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);\n  }\n\n  /** Save multiple eventIds in Set for processing. */\n  public static dispatchSyncUiEvents(eventIds: string[]): void {\n    // istanbul ignore if\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`\n      );\n    }\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);\n  }\n\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\n  public static hasEventOfInterest(\n    eventIds: Set<string>,\n    idsOfInterest: string[]\n  ) {\n    return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(\n      eventIds,\n      idsOfInterest\n    );\n  }\n\n  // istanbul ignore next\n  private static _dispatchViewChange() {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n      SyncUiEventId.ViewStateChanged\n    );\n  }\n\n  // istanbul ignore next\n  private static _dispatchFeatureOverridesChange() {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n      SyncUiEventId.FeatureOverridesChanged\n    );\n  }\n\n  /** Initializes the Monitoring of Events that trigger dispatching sync events */\n  public static initialize() {\n    // clear any registered listeners - this should only be encountered in unit test scenarios\n    this._unregisterListenerFuncs.forEach((unregisterListenerFunc) =>\n      unregisterListenerFunc()\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ContentControlActivated\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ContentLayoutActivated\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.FrontstageActivating\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.FrontstageReady\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ModalFrontstageChanged\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.NavigationAidActivated\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onToolActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ToolActivated\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.WidgetStateChanged\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.backstage.onToggled.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.BackstageEvent\n        );\n      })\n    );\n\n    this._unregisterListenerFuncs.push(\n      UiFramework.content.onActiveContentChangedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ActiveContentChanged\n        );\n      })\n    );\n\n    // istanbul ignore else\n    if (IModelApp && IModelApp.viewManager) {\n      this._unregisterListenerFuncs.push(\n        IModelApp.viewManager.onSelectedViewportChanged.addListener(\n          (args: SelectedViewportChangedArgs) => {\n            SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n              SyncUiEventId.ActiveViewportChanged\n            );\n\n            // if this is the first view being opened up start the default tool so tool admin is happy.\n            if (undefined === args.previous) {\n              void IModelApp.toolAdmin.startDefaultTool();\n            } else {\n              // istanbul ignore next\n              if (\n                args.previous.onViewChanged &&\n                typeof args.previous.onViewChanged.removeListener === \"function\"\n              )\n                // not set during unit test\n                args.previous.onViewChanged.removeListener(\n                  SyncUiEventDispatcher._dispatchViewChange\n                );\n              // istanbul ignore next\n              if (\n                args.previous.onFeatureOverridesChanged &&\n                typeof args.previous.onFeatureOverridesChanged\n                  .removeListener === \"function\"\n              )\n                // not set during unit test\n                args.previous.onFeatureOverridesChanged.removeListener(\n                  SyncUiEventDispatcher._dispatchFeatureOverridesChange\n                );\n            }\n            // istanbul ignore next\n            if (args.current) {\n              if (\n                args.current.onViewChanged &&\n                typeof args.current.onViewChanged.addListener === \"function\"\n              )\n                // not set during unit test\n                args.current.onViewChanged.addListener(\n                  SyncUiEventDispatcher._dispatchViewChange\n                );\n              // istanbul ignore next\n              if (\n                args.current.onFeatureOverridesChanged &&\n                typeof args.current.onFeatureOverridesChanged.addListener ===\n                  \"function\"\n              )\n                // not set during unit test\n                args.current.onFeatureOverridesChanged.addListener(\n                  SyncUiEventDispatcher._dispatchFeatureOverridesChange\n                );\n            }\n          }\n        )\n      );\n    }\n  }\n\n  private static selectionChangedHandler(_ev: SelectionSetEvent) {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n      SyncUiEventId.SelectionSetChanged\n    );\n  }\n\n  /** This should be called by IModelApp when the active IModelConnection is closed. */\n  public static clearConnectionEvents(iModelConnection: IModelConnection) {\n    iModelConnection.selectionSet.onChanged.removeListener(\n      SyncUiEventDispatcher.selectionChangedHandler\n    );\n    SyncUiEventDispatcher._unregisterListenerFunc &&\n      SyncUiEventDispatcher._unregisterListenerFunc();\n  }\n\n  /** This should be called by IModelApp when the active IModelConnection is established. */\n  public static initializeConnectionEvents(iModelConnection: IModelConnection) {\n    if (SyncUiEventDispatcher._unregisterListenerFunc)\n      SyncUiEventDispatcher._unregisterListenerFunc();\n\n    if (iModelConnection.isBlankConnection() || !iModelConnection.isOpen) {\n      UiFramework.dispatchActionToStore(\n        SessionStateActionId.SetNumItemsSelected,\n        0\n      );\n      return;\n    }\n\n    iModelConnection.selectionSet.onChanged.removeListener(\n      SyncUiEventDispatcher.selectionChangedHandler\n    );\n    iModelConnection.selectionSet.onChanged.addListener(\n      SyncUiEventDispatcher.selectionChangedHandler\n    );\n    iModelConnection.iModelId &&\n      UiFramework.setActiveIModelId(iModelConnection.iModelId);\n\n    SyncUiEventDispatcher._unregisterListenerFunc =\n      iModelConnection.selectionSet.onChanged.addListener((ev) => {\n        const numSelected = ev.set.elements.size;\n        UiFramework.dispatchActionToStore(\n          SessionStateActionId.SetNumItemsSelected,\n          numSelected\n        );\n      });\n  }\n}\n"]}
+{"version":3,"file":"SyncUiEventDispatcher.js","sourceRoot":"","sources":["../../../../src/appui-react/syncui/SyncUiEventDispatcher.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,yJAAyJ;AACzJ,yJAAyJ;AACzJ,2JAA2J;AAC3J,wHAAwH;AACxH,6HAA6H;AAE7H;;GAEG;AACH,MAAM,CAAN,IAAY,aAyCX;AAzCD,WAAY,aAAa;IACvB,yCAAyC;IACzC,0EAAyD,CAAA;IACzD,qCAAqC;IACrC,oEAAmD,CAAA;IACnD,8EAA8E;IAC9E,8DAA6C,CAAA;IAC7C,iEAAiE;IACjE,gEAA+C,CAAA;IAC/C,kCAAkC;IAClC,kDAAiC,CAAA;IACjC,4CAA4C;IAC5C,kEAAiD,CAAA;IACjD,kFAAkF;IAClF,oEAAmD,CAAA;IACnD,kCAAkC;IAClC,8DAA6C,CAAA;IAC7C,yEAAyE;IACzE,oDAAmC,CAAA;IACnC,oDAAoD;IACpD,kEAAiD,CAAA;IACjD,gDAAgD;IAChD,0DAAyC,CAAA;IACzC,0CAA0C;IAC1C,kEAAiD,CAAA;IACjD,+DAA+D;IAC/D,gDAA+B,CAAA;IAC/B,yCAAyC;IACzC,0DAAyC,CAAA;IACzC,oEAAoE;IACpE,4DAA2C,CAAA;IAC3C,kFAAkF;IAClF,sEAAqD,CAAA;IACrD,mFAAmF;IACnF,sDAAqC,CAAA;IACrC,mEAAmE;IACnE,gEAA+C,CAAA;IAC/C,0EAAyD,CAAA;IACzD,6DAA6D;IAC7D,oEAAmD,CAAA;IACnD,4DAA2C,CAAA;AAC7C,CAAC,EAzCW,aAAa,KAAb,aAAa,QAyCxB;AAED;;;GAGG;AACH,MAAa,qBAAqB;IAMhC,wCAAwC;IACxC,0BAA0B;IACnB,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC3C,qBAAqB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,+DAA+D;IACxD,MAAM,KAAK,YAAY;QAC5B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,YAAY,CAAC;IAC/D,CAAC;IAED,oEAAoE;IAC7D,MAAM,KAAK,aAAa;QAC7B,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,CAAC;IAChE,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,4BAA4B,CAAC,OAAe;QACxD,qBAAqB,CAAC,kBAAkB,CAAC,4BAA4B,CACnE,OAAO,CACR,CAAC;IACJ,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,mBAAmB,CAAC,OAAe;QAC/C,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CACZ,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,6DAA6D,CAC9D,CAAC;YACF,OAAO;SACR;QACD,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB,CAAC,QAAkB;QACnD,qBAAqB;QACrB,IAAI,CAAC,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,aAAa,EAAE;YAChE,MAAM,CAAC,OAAO,CACZ,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAChC,+DAA+D,CAChE,CAAC;SACH;QACD,qBAAqB,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAED,kFAAkF;IAC3E,MAAM,CAAC,kBAAkB,CAC9B,QAAqB,EACrB,aAAuB;QAEvB,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,kBAAkB,CAChE,QAAQ,EACR,aAAa,CACd,CAAC;IACJ,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,mBAAmB;QAChC,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,gBAAgB,CAC/B,CAAC;IACJ,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,+BAA+B;QAC5C,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,uBAAuB,CACtC,CAAC;IACJ,CAAC;IAED,uBAAuB;IACf,MAAM,CAAC,4BAA4B;QACzC,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,mBAAmB,CAClC,CAAC;IACJ,CAAC;IAED,gFAAgF;IACzE,MAAM,CAAC,UAAU;QACtB,0FAA0F;QAC1F,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAE3B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CACxB,WAAW,CAAC,WAAW,CAAC,8BAA8B,CAAC,WAAW,CAAC,GAAG,EAAE;YACtE,qBAAqB,CAAC,mBAAmB,CACvC,aAAa,CAAC,uBAAuB,CACtC,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,sBAAsB,CACrC,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,GAAG,EAAE;YAClE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,oBAAoB,CACnC,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,sBAAsB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC9D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,eAAe,CAC9B,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,sBAAsB,CACrC,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,6BAA6B,CAAC,WAAW,CAAC,GAAG,EAAE;YACrE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,sBAAsB,CACrC,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,GAAG,EAAE;YAC5D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,aAAa,CAC5B,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,GAAG,EAAE;YACjE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,kBAAkB,CACjC,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/C,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,cAAc,CAC7B,CAAC;QACJ,CAAC,CAAC,EACF,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,GAAG,EAAE;YAC/D,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,oBAAoB,CACnC,CAAC;QACJ,CAAC,CAAC,EACF,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YACnE,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,qBAAqB,CACpC,CAAC;YAEF,2FAA2F;YAC3F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ,EAAE;gBAC/B,KAAK,SAAS,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;aAC7C;iBAAM;gBACL,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CACxC,qBAAqB,CAAC,mBAAmB,CAC1C,CAAC;gBACF,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,cAAc,CACpD,qBAAqB,CAAC,+BAA+B,CACtD,CAAC;gBACF,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,cAAc,CAChD,qBAAqB,CAAC,4BAA4B,CACnD,CAAC;aACH;YACD,uBAAuB;YACvB,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CACpC,qBAAqB,CAAC,mBAAmB,CAC1C,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,WAAW,CAChD,qBAAqB,CAAC,+BAA+B,CACtD,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAC5C,qBAAqB,CAAC,4BAA4B,CACnD,CAAC;aACH;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,qBAAqB,CAAC,gBAAkC;QACpE,IAAI,IAAI,CAAC,iBAAiB,KAAK,gBAAgB;YAAE,OAAO;QACxD,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,0BAA0B,GAAG,EAAE,CAAC;IACvC,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,0BAA0B,CAAC,gBAAkC;QACzE,IAAI,CAAC,iBAAiB;YACpB,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACrD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAE1C,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAClC,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE;YACvD,qBAAqB,CAAC,kBAAkB,CAAC,mBAAmB,CAC1D,aAAa,CAAC,mBAAmB,CAClC,CAAC;QACJ,CAAC,CAAC,EACF,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE;YACzD,MAAM,WAAW,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;YACzC,WAAW,CAAC,qBAAqB,CAC/B,oBAAoB,CAAC,mBAAmB,EACxC,WAAW,CACZ,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;;AA3Mc,wCAAkB,GAAG,IAAI,iBAAiB,EAAE,CAAC;AAC7C,sCAAgB,GAAG,IAAI,KAAK,EAAc,CAAC;AAC3C,gDAA0B,GAAG,IAAI,KAAK,EAAc,CAAC;SAHzD,qBAAqB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module SyncUi\n */\n\nimport type { UiSyncEvent } from \"@itwin/appui-abstract\";\nimport { UiEventDispatcher } from \"@itwin/appui-abstract\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { SessionStateActionId } from \"../redux/SessionState\";\nimport { UiFramework } from \"../UiFramework\";\n\n// cSpell:ignore activecontentchanged, activitymessageupdated, activitymessagecancelled, backstageevent, contentlayoutactivated, contentcontrolactivated,\n// cSpell:ignore elementtooltipchanged, frontstageactivated, inputfieldmessageadded, inputfieldmessageremoved, modalfrontstagechanged, modaldialogchanged\n// cSpell:ignore navigationaidactivated, notificationmessageadded, toolactivated, taskactivated, widgetstatechanged, workflowactivated frontstageactivating\n// cSpell:ignore frontstageready activeviewportchanged selectionsetchanged presentationselectionchanged viewstatechanged\n// cSpell:ignore accudrawcompassmodechanged accudrawfieldlockchanged accudrawrotationchanged uisettingschanged configurableui\n\n/** Event Id used to sync UI components. Used to refresh visibility or enable state of control.\n * @public\n */\nexport enum SyncUiEventId {\n  /** AccuDraw compass mode has changed. */\n  AccuDrawCompassModeChanged = \"accudrawcompassmodechanged\",\n  /** AccuDraw rotation has changed. */\n  AccuDrawRotationChanged = \"accudrawrotationchanged\",\n  /** The active content as maintained by the ContentViewManager has changed. */\n  ActiveContentChanged = \"activecontentchanged\",\n  /** The active view maintained by the ViewManager has changed. */\n  ActiveViewportChanged = \"activeviewportchanged\",\n  /** Backstage has been toggled. */\n  BackstageEvent = \"backstageevent\",\n  /** A Content Layout has been activated.  */\n  ContentLayoutActivated = \"contentlayoutactivated\",\n  /** A Content Control maintained by UiFramework.frontstages has been activated. */\n  ContentControlActivated = \"contentcontrolactivated\",\n  /** A Frontstage is activating. */\n  FrontstageActivating = \"frontstageactivating\",\n  /** A Frontstage has been activated and the content has been assigned. */\n  FrontstageReady = \"frontstageready\",\n  /** A Modal Frontstage has been opened or closed. */\n  ModalFrontstageChanged = \"modalfrontstagechanged\",\n  /** A Modal Dialog has been opened or closed. */\n  ModalDialogChanged = \"modaldialogchanged\",\n  /** A NavigationAid has been activated. */\n  NavigationAidActivated = \"navigationaidactivated\",\n  /** An InteractiveTool has been activated via the ToolAdmin. */\n  ToolActivated = \"toolactivated\",\n  /** The state of a Widget has changed. */\n  WidgetStateChanged = \"widgetstatechanged\",\n  /** The SelectionSet for the active IModelConnection has changed. */\n  SelectionSetChanged = \"selectionsetchanged\",\n  /** The list of settings providers registered with SettingsManager has changed. */\n  SettingsProvidersChanged = \"settingsproviderschanged\",\n  /** The current view state has changed (used by view undo/redo toolbar buttons). */\n  ViewStateChanged = \"viewstatechanged\",\n  /** The current object the reads and write UI State has changed. */\n  UiStateStorageChanged = \"uistatestoragechanged\",\n  ShowHideManagerSettingChange = \"show-hide-setting-change\",\n  /** The list of feature overrides applied has been changed */\n  FeatureOverridesChanged = \"featureoverrideschanged\",\n  ViewedModelsChanged = \"viewedmodelschanged\",\n}\n\n/** This class is used to send eventIds to interested UI components so the component can determine if it needs\n * to refresh its display by calling setState on itself.\n * @public\n */\nexport class SyncUiEventDispatcher {\n  private static _uiEventDispatcher = new UiEventDispatcher();\n  private static _unregisterFuncs = new Array<() => void>();\n  private static _connectionUnregisterFuncs = new Array<() => void>();\n  private static _iModelConnection?: IModelConnection;\n\n  /** @internal - used for testing only */\n  /* istanbul ignore next */\n  public static setTimeoutPeriod(period: number): void {\n    SyncUiEventDispatcher._uiEventDispatcher.setTimeoutPeriod(period);\n  }\n\n  /** Return set of event ids that will be sent to listeners/. */\n  public static get syncEventIds(): Set<string> {\n    return SyncUiEventDispatcher._uiEventDispatcher.syncEventIds;\n  }\n\n  /** Return SyncUiEvent so callers can register an event callback. */\n  public static get onSyncUiEvent(): UiSyncEvent {\n    return SyncUiEventDispatcher._uiEventDispatcher.onSyncUiEvent;\n  }\n\n  /** Immediately trigger sync event processing. */\n  public static dispatchImmediateSyncUiEvent(eventId: string): void {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchImmediateSyncUiEvent(\n      eventId\n    );\n  }\n\n  /** Save eventId in Set for processing. */\n  public static dispatchSyncUiEvent(eventId: string): void {\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `[dispatchSyncUiEvent] not processed because timeoutPeriod=0`\n      );\n      return;\n    }\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(eventId);\n  }\n\n  /** Save multiple eventIds in Set for processing. */\n  public static dispatchSyncUiEvents(eventIds: string[]): void {\n    // istanbul ignore if\n    if (0 === SyncUiEventDispatcher._uiEventDispatcher.timeoutPeriod) {\n      Logger.logInfo(\n        UiFramework.loggerCategory(this),\n        `[dispatchSyncUiEvents] not processed because _timeoutPeriod=0`\n      );\n    }\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvents(eventIds);\n  }\n\n  /** Checks to see if an eventId of interest is contained in the set of eventIds */\n  public static hasEventOfInterest(\n    eventIds: Set<string>,\n    idsOfInterest: string[]\n  ) {\n    return SyncUiEventDispatcher._uiEventDispatcher.hasEventOfInterest(\n      eventIds,\n      idsOfInterest\n    );\n  }\n\n  // istanbul ignore next\n  private static _dispatchViewChange() {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n      SyncUiEventId.ViewStateChanged\n    );\n  }\n\n  // istanbul ignore next\n  private static _dispatchFeatureOverridesChange() {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n      SyncUiEventId.FeatureOverridesChanged\n    );\n  }\n\n  // istanbul ignore next\n  private static _dispatchViewedModelsChanged() {\n    SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n      SyncUiEventId.ViewedModelsChanged\n    );\n  }\n\n  /** Initializes the Monitoring of Events that trigger dispatching sync events */\n  public static initialize() {\n    // clear any registered listeners - this should only be encountered in unit test scenarios\n    this._unregisterFuncs.forEach((unregister) => unregister());\n    this._unregisterFuncs = [];\n\n    this._unregisterFuncs.push(\n      UiFramework.frontstages.onContentControlActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ContentControlActivated\n        );\n      }),\n      UiFramework.frontstages.onContentLayoutActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ContentLayoutActivated\n        );\n      }),\n      UiFramework.frontstages.onFrontstageActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.FrontstageActivating\n        );\n      }),\n      UiFramework.frontstages.onFrontstageReadyEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.FrontstageReady\n        );\n      }),\n      UiFramework.frontstages.onModalFrontstageChangedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ModalFrontstageChanged\n        );\n      }),\n      UiFramework.frontstages.onNavigationAidActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.NavigationAidActivated\n        );\n      }),\n      UiFramework.frontstages.onToolActivatedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ToolActivated\n        );\n      }),\n      UiFramework.frontstages.onWidgetStateChangedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.WidgetStateChanged\n        );\n      }),\n      UiFramework.backstage.onToggled.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.BackstageEvent\n        );\n      }),\n      UiFramework.content.onActiveContentChangedEvent.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ActiveContentChanged\n        );\n      }),\n      IModelApp.viewManager.onSelectedViewportChanged.addListener((args) => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.ActiveViewportChanged\n        );\n\n        // if this is the first view being opened up start the default tool so tool admin is happy.\n        if (undefined === args.previous) {\n          void IModelApp.toolAdmin.startDefaultTool();\n        } else {\n          args.previous.onViewChanged.removeListener(\n            SyncUiEventDispatcher._dispatchViewChange\n          );\n          args.previous.onFeatureOverridesChanged.removeListener(\n            SyncUiEventDispatcher._dispatchFeatureOverridesChange\n          );\n          args.previous.onViewedModelsChanged.removeListener(\n            SyncUiEventDispatcher._dispatchViewedModelsChanged\n          );\n        }\n        // istanbul ignore next\n        if (args.current) {\n          args.current.onViewChanged.addListener(\n            SyncUiEventDispatcher._dispatchViewChange\n          );\n          args.current.onFeatureOverridesChanged.addListener(\n            SyncUiEventDispatcher._dispatchFeatureOverridesChange\n          );\n          args.current.onViewedModelsChanged.addListener(\n            SyncUiEventDispatcher._dispatchViewedModelsChanged\n          );\n        }\n      })\n    );\n  }\n\n  /** This should be called by IModelApp when the active IModelConnection is closed. */\n  public static clearConnectionEvents(iModelConnection: IModelConnection) {\n    if (this._iModelConnection !== iModelConnection) return;\n    this._connectionUnregisterFuncs.forEach((unregister) => unregister());\n    this._connectionUnregisterFuncs = [];\n  }\n\n  /** This should be called by IModelApp when the active IModelConnection is established. */\n  public static initializeConnectionEvents(iModelConnection: IModelConnection) {\n    this._iModelConnection &&\n      this.clearConnectionEvents(this._iModelConnection);\n    this._iModelConnection = iModelConnection;\n\n    this._connectionUnregisterFuncs.push(\n      iModelConnection.selectionSet.onChanged.addListener(() => {\n        SyncUiEventDispatcher._uiEventDispatcher.dispatchSyncUiEvent(\n          SyncUiEventId.SelectionSetChanged\n        );\n      }),\n      iModelConnection.selectionSet.onChanged.addListener((ev) => {\n        const numSelected = ev.set.elements.size;\n        UiFramework.dispatchActionToStore(\n          SessionStateActionId.SetNumItemsSelected,\n          numSelected\n        );\n      })\n    );\n  }\n}\n"]}

package/lib/esm/appui-react/toolbar/Toolbar.d.ts

@@ -6,12 +6,22 @@ import type { OnItemExecutedFunc } from "@itwin/appui-abstract";
 import type { CommonProps, NoChildrenProps } from "@itwin/core-react";
 import type { Direction, ToolbarOpacitySetting, ToolbarPanelAlignment } from "@itwin/components-react";
 import type { ToolbarItem } from "./ToolbarItem";
+/**
+ * Properties of [[Toolbar.enableOverflow]] component.
+ * @beta
+ */
+export interface OverflowToolbarOptions {
+    /** Describes to which direction the overflow popup panels are expanded if overflow is enabled. Defaults to: [[Direction.Right]] */
+    overflowExpandsTo?: Direction;
+}
 /** Properties of [[Toolbar]] component.
  * @beta
  */
 export interface ToolbarProps extends CommonProps, NoChildrenProps {
-    /** Describes to which direction the popup panels are expanded. Defaults to: [[Direction.Bottom]] */
+    /** Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar). Defaults to: [[Direction.Bottom]] */
     expandsTo?: Direction;
+    /** Describes if items that do not fit available space should move to an expandable panel. Defaults to: false */
+    enableOverflow?: boolean | OverflowToolbarOptions;
     /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */
     items: ToolbarItem[];
     /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */

package/lib/esm/appui-react/toolbar/Toolbar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Toolbar.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAGjD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,eAAe;IAChE,oGAAoG;IACpG,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,uGAAuG;IACvG,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,sDAAsD;IACtD,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,eAW1C"}
+{"version":3,"file":"Toolbar.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAIjD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,mIAAmI;IACnI,iBAAiB,CAAC,EAAE,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,eAAe;IAChE,2OAA2O;IAC3O,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gHAAgH;IAChH,cAAc,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAClD,uGAAuG;IACvG,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oFAAoF;IACpF,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,sDAAsD;IACtD,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,2EAA2E;IAC3E,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,aAAa,KAAK,IAAI,CAAC;CAC9C;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,eAY1C"}

package/lib/esm/appui-react/toolbar/Toolbar.js

@@ -6,8 +6,9 @@
  * @module Toolbar
  */
 import * as React from "react";
-import { Toolbar as CR_Toolbar } from "@itwin/components-react";
+import { InternalToolbarComponent as CR_Toolbar } from "@itwin/components-react";
 import { toUIAToolbarItem } from "./toUIAToolbarItem";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
 /** Component that displays toolbar items.
  * @beta
  */
@@ -17,6 +18,6 @@ export function Toolbar(props) {
         return items.map((item) => toUIAToolbarItem(item));
     }, [items]);
     return (React.createElement(CR_Toolbar // eslint-disable-line deprecation/deprecation
-    , { items: uiaItems, ...other }));
+    , { items: uiaItems, syncUiEvent: SyncUiEventDispatcher.onSyncUiEvent, ...other }));
 }
 //# sourceMappingURL=Toolbar.js.map

package/lib/esm/appui-react/toolbar/Toolbar.js.map

@@ -1 +1 @@
-{"version":3,"file":"Toolbar.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAQ/B,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAsBtD;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,CACL,oBAAC,UAAU,CAAC,8CAA8C;QACxD,KAAK,EAAE,QAAQ,KACX,KAAK,GACT,CACH,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { OnItemExecutedFunc } from \"@itwin/appui-abstract\";\nimport type { CommonProps, NoChildrenProps } from \"@itwin/core-react\";\nimport type {\n  Direction,\n  ToolbarOpacitySetting,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport { Toolbar as CR_Toolbar } from \"@itwin/components-react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport { toUIAToolbarItem } from \"./toUIAToolbarItem\";\n\n/** Properties of [[Toolbar]] component.\n * @beta\n */\nexport interface ToolbarProps extends CommonProps, NoChildrenProps {\n  /** Describes to which direction the popup panels are expanded. Defaults to: [[Direction.Bottom]] */\n  expandsTo?: Direction;\n  /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */\n  items: ToolbarItem[];\n  /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */\n  panelAlignment?: ToolbarPanelAlignment;\n  /** Use Drag Interaction to open popups with nest action buttons */\n  useDragInteraction?: boolean;\n  /** Determines whether to use mouse proximity to alter the opacity of the toolbar */\n  toolbarOpacitySetting?: ToolbarOpacitySetting;\n  /** Optional function to call on any item execution */\n  onItemExecuted?: OnItemExecutedFunc;\n  /** Optional function to call on any KeyDown events processed by toolbar */\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport function Toolbar(props: ToolbarProps) {\n  const { items, ...other } = props;\n  const uiaItems = React.useMemo(() => {\n    return items.map((item) => toUIAToolbarItem(item));\n  }, [items]);\n  return (\n    <CR_Toolbar // eslint-disable-line deprecation/deprecation\n      items={uiaItems}\n      {...other}\n    />\n  );\n}\n"]}
+{"version":3,"file":"Toolbar.js","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/Toolbar.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAQ/B,OAAO,EAAE,wBAAwB,IAAI,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAiCxE;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,CACL,oBAAC,UAAU,CAAC,8CAA8C;QACxD,KAAK,EAAE,QAAQ,EACf,WAAW,EAAE,qBAAqB,CAAC,aAAa,KAC5C,KAAK,GACT,CACH,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Toolbar\n */\n\nimport * as React from \"react\";\nimport type { OnItemExecutedFunc } from \"@itwin/appui-abstract\";\nimport type { CommonProps, NoChildrenProps } from \"@itwin/core-react\";\nimport type {\n  Direction,\n  ToolbarOpacitySetting,\n  ToolbarPanelAlignment,\n} from \"@itwin/components-react\";\nimport { InternalToolbarComponent as CR_Toolbar } from \"@itwin/components-react\";\nimport type { ToolbarItem } from \"./ToolbarItem\";\nimport { toUIAToolbarItem } from \"./toUIAToolbarItem\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\n\n/**\n * Properties of [[Toolbar.enableOverflow]] component.\n * @beta\n */\nexport interface OverflowToolbarOptions {\n  /** Describes to which direction the overflow popup panels are expanded if overflow is enabled. Defaults to: [[Direction.Right]] */\n  overflowExpandsTo?: Direction;\n}\n\n/** Properties of [[Toolbar]] component.\n * @beta\n */\nexport interface ToolbarProps extends CommonProps, NoChildrenProps {\n  /** Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar). Defaults to: [[Direction.Bottom]] */\n  expandsTo?: Direction;\n  /** Describes if items that do not fit available space should move to an expandable panel. Defaults to: false */\n  enableOverflow?: boolean | OverflowToolbarOptions;\n  /** Definitions for items of the toolbar. Items are expected to be already sorted by group and item. */\n  items: ToolbarItem[];\n  /** Describes how expanded panels are aligned. Defaults to: [[ToolbarPanelAlignment.Start]] */\n  panelAlignment?: ToolbarPanelAlignment;\n  /** Use Drag Interaction to open popups with nest action buttons */\n  useDragInteraction?: boolean;\n  /** Determines whether to use mouse proximity to alter the opacity of the toolbar */\n  toolbarOpacitySetting?: ToolbarOpacitySetting;\n  /** Optional function to call on any item execution */\n  onItemExecuted?: OnItemExecutedFunc;\n  /** Optional function to call on any KeyDown events processed by toolbar */\n  onKeyDown?: (e: React.KeyboardEvent) => void;\n}\n\n/** Component that displays toolbar items.\n * @beta\n */\nexport function Toolbar(props: ToolbarProps) {\n  const { items, ...other } = props;\n  const uiaItems = React.useMemo(() => {\n    return items.map((item) => toUIAToolbarItem(item));\n  }, [items]);\n  return (\n    <CR_Toolbar // eslint-disable-line deprecation/deprecation\n      items={uiaItems}\n      syncUiEvent={SyncUiEventDispatcher.onSyncUiEvent}\n      {...other}\n    />\n  );\n}\n"]}

package/lib/esm/appui-react/toolbar/ToolbarComposer.d.ts

@@ -14,7 +14,8 @@ export interface ExtensibleToolbarProps {
     orientation: ToolbarOrientation;
 }
 /**
- * Toolbar that is populated and maintained by item managers.
+ * Toolbar that is populated and maintained by item managers, will override
+ * isActive property based on the active tool id.
  * @public
  */
 export declare function ToolbarComposer(props: ExtensibleToolbarProps): JSX.Element;

package/lib/esm/appui-react/toolbar/ToolbarComposer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolbarComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAgBH,OAAO,KAAK,EAGV,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAGL,kBAAkB,EAClB,YAAY,EACb,MAAM,eAAe,CAAC;AAoPvB;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,KAAK,EAAE,YAAY,CAAC;IACpB,2BAA2B;IAC3B,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,sBAAsB,eAkE5D"}
+{"version":3,"file":"ToolbarComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolbar/ToolbarComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAYH,OAAO,KAAK,EAGV,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAGL,kBAAkB,EAClB,YAAY,EACb,MAAM,eAAe,CAAC;AA0JvB;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,KAAK,EAAE,YAAY,CAAC;IACpB,2BAA2B;IAC3B,WAAW,EAAE,kBAAkB,CAAC;CACjC;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,sBAAsB,eA4C5D"}

package/lib/esm/appui-react/toolbar/ToolbarComposer.js

@@ -6,68 +6,15 @@
  * @module Toolbar
  */
 import * as React from "react";
-import { ConditionalBooleanValue } from "@itwin/appui-abstract";
 import { Direction, ToolbarOpacitySetting, ToolbarPanelAlignment, } from "@itwin/components-react";
 import { Logger } from "@itwin/core-bentley";
 import { Orientation } from "@itwin/core-react";
-import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
 import { UiFramework } from "../UiFramework";
 import { ToolbarDragInteractionContext } from "./DragInteraction";
-import { useDefaultToolbarItems } from "./useDefaultToolbarItems";
-import { useUiItemsProviderToolbarItems } from "./useUiItemsProviderToolbarItems";
 import { isToolbarActionItem, isToolbarGroupItem, ToolbarOrientation, ToolbarUsage, } from "./ToolbarItem";
-import { ToolbarItemsManager } from "./ToolbarItemsManager";
-import { ToolbarWithOverflow } from "./ToolbarWithOverflow";
-/** Private function to set up sync event monitoring of toolbar items */
-function useToolbarItemSyncEffect(uiDataProvider, syncIdsOfInterest) {
-    React.useEffect(() => {
-        return SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
-            if (0 === syncIdsOfInterest.length)
-                return;
-            // istanbul ignore else
-            if (syncIdsOfInterest.some((value) => args.eventIds.has(value.toLowerCase()))) {
-                // process each item that has interest
-                uiDataProvider.refreshAffectedItems(args.eventIds);
-            }
-        });
-    }, [uiDataProvider, syncIdsOfInterest, uiDataProvider.items]);
-    React.useEffect(() => {
-        return UiFramework.frontstages.onToolActivatedEvent.addListener(({ toolId }) => {
-            uiDataProvider.setActiveToolId(toolId);
-        });
-    }, [uiDataProvider, uiDataProvider.items]);
-}
-function nestedAddItemToSpecifiedParentGroup(items, groupChildren) {
-    const outItems = [];
-    for (const toolbarItem of items) {
-        if (!isToolbarGroupItem(toolbarItem)) {
-            outItems.push(toolbarItem);
-            continue;
-        }
-        const newChildren = nestedAddItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
-        const foundIndices = [];
-        groupChildren.forEach((entry, index) => {
-            if (entry.parentGroupItemId === toolbarItem.id) {
-                foundIndices.push(index);
-            }
-        });
-        // istanbul ignore else
-        if (foundIndices.length) {
-            // process in reverse order so groupChildren can be reduced as we find matches
-            foundIndices
-                .sort(
-            // istanbul ignore next
-            (a, b) => a - b)
-                .reverse()
-                .forEach((foundIndex) => {
-                newChildren.push(groupChildren[foundIndex]);
-                groupChildren.splice(foundIndex);
-            });
-        }
-        outItems.push({ ...toolbarItem, items: newChildren });
-    }
-    return outItems;
-}
+import { Toolbar } from "./Toolbar";
+import { useActiveToolIdSynchedItems } from "./useActiveToolIdSynchedItems";
+import { useActiveStageProvidedToolbarItems } from "./useActiveStageProvidedToolbarItems";
 function addItemToSpecifiedParentGroup(items, groupChildren) {
     const outItems = [];
     for (const toolbarItem of items) {
@@ -75,7 +22,7 @@ function addItemToSpecifiedParentGroup(items, groupChildren) {
             outItems.push(toolbarItem);
             continue;
         }
-        const newChildren = nestedAddItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
+        const newChildren = addItemToSpecifiedParentGroup(toolbarItem.items, groupChildren);
         const foundIndices = [];
         groupChildren.forEach((entry, index) => {
             if (entry.parentGroupItemId === toolbarItem.id) {
@@ -116,76 +63,54 @@ function getItemSortValue(item) {
         : /* istanbul ignore next */ item.groupPriority;
     return groupValue * 10000 + item.itemPriority;
 }
-function getSortedChildren(group) {
-    const sortedChildren = group.items
-        .filter((item) => !ConditionalBooleanValue.getValue(item.isHidden))
+function sortItems(items) {
+    return [...items]
         .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))
         .map((i) => {
         if (isToolbarGroupItem(i)) {
-            return { ...i, items: getSortedChildren(i) };
+            return { ...i, items: sortItems(i.items) };
         }
         return i;
     });
-    return sortedChildren;
+}
+/**
+ * Create a forEach handler that will add every element of an array of ToolbarItems
+ * to a list of items that can then be replaced in its proper place, ensuring that
+ * the same item, from different list, is not added multiple times.
+ * @param items Output list of items
+ * @param groupChildren Output list of group children to redistribute.
+ * @returns Array<ToolbarItem>.forEach handler.
+ */
+function addIfNotDuplicate(items, groupChildren) {
+    return (srcItem) => {
+        if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
+            // if the default item is a group that an addon may insert into copy it so we don't mess with original
+            const toolbarItem = isToolbarGroupItem(srcItem)
+                ? cloneGroup(srcItem)
+                : srcItem;
+            if ((isToolbarGroupItem(toolbarItem) || isToolbarActionItem(toolbarItem)) &&
+                toolbarItem.parentGroupItemId)
+                groupChildren.push(toolbarItem);
+            else
+                items.push(toolbarItem);
+        }
+    };
 }
 /** local function to combine items from Stage and from Extensions */
 function combineItems(defaultItems, addonItems) {
     let items = [];
     const groupChildren = [];
-    // istanbul ignore else
-    if (defaultItems.length) {
-        defaultItems.forEach((srcItem) => {
-            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
-                // if the default item is a group that an addon may insert into copy it so we don't mess with original
-                const toolbarItem = isToolbarGroupItem(srcItem)
-                    ? cloneGroup(srcItem)
-                    : srcItem;
-                if ((isToolbarGroupItem(toolbarItem) ||
-                    isToolbarActionItem(toolbarItem)) &&
-                    toolbarItem.parentGroupItemId)
-                    groupChildren.push(toolbarItem);
-                else
-                    items.push(toolbarItem);
-            }
-        });
-    }
-    // istanbul ignore else
-    if (addonItems.length) {
-        addonItems.forEach((srcItem) => {
-            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
-                // if the default item is a group that an addon may insert into copy it so we don't mess with original
-                const toolbarItem = isToolbarGroupItem(srcItem)
-                    ? cloneGroup(srcItem)
-                    : srcItem;
-                if ((isToolbarGroupItem(toolbarItem) ||
-                    isToolbarActionItem(toolbarItem)) &&
-                    toolbarItem.parentGroupItemId)
-                    groupChildren.push(toolbarItem);
-                else
-                    items.push(toolbarItem);
-            }
-        });
-    }
+    defaultItems.forEach(addIfNotDuplicate(items, groupChildren));
+    addonItems.forEach(addIfNotDuplicate(items, groupChildren));
     // if an item from an addon has specified a parent group then try to find it and insert it.  If no parent is found, add item at root level.
     if (groupChildren.length) {
         items = addItemToSpecifiedParentGroup(items, groupChildren);
-        if (groupChildren.length) {
-            groupChildren.forEach((toolbarItem) => {
-                Logger.logWarning("ToolbarComposer", `Requested Parent Group [${toolbarItem.parentGroupItemId}] not found, so item [${toolbarItem.id}] is added directly to toolbar.`);
-                items.push(toolbarItem);
-            });
-        }
+        groupChildren.forEach((toolbarItem) => {
+            Logger.logWarning("ToolbarComposer", `Requested Parent Group [${toolbarItem.parentGroupItemId}] not found, so item [${toolbarItem.id}] is added directly to toolbar.`);
+            items.push(toolbarItem);
+        });
     }
-    const availableItems = items
-        .filter((item) => !ConditionalBooleanValue.getValue(item.isHidden))
-        .sort((a, b) => getItemSortValue(a) - getItemSortValue(b))
-        .map((i) => {
-        if (isToolbarGroupItem(i)) {
-            return { ...i, items: getSortedChildren(i) };
-        }
-        return i;
-    });
-    return availableItems;
+    return sortItems(items);
 }
 const useProximityOpacitySetting = () => {
     const [proximityOpacity, setProximityOpacity] = React.useState(UiFramework.visibility.useProximityOpacity);
@@ -202,27 +127,18 @@ const useProximityOpacitySetting = () => {
     return proximityOpacity;
 };
 /**
- * Toolbar that is populated and maintained by item managers.
+ * Toolbar that is populated and maintained by item managers, will override
+ * isActive property based on the active tool id.
  * @public
  */
 export function ToolbarComposer(props) {
     const { usage, orientation } = props;
-    const [defaultItemsManager, setDefaultItemsManager] = React.useState(() => new ToolbarItemsManager(props.items));
-    React.useEffect(() => {
-        setDefaultItemsManager(new ToolbarItemsManager(props.items));
-    }, [props.items]);
-    // process default items
-    const defaultItems = useDefaultToolbarItems(defaultItemsManager);
-    const syncIdsOfInterest = React.useMemo(() => ToolbarItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);
-    useToolbarItemSyncEffect(defaultItemsManager, syncIdsOfInterest);
     // process items from addon UI providers
-    const [addonItemsManager] = React.useState(() => new ToolbarItemsManager());
-    const addonItems = useUiItemsProviderToolbarItems(addonItemsManager, usage, orientation);
-    const addonSyncIdsOfInterest = React.useMemo(() => ToolbarItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);
-    useToolbarItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);
-    const items = React.useMemo(() => {
-        return combineItems(defaultItems, addonItems);
-    }, [defaultItems, addonItems]);
+    const addonItems = useActiveStageProvidedToolbarItems(usage, orientation);
+    const allItems = React.useMemo(() => {
+        return combineItems(props.items, addonItems);
+    }, [props.items, addonItems]);
+    const items = useActiveToolIdSynchedItems(allItems, UiFramework.frontstages);
     const toolbarOrientation = orientation === ToolbarOrientation.Horizontal
         ? Orientation.Horizontal
         : Orientation.Vertical;
@@ -237,7 +153,7 @@ export function ToolbarComposer(props) {
         : ToolbarPanelAlignment.Start;
     const isDragEnabled = React.useContext(ToolbarDragInteractionContext);
     const useProximityOpacity = useProximityOpacitySetting();
-    return (React.createElement(ToolbarWithOverflow, { expandsTo: expandsTo, panelAlignment: panelAlignment, items: items, useDragInteraction: isDragEnabled, toolbarOpacitySetting: useProximityOpacity && !UiFramework.isMobile()
+    return (React.createElement(Toolbar, { enableOverflow: true, expandsTo: expandsTo, panelAlignment: panelAlignment, items: items, useDragInteraction: isDragEnabled, toolbarOpacitySetting: useProximityOpacity && !UiFramework.isMobile()
             ? ToolbarOpacitySetting.Proximity
             : /* istanbul ignore next */ ToolbarOpacitySetting.Defaults }));
 }