dockview-core 4.3.1 → 4.4.0

package/dist/cjs/api/component.api.d.ts

@@ -419,6 +419,7 @@ export declare class DockviewApi implements CommonApi<SerializedDockview> {
     get onUnhandledDragOverEvent(): Event<DockviewDndOverlayEvent>;
     get onDidPopoutGroupSizeChange(): Event<PopoutGroupChangeSizeEvent>;
     get onDidPopoutGroupPositionChange(): Event<PopoutGroupChangePositionEvent>;
+    get onDidOpenPopoutWindowFail(): Event<void>;
     /**
      * All panel objects.
      */

package/dist/cjs/api/component.api.js

@@ -831,6 +831,13 @@ var DockviewApi = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(DockviewApi.prototype, "onDidOpenPopoutWindowFail", {
+        get: function () {
+            return this.component.onDidOpenPopoutWindowFail;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(DockviewApi.prototype, "panels", {
         /**
          * All panel objects.

package/dist/cjs/dockview/dockviewComponent.d.ts

@@ -140,6 +140,7 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     readonly onDidMaximizedGroupChange: Event<DockviewMaximizedGroupChanged>;
     readonly onDidPopoutGroupSizeChange: Event<PopoutGroupChangeSizeEvent>;
     readonly onDidPopoutGroupPositionChange: Event<PopoutGroupChangePositionEvent>;
+    readonly onDidOpenPopoutWindowFail: Event<void>;
     readonly options: DockviewComponentOptions;
     updateOptions(options: DockviewOptions): void;
     moveGroupOrPanel(options: MoveGroupOrPanelOptions): void;
@@ -202,6 +203,8 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     readonly onDidPopoutGroupSizeChange: Event<PopoutGroupChangeSizeEvent>;
     private readonly _onDidPopoutGroupPositionChange;
     readonly onDidPopoutGroupPositionChange: Event<PopoutGroupChangePositionEvent>;
+    private readonly _onDidOpenPopoutWindowFail;
+    readonly onDidOpenPopoutWindowFail: Event<void>;
     private readonly _onDidLayoutFromJSON;
     readonly onDidLayoutFromJSON: Event<void>;
     private readonly _onDidActivePanelChange;

package/dist/cjs/dockview/dockviewComponent.js

@@ -146,6 +146,8 @@ var DockviewComponent = /** @class */ (function (_super) {
         _this.onDidPopoutGroupSizeChange = _this._onDidPopoutGroupSizeChange.event;
         _this._onDidPopoutGroupPositionChange = new events_1.Emitter();
         _this.onDidPopoutGroupPositionChange = _this._onDidPopoutGroupPositionChange.event;
+        _this._onDidOpenPopoutWindowFail = new events_1.Emitter();
+        _this.onDidOpenPopoutWindowFail = _this._onDidOpenPopoutWindowFail.event;
         _this._onDidLayoutFromJSON = new events_1.Emitter();
         _this.onDidLayoutFromJSON = _this._onDidLayoutFromJSON.event;
         _this._onDidActivePanelChange = new events_1.Emitter({ replay: true });
@@ -210,7 +212,7 @@ var DockviewComponent = /** @class */ (function (_super) {
         if (options.debug) {
             _this.addDisposables(new strictEventsSequencing_1.StrictEventsSequencing(_this));
         }
-        _this.addDisposables(_this.rootDropTargetContainer, _this.overlayRenderContainer, _this._onWillDragPanel, _this._onWillDragGroup, _this._onWillShowOverlay, _this._onDidActivePanelChange, _this._onDidAddPanel, _this._onDidRemovePanel, _this._onDidLayoutFromJSON, _this._onDidDrop, _this._onWillDrop, _this._onDidMovePanel, _this._onDidAddGroup, _this._onDidRemoveGroup, _this._onDidActiveGroupChange, _this._onUnhandledDragOverEvent, _this._onDidMaximizedGroupChange, _this._onDidOptionsChange, _this._onDidPopoutGroupSizeChange, _this._onDidPopoutGroupPositionChange, _this.onDidViewVisibilityChangeMicroTaskQueue(function () {
+        _this.addDisposables(_this.rootDropTargetContainer, _this.overlayRenderContainer, _this._onWillDragPanel, _this._onWillDragGroup, _this._onWillShowOverlay, _this._onDidActivePanelChange, _this._onDidAddPanel, _this._onDidRemovePanel, _this._onDidLayoutFromJSON, _this._onDidDrop, _this._onWillDrop, _this._onDidMovePanel, _this._onDidAddGroup, _this._onDidRemoveGroup, _this._onDidActiveGroupChange, _this._onUnhandledDragOverEvent, _this._onDidMaximizedGroupChange, _this._onDidOptionsChange, _this._onDidPopoutGroupSizeChange, _this._onDidPopoutGroupPositionChange, _this._onDidOpenPopoutWindowFail, _this.onDidViewVisibilityChangeMicroTaskQueue(function () {
             _this.updateWatermark();
         }), _this.onDidAdd(function (event) {
             if (!_this._moving) {
@@ -440,13 +442,6 @@ var DockviewComponent = /** @class */ (function (_super) {
             if (_window.isDisposed) {
                 return false;
             }
-            if (popoutContainer === null) {
-                popoutWindowDisposable.dispose();
-                return false;
-            }
-            var gready = document.createElement('div');
-            gready.className = 'dv-overlay-render-container';
-            var overlayRenderContainer = new overlayRenderContainer_1.OverlayRenderContainer(gready, _this);
             var referenceGroup = (options === null || options === void 0 ? void 0 : options.referenceGroup)
                 ? options.referenceGroup
                 : itemToPopout instanceof dockviewPanel_1.DockviewPanel
@@ -454,7 +449,7 @@ var DockviewComponent = /** @class */ (function (_super) {
                     : itemToPopout;
             var referenceLocation = itemToPopout.api.location.type;
             /**
-             * The group that is being added doesn't already exist within the DOM, the most likely occurance
+             * The group that is being added doesn't already exist within the DOM, the most likely occurrence
              * of this case is when being called from the `fromJSON(...)` method
              */
             var isGroupAddedToDom = referenceGroup.element.parentElement !== null;
@@ -467,8 +462,30 @@ var DockviewComponent = /** @class */ (function (_super) {
             }
             else {
                 group = _this.createGroup({ id: groupId });
-                _this._onDidAddGroup.fire(group);
+                if (popoutContainer) {
+                    _this._onDidAddGroup.fire(group);
+                }
             }
+            if (popoutContainer === null) {
+                console.error('dockview: failed to create popout. perhaps you need to allow pop-ups for this website');
+                popoutWindowDisposable.dispose();
+                _this._onDidOpenPopoutWindowFail.fire();
+                // if the popout window was blocked, we need to move the group back to the reference group
+                // and set it to visible
+                _this.movingLock(function () {
+                    return moveGroupWithoutDestroying({
+                        from: group,
+                        to: referenceGroup,
+                    });
+                });
+                if (!referenceGroup.api.isVisible) {
+                    referenceGroup.api.setVisible(true);
+                }
+                return false;
+            }
+            var gready = document.createElement('div');
+            gready.className = 'dv-overlay-render-container';
+            var overlayRenderContainer = new overlayRenderContainer_1.OverlayRenderContainer(gready, _this);
             group.model.renderContainer = overlayRenderContainer;
             group.layout(_window.window.innerWidth, _window.window.innerHeight);
             var floatingBox;
@@ -631,7 +648,7 @@ var DockviewComponent = /** @class */ (function (_super) {
             return true;
         })
             .catch(function (err) {
-            console.error('dockview: failed to create popout window', err);
+            console.error('dockview: failed to create popout.', err);
             return false;
         });
     };

package/dist/dockview-core.amd.js

@@ -1,6 +1,6 @@
 /**
  * dockview-core
- * @version 4.3.1
+ * @version 4.4.0
  * @link https://github.com/mathuo/dockview
  * @license MIT
  */
@@ -3652,6 +3652,9 @@ define(['exports'], (function (exports) { 'use strict';
       get onDidPopoutGroupPositionChange() {
           return this.component.onDidPopoutGroupPositionChange;
       }
+      get onDidOpenPopoutWindowFail() {
+          return this.component.onDidOpenPopoutWindowFail;
+      }
       /**
        * All panel objects.
        */
@@ -8254,6 +8257,8 @@ define(['exports'], (function (exports) { 'use strict';
           this.onDidPopoutGroupSizeChange = this._onDidPopoutGroupSizeChange.event;
           this._onDidPopoutGroupPositionChange = new Emitter();
           this.onDidPopoutGroupPositionChange = this._onDidPopoutGroupPositionChange.event;
+          this._onDidOpenPopoutWindowFail = new Emitter();
+          this.onDidOpenPopoutWindowFail = this._onDidOpenPopoutWindowFail.event;
           this._onDidLayoutFromJSON = new Emitter();
           this.onDidLayoutFromJSON = this._onDidLayoutFromJSON.event;
           this._onDidActivePanelChange = new Emitter({ replay: true });
@@ -8318,7 +8323,7 @@ define(['exports'], (function (exports) { 'use strict';
           if (options.debug) {
               this.addDisposables(new StrictEventsSequencing(this));
           }
-          this.addDisposables(this.rootDropTargetContainer, this.overlayRenderContainer, this._onWillDragPanel, this._onWillDragGroup, this._onWillShowOverlay, this._onDidActivePanelChange, this._onDidAddPanel, this._onDidRemovePanel, this._onDidLayoutFromJSON, this._onDidDrop, this._onWillDrop, this._onDidMovePanel, this._onDidAddGroup, this._onDidRemoveGroup, this._onDidActiveGroupChange, this._onUnhandledDragOverEvent, this._onDidMaximizedGroupChange, this._onDidOptionsChange, this._onDidPopoutGroupSizeChange, this._onDidPopoutGroupPositionChange, this.onDidViewVisibilityChangeMicroTaskQueue(() => {
+          this.addDisposables(this.rootDropTargetContainer, this.overlayRenderContainer, this._onWillDragPanel, this._onWillDragGroup, this._onWillShowOverlay, this._onDidActivePanelChange, this._onDidAddPanel, this._onDidRemovePanel, this._onDidLayoutFromJSON, this._onDidDrop, this._onWillDrop, this._onDidMovePanel, this._onDidAddGroup, this._onDidRemoveGroup, this._onDidActiveGroupChange, this._onUnhandledDragOverEvent, this._onDidMaximizedGroupChange, this._onDidOptionsChange, this._onDidPopoutGroupSizeChange, this._onDidPopoutGroupPositionChange, this._onDidOpenPopoutWindowFail, this.onDidViewVisibilityChangeMicroTaskQueue(() => {
               this.updateWatermark();
           }), this.onDidAdd((event) => {
               if (!this._moving) {
@@ -8464,13 +8469,6 @@ define(['exports'], (function (exports) { 'use strict';
               if (_window.isDisposed) {
                   return false;
               }
-              if (popoutContainer === null) {
-                  popoutWindowDisposable.dispose();
-                  return false;
-              }
-              const gready = document.createElement('div');
-              gready.className = 'dv-overlay-render-container';
-              const overlayRenderContainer = new OverlayRenderContainer(gready, this);
               const referenceGroup = (options === null || options === void 0 ? void 0 : options.referenceGroup)
                   ? options.referenceGroup
                   : itemToPopout instanceof DockviewPanel
@@ -8478,7 +8476,7 @@ define(['exports'], (function (exports) { 'use strict';
                       : itemToPopout;
               const referenceLocation = itemToPopout.api.location.type;
               /**
-               * The group that is being added doesn't already exist within the DOM, the most likely occurance
+               * The group that is being added doesn't already exist within the DOM, the most likely occurrence
                * of this case is when being called from the `fromJSON(...)` method
                */
               const isGroupAddedToDom = referenceGroup.element.parentElement !== null;
@@ -8491,8 +8489,28 @@ define(['exports'], (function (exports) { 'use strict';
               }
               else {
                   group = this.createGroup({ id: groupId });
-                  this._onDidAddGroup.fire(group);
+                  if (popoutContainer) {
+                      this._onDidAddGroup.fire(group);
+                  }
               }
+              if (popoutContainer === null) {
+                  console.error('dockview: failed to create popout. perhaps you need to allow pop-ups for this website');
+                  popoutWindowDisposable.dispose();
+                  this._onDidOpenPopoutWindowFail.fire();
+                  // if the popout window was blocked, we need to move the group back to the reference group
+                  // and set it to visible
+                  this.movingLock(() => moveGroupWithoutDestroying({
+                      from: group,
+                      to: referenceGroup,
+                  }));
+                  if (!referenceGroup.api.isVisible) {
+                      referenceGroup.api.setVisible(true);
+                  }
+                  return false;
+              }
+              const gready = document.createElement('div');
+              gready.className = 'dv-overlay-render-container';
+              const overlayRenderContainer = new OverlayRenderContainer(gready, this);
               group.model.renderContainer = overlayRenderContainer;
               group.layout(_window.window.innerWidth, _window.window.innerHeight);
               let floatingBox;
@@ -8649,7 +8667,7 @@ define(['exports'], (function (exports) { 'use strict';
               return true;
           })
               .catch((err) => {
-              console.error('dockview: failed to create popout window', err);
+              console.error('dockview: failed to create popout.', err);
               return false;
           });
       }