bug: duplicate container HTML Element

Author: mathuo

packages/dockview-core/src/__tests__/gridview/baseComponentGridview.spec.ts

@@ -105,6 +105,21 @@ class ClassUnderTest extends BaseGrid<TestPanel> {
 }
 
 describe('baseComponentGridview', () => {
+    test('that the container is not removed when grid is disposed', () => {
+        const root = document.createElement('div');
+        const container = document.createElement('div');
+        root.appendChild(container);
+
+        const cut = new ClassUnderTest(container, {
+            orientation: Orientation.HORIZONTAL,
+            proportionalLayout: true,
+        });
+
+        cut.dispose();
+
+        expect(container.parentElement).toBe(root);
+    });
+
     test('that .layout(...) force flag works', () => {
         const cut = new ClassUnderTest(document.createElement('div'), {
             orientation: Orientation.HORIZONTAL,

packages/dockview-core/src/dockview/dockviewComponent.ts

@@ -368,8 +368,8 @@ export class DockviewComponent
         return this._floatingGroups;
     }
 
-    constructor(parentElement: HTMLElement, options: DockviewComponentOptions) {
-        super(parentElement, {
+    constructor(container: HTMLElement, options: DockviewComponentOptions) {
+        super(container, {
             proportionalLayout: true,
             orientation: Orientation.HORIZONTAL,
             styles: options.hideBorders

packages/dockview-core/src/gridview/baseComponentGridview.ts

@@ -155,14 +155,17 @@ export abstract class BaseGrid<T extends IGridPanelView>
         this.gridview.locked = value;
     }
 
-    constructor(parentElement: HTMLElement, options: BaseGridOptions) {
-        super(parentElement, options.disableAutoResizing);
+    constructor(container: HTMLElement, options: BaseGridOptions) {
+        super(document.createElement('div'), options.disableAutoResizing);
         this.element.style.height = '100%';
         this.element.style.width = '100%';
 
         this._classNames = new Classnames(this.element);
         this._classNames.setClassNames(options.className ?? '');
 
+        // the container is owned by the third-party, do not modify/delete it
+        container.appendChild(this.element);
+
         this.gridview = new Gridview(
             !!options.proportionalLayout,
             options.styles,

packages/dockview-core/src/gridview/gridviewComponent.ts

@@ -113,8 +113,8 @@ export class GridviewComponent
         this._deserializer = value;
     }
 
-    constructor(parentElement: HTMLElement, options: GridviewComponentOptions) {
-        super(parentElement, {
+    constructor(container: HTMLElement, options: GridviewComponentOptions) {
+        super(container, {
             proportionalLayout: options.proportionalLayout ?? true,
             orientation: options.orientation,
             styles: options.hideBorders

packages/dockview-core/src/paneview/paneviewComponent.ts

@@ -195,8 +195,10 @@ export class PaneviewComponent extends Resizable implements IPaneviewComponent {
         return this._options;
     }
 
-    constructor(parentElement: HTMLElement, options: PaneviewComponentOptions) {
-        super(parentElement, options.disableAutoResizing);
+    constructor(container: HTMLElement, options: PaneviewComponentOptions) {
+        super(document.createElement('div'), options.disableAutoResizing);
+        this.element.style.height = '100%';
+        this.element.style.width = '100%';
 
         this.addDisposables(
             this._onDidLayoutChange,
@@ -210,6 +212,9 @@ export class PaneviewComponent extends Resizable implements IPaneviewComponent {
         this._classNames = new Classnames(this.element);
         this._classNames.setClassNames(options.className ?? '');
 
+        // the container is owned by the third-party, do not modify/delete it
+        container.appendChild(this.element);
+
         this._options = options;
 
         this.paneview = new Paneview(this.element, {

packages/dockview-core/src/splitview/splitviewComponent.ts

@@ -155,15 +155,17 @@ export class SplitviewComponent
             : this.splitview.orthogonalSize;
     }
 
-    constructor(
-        parentElement: HTMLElement,
-        options: SplitviewComponentOptions
-    ) {
-        super(parentElement, options.disableAutoResizing);
+    constructor(container: HTMLElement, options: SplitviewComponentOptions) {
+        super(document.createElement('div'), options.disableAutoResizing);
+        this.element.style.height = '100%';
+        this.element.style.width = '100%';
 
         this._classNames = new Classnames(this.element);
         this._classNames.setClassNames(options.className ?? '');
 
+        // the container is owned by the third-party, do not modify/delete it
+        container.appendChild(this.element);
+
         this._options = options;
 
         this.splitview = new Splitview(this.element, options);

packages/dockview/src/dockview/dockview.tsx

@@ -318,11 +318,7 @@ export const DockviewReact = React.forwardRef(
         }, [props.prefixHeaderActionsComponent]);
 
         return (
-            <div
-                className={props.className}
-                style={{ height: '100%', width: '100%' }}
-                ref={domRef}
-            >
+            <div style={{ height: '100%', width: '100%' }} ref={domRef}>
                 {portals}
             </div>
         );

packages/dockview/src/gridview/gridview.tsx

@@ -126,11 +126,7 @@ export const GridviewReact = React.forwardRef(
         }, [props.components]);
 
         return (
-            <div
-                className={props.className}
-                style={{ height: '100%', width: '100%' }}
-                ref={domRef}
-            >
+            <div style={{ height: '100%', width: '100%' }} ref={domRef}>
                 {portals}
             </div>
         );

packages/dockview/src/paneview/paneview.tsx

@@ -176,11 +176,7 @@ export const PaneviewReact = React.forwardRef(
         }, [props.onDidDrop]);
 
         return (
-            <div
-                className={props.className}
-                style={{ height: '100%', width: '100%' }}
-                ref={domRef}
-            >
+            <div style={{ height: '100%', width: '100%' }} ref={domRef}>
                 {portals}
             </div>
         );

packages/dockview/src/splitview/splitview.tsx

@@ -126,11 +126,7 @@ export const SplitviewReact = React.forwardRef(
         }, [props.components]);
 
         return (
-            <div
-                className={props.className}
-                style={{ height: '100%', width: '100%' }}
-                ref={domRef}
-            >
+            <div style={{ height: '100%', width: '100%' }} ref={domRef}>
                 {portals}
             </div>
         );