dockview-core 1.11.0 → 1.12.0

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

@@ -19,6 +19,12 @@ export interface ActiveGroupEvent {
 export interface GroupChangedEvent {
 }
 export interface DockviewPanelApi extends Omit<GridviewPanelApi, 'setVisible' | 'onDidConstraintsChange' | 'setConstraints'> {
+    /**
+     * The id of the tab component renderer
+     *
+     * Undefined if no custom tab renderer is provided
+     */
+    readonly tabComponent: string | undefined;
     readonly group: DockviewGroupPanel;
     readonly isGroupActive: boolean;
     readonly renderer: DockviewPanelRenderer;

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

@@ -23,6 +23,10 @@ export interface PanelApi {
     setActive(): void;
     setVisible(isVisible: boolean): void;
     updateParameters(parameters: Parameters): void;
+    /**
+     * The id of the component renderer
+     */
+    readonly component: string;
     /**
      * The id of the panel that would have been assigned when the panel was created
      */

package/dist/cjs/dockview/components/panel/content.js

@@ -98,7 +98,7 @@ var ContentContainer = /** @class */ (function (_super) {
         this.panel = panel;
         var container;
         switch (panel.api.renderer) {
-            case 'onlyWhenVisibile':
+            case 'onlyWhenVisible':
                 this.group.renderContainer.detatch(panel);
                 if (this.panel) {
                     if (doRender) {
@@ -144,7 +144,7 @@ var ContentContainer = /** @class */ (function (_super) {
     ContentContainer.prototype.closePanel = function () {
         var _a;
         if (this.panel) {
-            if (this.panel.api.renderer === 'onlyWhenVisibile') {
+            if (this.panel.api.renderer === 'onlyWhenVisible') {
                 (_a = this.panel.view.content.element.parentElement) === null || _a === void 0 ? void 0 : _a.removeChild(this.panel.view.content.element);
             }
         }

package/dist/cjs/dockview/components/titlebar/tabsContainer.js

@@ -58,6 +58,7 @@ var tab_1 = require("../tab/tab");
 var voidContainer_1 = require("./voidContainer");
 var dom_1 = require("../../../dom");
 var dockviewGroupPanelModel_1 = require("../../dockviewGroupPanelModel");
+var dataTransfer_1 = require("../../../dnd/dataTransfer");
 var TabsContainer = /** @class */ (function (_super) {
     __extends(TabsContainer, _super);
     function TabsContainer(accessor, group) {
@@ -113,6 +114,10 @@ var TabsContainer = /** @class */ (function (_super) {
         }), _this.voidContainer.onWillShowOverlay(function (event) {
             _this._onWillShowOverlay.fire(new dockviewGroupPanelModel_1.WillShowOverlayLocationEvent(event, {
                 kind: 'header_space',
+                panel: _this.group.activePanel,
+                api: _this.accessor.api,
+                group: _this.group,
+                getData: dataTransfer_1.getPanelData,
             }));
         }), (0, events_1.addDisposableListener)(_this.voidContainer.element, 'mousedown', function (event) {
             var isFloatingGroupsEnabled = !_this.accessor.options.disableFloatingGroups;
@@ -298,7 +303,13 @@ var TabsContainer = /** @class */ (function (_super) {
                 index: _this.tabs.findIndex(function (x) { return x.value === tab; }),
             });
         }), tab.onWillShowOverlay(function (event) {
-            _this._onWillShowOverlay.fire(new dockviewGroupPanelModel_1.WillShowOverlayLocationEvent(event, { kind: 'tab' }));
+            _this._onWillShowOverlay.fire(new dockviewGroupPanelModel_1.WillShowOverlayLocationEvent(event, {
+                kind: 'tab',
+                panel: _this.group.activePanel,
+                api: _this.accessor.api,
+                group: _this.group,
+                getData: dataTransfer_1.getPanelData,
+            }));
         }));
         var value = { value: tab, disposable: disposable };
         this.addTab(value, index);

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

@@ -5,6 +5,7 @@ import { Event, Emitter } from '../events';
 import { IWatermarkRenderer, GroupviewPanelState } from './types';
 import { AddGroupOptions, AddPanelOptions, DockviewComponentOptions, MovementOptions } from './options';
 import { BaseGrid, IBaseGrid } from '../gridview/baseComponentGridview';
+import { DockviewApi } from '../api/component.api';
 import { Orientation } from '../splitview/splitview';
 import { GroupOptions, GroupPanelViewState, DockviewDidDropEvent, DockviewWillDropEvent, WillShowOverlayLocationEvent } from './dockviewGroupPanelModel';
 import { DockviewGroupPanel } from './dockviewGroupPanel';
@@ -156,6 +157,7 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     get options(): DockviewComponentOptions;
     get activePanel(): IDockviewPanel | undefined;
     get renderer(): DockviewPanelRenderer;
+    get api(): DockviewApi;
     constructor(options: DockviewComponentOptions);
     addPopoutGroup(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: {
         skipRemoveGroup?: boolean;

package/dist/cjs/dockview/dockviewComponent.js

@@ -342,6 +342,10 @@ var DockviewComponent = /** @class */ (function (_super) {
             }
             _this._onWillShowOverlay.fire(new dockviewGroupPanelModel_1.WillShowOverlayLocationEvent(event, {
                 kind: 'edge',
+                panel: undefined,
+                api: _this._api,
+                group: undefined,
+                getData: dataTransfer_1.getPanelData,
             }));
         }), _this._rootDropTarget.onDrop(function (event) {
             var _a;
@@ -428,7 +432,14 @@ var DockviewComponent = /** @class */ (function (_super) {
     Object.defineProperty(DockviewComponent.prototype, "renderer", {
         get: function () {
             var _a;
-            return (_a = this.options.defaultRenderer) !== null && _a !== void 0 ? _a : 'onlyWhenVisibile';
+            return (_a = this.options.defaultRenderer) !== null && _a !== void 0 ? _a : 'onlyWhenVisible';
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DockviewComponent.prototype, "api", {
+        get: function () {
+            return this._api;
         },
         enumerable: false,
         configurable: true

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

@@ -118,14 +118,22 @@ export type DockviewGroupLocation = {
 };
 export declare class WillShowOverlayLocationEvent implements IDockviewEvent {
     private readonly event;
-    private _kind;
+    private readonly options;
     get kind(): DockviewGroupDropLocation;
     get nativeEvent(): DragEvent;
     get position(): Position;
     get defaultPrevented(): boolean;
+    get panel(): IDockviewPanel | undefined;
+    get api(): DockviewApi;
+    get group(): DockviewGroupPanel | undefined;
     preventDefault(): void;
+    getData(): PanelTransfer | undefined;
     constructor(event: WillShowOverlayEvent, options: {
         kind: DockviewGroupDropLocation;
+        panel: IDockviewPanel | undefined;
+        api: DockviewApi;
+        group: DockviewGroupPanel | undefined;
+        getData: () => PanelTransfer | undefined;
     });
 }
 export declare class DockviewGroupPanelModel extends CompositeDisposable implements IDockviewGroupPanelModel {

package/dist/cjs/dockview/dockviewGroupPanelModel.js

@@ -127,11 +127,11 @@ exports.DockviewWillDropEvent = DockviewWillDropEvent;
 var WillShowOverlayLocationEvent = /** @class */ (function () {
     function WillShowOverlayLocationEvent(event, options) {
         this.event = event;
-        this._kind = options.kind;
+        this.options = options;
     }
     Object.defineProperty(WillShowOverlayLocationEvent.prototype, "kind", {
         get: function () {
-            return this._kind;
+            return this.options.kind;
         },
         enumerable: false,
         configurable: true
@@ -157,9 +157,33 @@ var WillShowOverlayLocationEvent = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(WillShowOverlayLocationEvent.prototype, "panel", {
+        get: function () {
+            return this.options.panel;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(WillShowOverlayLocationEvent.prototype, "api", {
+        get: function () {
+            return this.options.api;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(WillShowOverlayLocationEvent.prototype, "group", {
+        get: function () {
+            return this.options.group;
+        },
+        enumerable: false,
+        configurable: true
+    });
     WillShowOverlayLocationEvent.prototype.preventDefault = function () {
         this.event.preventDefault();
     };
+    WillShowOverlayLocationEvent.prototype.getData = function () {
+        return this.options.getData();
+    };
     return WillShowOverlayLocationEvent;
 }());
 exports.WillShowOverlayLocationEvent = WillShowOverlayLocationEvent;
@@ -230,6 +254,10 @@ var DockviewGroupPanelModel = /** @class */ (function (_super) {
         }), _this.contentContainer.dropTarget.onWillShowOverlay(function (event) {
             _this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, {
                 kind: 'content',
+                panel: _this.activePanel,
+                api: _this._api,
+                group: _this.groupPanel,
+                getData: dataTransfer_1.getPanelData,
             }));
         }), _this._onMove, _this._onDidChange, _this._onDidDrop, _this._onWillDrop, _this._onDidAddPanel, _this._onDidRemovePanel, _this._onDidActivePanelChange);
         return _this;

package/dist/cjs/overlayRenderContainer.d.ts

@@ -1,7 +1,7 @@
 import { Droptarget } from './dnd/droptarget';
 import { CompositeDisposable } from './lifecycle';
 import { IDockviewPanel } from './dockview/dockviewPanel';
-export type DockviewPanelRenderer = 'onlyWhenVisibile' | 'always';
+export type DockviewPanelRenderer = 'onlyWhenVisible' | 'always';
 export interface IRenderable {
     readonly element: HTMLElement;
     readonly dropTarget: Droptarget;

package/dist/dockview-core.amd.js

@@ -1,6 +1,6 @@
 /**
  * dockview-core
- * @version 1.11.0
+ * @version 1.12.0
  * @link https://github.com/mathuo/dockview
  * @license MIT
  */
@@ -3573,7 +3573,7 @@ define(['exports'], (function (exports) { 'use strict';
           this.panel = panel;
           let container;
           switch (panel.api.renderer) {
-              case 'onlyWhenVisibile':
+              case 'onlyWhenVisible':
                   this.group.renderContainer.detatch(panel);
                   if (this.panel) {
                       if (doRender) {
@@ -3619,7 +3619,7 @@ define(['exports'], (function (exports) { 'use strict';
       closePanel() {
           var _a;
           if (this.panel) {
-              if (this.panel.api.renderer === 'onlyWhenVisibile') {
+              if (this.panel.api.renderer === 'onlyWhenVisible') {
                   (_a = this.panel.view.content.element.parentElement) === null || _a === void 0 ? void 0 : _a.removeChild(this.panel.view.content.element);
               }
           }
@@ -4008,6 +4008,10 @@ define(['exports'], (function (exports) { 'use strict';
           }), this.voidContainer.onWillShowOverlay((event) => {
               this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, {
                   kind: 'header_space',
+                  panel: this.group.activePanel,
+                  api: this.accessor.api,
+                  group: this.group,
+                  getData: getPanelData,
               }));
           }), addDisposableListener(this.voidContainer.element, 'mousedown', (event) => {
               const isFloatingGroupsEnabled = !this.accessor.options.disableFloatingGroups;
@@ -4105,7 +4109,13 @@ define(['exports'], (function (exports) { 'use strict';
                   index: this.tabs.findIndex((x) => x.value === tab),
               });
           }), tab.onWillShowOverlay((event) => {
-              this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, { kind: 'tab' }));
+              this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, {
+                  kind: 'tab',
+                  panel: this.group.activePanel,
+                  api: this.accessor.api,
+                  group: this.group,
+                  getData: getPanelData,
+              }));
           }));
           const value = { value: tab, disposable };
           this.addTab(value, index);
@@ -4158,7 +4168,7 @@ define(['exports'], (function (exports) { 'use strict';
   }
   class WillShowOverlayLocationEvent {
       get kind() {
-          return this._kind;
+          return this.options.kind;
       }
       get nativeEvent() {
           return this.event.nativeEvent;
@@ -4169,12 +4179,24 @@ define(['exports'], (function (exports) { 'use strict';
       get defaultPrevented() {
           return this.event.defaultPrevented;
       }
+      get panel() {
+          return this.options.panel;
+      }
+      get api() {
+          return this.options.api;
+      }
+      get group() {
+          return this.options.group;
+      }
       preventDefault() {
           this.event.preventDefault();
       }
+      getData() {
+          return this.options.getData();
+      }
       constructor(event, options) {
           this.event = event;
-          this._kind = options.kind;
+          this.options = options;
       }
   }
   class DockviewGroupPanelModel extends CompositeDisposable {
@@ -4313,6 +4335,10 @@ define(['exports'], (function (exports) { 'use strict';
           }), this.contentContainer.dropTarget.onWillShowOverlay((event) => {
               this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, {
                   kind: 'content',
+                  panel: this.activePanel,
+                  api: this._api,
+                  group: this.groupPanel,
+                  getData: getPanelData,
               }));
           }), this._onMove, this._onDidChange, this._onDidDrop, this._onWillDrop, this._onDidAddPanel, this._onDidRemovePanel, this._onDidActivePanelChange);
       }
@@ -6981,7 +7007,10 @@ define(['exports'], (function (exports) { 'use strict';
       }
       get renderer() {
           var _a;
-          return (_a = this.options.defaultRenderer) !== null && _a !== void 0 ? _a : 'onlyWhenVisibile';
+          return (_a = this.options.defaultRenderer) !== null && _a !== void 0 ? _a : 'onlyWhenVisible';
+      }
+      get api() {
+          return this._api;
       }
       constructor(options) {
           var _a, _b;
@@ -7116,6 +7145,10 @@ define(['exports'], (function (exports) { 'use strict';
               }
               this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, {
                   kind: 'edge',
+                  panel: undefined,
+                  api: this._api,
+                  group: undefined,
+                  getData: getPanelData,
               }));
           }), this._rootDropTarget.onDrop((event) => {
               var _a;