dockview-core 1.13.1 → 1.14.1

package/dist/esm/api/dockviewGroupPanelApi.js

@@ -2,8 +2,7 @@ import { positionToDirection } from '../dnd/droptarget';
 import { Emitter } from '../events';
 import { MutableDisposable } from '../lifecycle';
 import { GridviewPanelApiImpl } from './gridviewPanelApi';
-// TODO find a better way to initialize and avoid needing null checks
-const NOT_INITIALIZED_MESSAGE = 'DockviewGroupPanelApiImpl not initialized';
+const NOT_INITIALIZED_MESSAGE = 'dockview: DockviewGroupPanelApiImpl not initialized';
 export class DockviewGroupPanelApiImpl extends GridviewPanelApiImpl {
     get location() {
         if (!this._group) {
@@ -76,14 +75,14 @@ export class DockviewGroupPanelApiImpl extends GridviewPanelApiImpl {
         }
     }
     initialize(group) {
-        this._group = group;
         /**
-         * TODO: Annoying initialization order caveat
+         * TODO: Annoying initialization order caveat, find a better way to initialize and avoid needing null checks
          *
          * Due to the order on initialization we know that the model isn't defined until later in the same stack-frame of setup.
          * By queuing a microtask we can ensure the setup is completed within the same stack-frame, but after everything else has
          * finished ensuring the `model` is defined.
          */
+        this._group = group;
         queueMicrotask(() => {
             this._mutableDisposable.value =
                 this._group.model.onDidActivePanelChange((event) => {

package/dist/esm/api/dockviewPanelApi.js

@@ -88,12 +88,10 @@ export class DockviewPanelApiImpl extends GridviewPanelApiImpl {
         var _a;
         let _trackGroupActive = (_a = previousGroup === null || previousGroup === void 0 ? void 0 : previousGroup.isActive) !== null && _a !== void 0 ? _a : false; // prevent duplicate events with same state
         this.groupEventsDisposable.value = new CompositeDisposable(this.group.api.onDidVisibilityChange((event) => {
-            if (!event.isVisible && this.isVisible) {
-                this._onDidVisibilityChange.fire(event);
-            }
-            else if (event.isVisible &&
-                !this.isVisible &&
-                this.group.model.isPanelActive(this.panel)) {
+            const hasBecomeHidden = !event.isVisible && this.isVisible;
+            const hasBecomeVisible = event.isVisible && !this.isVisible;
+            const isActivePanel = this.group.model.isPanelActive(this.panel);
+            if (hasBecomeHidden || (hasBecomeVisible && isActivePanel)) {
                 this._onDidVisibilityChange.fire(event);
             }
         }), this.group.api.onDidLocationChange((event) => {

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

@@ -3,7 +3,7 @@ import { addDisposableListener, Emitter } from '../../../events';
 import { Tab } from '../tab/tab';
 import { VoidContainer } from './voidContainer';
 import { toggleClass } from '../../../dom';
-import { WillShowOverlayLocationEvent, } from '../../dockviewGroupPanelModel';
+import { WillShowOverlayLocationEvent } from '../../dockviewGroupPanelModel';
 import { getPanelData } from '../../../dnd/dataTransfer';
 export class TabsContainer extends CompositeDisposable {
     get panels() {

package/dist/esm/dockview/dockviewComponent.js

@@ -58,66 +58,6 @@ function getDockviewTheme(element) {
     }
     return theme;
 }
-function typeValidate3(data, path) {
-    if (typeof data.id !== 'string') {
-        throw new Error(`${path}.id must be a string`);
-    }
-    if (typeof data.activeView !== 'string' ||
-        typeof data.activeView !== 'undefined') {
-        throw new Error(`${path}.activeView must be a string of undefined`);
-    }
-}
-function typeValidate2(data, path) {
-    if (typeof data.size !== 'number' && typeof data.size !== 'undefined') {
-        throw new Error(`${path}.size must be a number or undefined`);
-    }
-    if (typeof data.visible !== 'boolean' &&
-        typeof data.visible !== 'undefined') {
-        throw new Error(`${path}.visible must be a boolean or undefined`);
-    }
-    if (data.type === 'leaf') {
-        if (typeof data.data !== 'object' ||
-            data.data === null ||
-            Array.isArray(data.data)) {
-            throw new Error('object must be a non-null object');
-        }
-        typeValidate3(data.data, `${path}.data`);
-    }
-    else if (data.type === 'branch') {
-        if (!Array.isArray(data.data)) {
-            throw new Error(`${path}.data must be an array`);
-        }
-    }
-    else {
-        throw new Error(`${path}.type must be onew of {'branch', 'leaf'}`);
-    }
-}
-function typeValidate(data) {
-    if (typeof data !== 'object' || data === null) {
-        throw new Error('object must be a non-null object');
-    }
-    const { grid, panels, activeGroup, floatingGroups } = data;
-    if (typeof grid !== 'object' || grid === null) {
-        throw new Error("'.grid' must be a non-null object");
-    }
-    if (typeof grid.height !== 'number') {
-        throw new Error("'.grid.height' must be a number");
-    }
-    if (typeof grid.width !== 'number') {
-        throw new Error("'.grid.width' must be a number");
-    }
-    if (typeof grid.root !== 'object' || grid.root === null) {
-        throw new Error("'.grid.root' must be a non-null object");
-    }
-    if (grid.root.type !== 'branch') {
-        throw new Error(".grid.root.type must be of type 'branch'");
-    }
-    if (grid.orientation !== Orientation.HORIZONTAL &&
-        grid.orientation !== Orientation.VERTICAL) {
-        throw new Error(`'.grid.width' must be one of {${Orientation.HORIZONTAL}, ${Orientation.VERTICAL}}`);
-    }
-    typeValidate2(grid.root, '.grid.root');
-}
 export class DockviewComponent extends BaseGrid {
     get orientation() {
         return this.gridview.orientation;
@@ -328,7 +268,7 @@ export class DockviewComponent extends BaseGrid {
             return element.getBoundingClientRect();
         }
         const box = getBox();
-        const groupId = (_b = (_a = options === null || options === void 0 ? void 0 : options.overridePopoutGroup) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : this.getNextGroupId(); //item.id;
+        const groupId = (_b = (_a = options === null || options === void 0 ? void 0 : options.overridePopoutGroup) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : this.getNextGroupId();
         if (itemToPopout.api.location.type === 'grid') {
             itemToPopout.api.setVisible(false);
         }
@@ -444,24 +384,22 @@ export class DockviewComponent extends BaseGrid {
                         });
                     }
                 }
-                else {
-                    if (this.getPanel(group.id)) {
-                        const removedGroup = this.doRemoveGroup(group, {
-                            skipDispose: true,
-                            skipActive: true,
-                        });
-                        removedGroup.model.renderContainer =
-                            this.overlayRenderContainer;
-                        removedGroup.model.location = { type: 'grid' };
-                        returnedGroup = removedGroup;
-                    }
+                else if (this.getPanel(group.id)) {
+                    const removedGroup = this.doRemoveGroup(group, {
+                        skipDispose: true,
+                        skipActive: true,
+                    });
+                    removedGroup.model.renderContainer =
+                        this.overlayRenderContainer;
+                    removedGroup.model.location = { type: 'grid' };
+                    returnedGroup = removedGroup;
                 }
             }));
             this._popoutGroups.push(value);
             this.updateWatermark();
         })
             .catch((err) => {
-            console.error(err);
+            console.error('dockview: failed to create popout window', err);
         });
     }
     addFloatingGroup(item, coord, options) {
@@ -504,7 +442,7 @@ export class DockviewComponent extends BaseGrid {
                     this.doRemoveGroup(item, {
                         skipDispose: true,
                         skipPopoutReturn: true,
-                        skipPopoutAssociated: !!popoutReferenceGroup,
+                        skipPopoutAssociated: false,
                     });
                 }
             }
@@ -866,7 +804,6 @@ export class DockviewComponent extends BaseGrid {
     clear() {
         const groups = Array.from(this._groups.values()).map((_) => _.value);
         const hasActiveGroup = !!this.activeGroup;
-        const hasActivePanel = !!this.activePanel;
         for (const group of groups) {
             // remove the group will automatically remove the panels
             this.removeGroup(group, { skipActive: true });
@@ -1372,7 +1309,7 @@ export class DockviewComponent extends BaseGrid {
         }
         let id = options === null || options === void 0 ? void 0 : options.id;
         if (id && this._groups.has(options.id)) {
-            console.warn(`Duplicate group id ${options === null || options === void 0 ? void 0 : options.id}. reassigning group id to avoid errors`);
+            console.warn(`dockview: Duplicate group id ${options === null || options === void 0 ? void 0 : options.id}. reassigning group id to avoid errors`);
             id = undefined;
         }
         if (!id) {

package/dist/esm/dockview/dockviewPanel.js

@@ -65,12 +65,6 @@ export class DockviewPanel extends CompositeDisposable {
         const didTitleChange = title !== this.title;
         if (didTitleChange) {
             this._title = title;
-            this.view.update({
-                params: {
-                    params: this._params,
-                    title: this.title,
-                },
-            });
             this.api._onDidTitleChange.fire({ title });
         }
     }
@@ -98,10 +92,7 @@ export class DockviewPanel extends CompositeDisposable {
         }
         // update the view with the updated props
         this.view.update({
-            params: {
-                params: this._params,
-                title: this.title,
-            },
+            params: this._params,
         });
     }
     updateParentGroup(group, options) {

package/dist/esm/dockview/options.d.ts

@@ -109,7 +109,7 @@ type AddPanelFloatingGroupUnion = {
     position: never;
 };
 type AddPanelPositionUnion = {
-    floating: false | never;
+    floating: false;
     position: AddPanelPositionOptions;
 };
 type AddPanelOptionsUnion = AddPanelFloatingGroupUnion | AddPanelPositionUnion;

package/dist/esm/dockview/types.d.ts

@@ -1,4 +1,3 @@
-import { IDockviewComponent } from './dockviewComponent';
 import { DockviewPanelApi } from '../api/dockviewPanelApi';
 import { PanelInitParameters, IPanel } from '../panel/types';
 import { DockviewApi } from '../api/component.api';
@@ -16,25 +15,20 @@ export interface WatermarkRendererInitParameters {
     containerApi: DockviewApi;
     group?: IDockviewGroupPanel;
 }
-export interface IWatermarkRenderer extends Optional<Omit<IPanel, 'id' | 'init'>, 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus'> {
+type RendererMethodOptionalList = 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus';
+export interface IWatermarkRenderer extends Optional<Omit<IPanel, 'id' | 'init'>, RendererMethodOptionalList> {
     readonly element: HTMLElement;
     init: (params: WatermarkRendererInitParameters) => void;
     updateParentGroup(group: DockviewGroupPanel, visible: boolean): void;
 }
-export interface ITabRenderer extends Optional<Omit<IPanel, 'id'>, 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus'> {
+export interface ITabRenderer extends Optional<Omit<IPanel, 'id'>, RendererMethodOptionalList> {
     readonly element: HTMLElement;
     init(parameters: GroupPanelPartInitParameters): void;
 }
-export interface IContentRenderer extends Optional<Omit<IPanel, 'id'>, 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus'> {
+export interface IContentRenderer extends Optional<Omit<IPanel, 'id'>, RendererMethodOptionalList> {
     readonly element: HTMLElement;
     init(parameters: GroupPanelPartInitParameters): void;
 }
-export interface WatermarkPartInitParameters {
-    accessor: IDockviewComponent;
-}
-export interface WatermarkConstructor {
-    new (): IWatermarkRenderer;
-}
 export interface IGroupPanelInitParameters extends PanelInitParameters, HeaderPartInitParameters {
 }
 export interface GroupviewPanelState {
@@ -47,3 +41,4 @@ export interface GroupviewPanelState {
         [key: string]: any;
     };
 }
+export {};

package/dist/esm/dockview/validate.js

@@ -0,0 +1,76 @@
+"use strict";
+// import { SerializedGridObject } from '../gridview/gridview';
+// import { Orientation } from '../splitview/splitview';
+// import { SerializedDockview } from './dockviewComponent';
+// import { GroupPanelViewState } from './dockviewGroupPanelModel';
+// function typeValidate3(data: GroupPanelViewState, path: string): void {
+//     if (typeof data.id !== 'string') {
+//         throw new Error(`${path}.id must be a string`);
+//     }
+//     if (
+//         typeof data.activeView !== 'string' ||
+//         typeof data.activeView !== 'undefined'
+//     ) {
+//         throw new Error(`${path}.activeView must be a string of undefined`);
+//     }
+// }
+// function typeValidate2(
+//     data: SerializedGridObject<GroupPanelViewState>,
+//     path: string
+// ): void {
+//     if (typeof data.size !== 'number' && typeof data.size !== 'undefined') {
+//         throw new Error(`${path}.size must be a number or undefined`);
+//     }
+//     if (
+//         typeof data.visible !== 'boolean' &&
+//         typeof data.visible !== 'undefined'
+//     ) {
+//         throw new Error(`${path}.visible must be a boolean or undefined`);
+//     }
+//     if (data.type === 'leaf') {
+//         if (
+//             typeof data.data !== 'object' ||
+//             data.data === null ||
+//             Array.isArray(data.data)
+//         ) {
+//             throw new Error('object must be a non-null object');
+//         }
+//         typeValidate3(data.data, `${path}.data`);
+//     } else if (data.type === 'branch') {
+//         if (!Array.isArray(data.data)) {
+//             throw new Error(`${path}.data must be an array`);
+//         }
+//     } else {
+//         throw new Error(`${path}.type must be onew of {'branch', 'leaf'}`);
+//     }
+// }
+// function typeValidate(data: SerializedDockview): void {
+//     if (typeof data !== 'object' || data === null) {
+//         throw new Error('object must be a non-null object');
+//     }
+//     const { grid, panels, activeGroup, floatingGroups } = data;
+//     if (typeof grid !== 'object' || grid === null) {
+//         throw new Error("'.grid' must be a non-null object");
+//     }
+//     if (typeof grid.height !== 'number') {
+//         throw new Error("'.grid.height' must be a number");
+//     }
+//     if (typeof grid.width !== 'number') {
+//         throw new Error("'.grid.width' must be a number");
+//     }
+//     if (typeof grid.root !== 'object' || grid.root === null) {
+//         throw new Error("'.grid.root' must be a non-null object");
+//     }
+//     if (grid.root.type !== 'branch') {
+//         throw new Error(".grid.root.type must be of type 'branch'");
+//     }
+//     if (
+//         grid.orientation !== Orientation.HORIZONTAL &&
+//         grid.orientation !== Orientation.VERTICAL
+//     ) {
+//         throw new Error(
+//             `'.grid.width' must be one of {${Orientation.HORIZONTAL}, ${Orientation.VERTICAL}}`
+//         );
+//     }
+//     typeValidate2(grid.root, '.grid.root');
+// }

package/dist/esm/events.js

@@ -50,7 +50,7 @@ class Stacktrace {
         this.value = value;
     }
     print() {
-        console.warn(this.value);
+        console.warn('dockview: stacktrace', this.value);
     }
 }
 class Listener {
@@ -92,7 +92,7 @@ export class Emitter {
                         }
                         else if (Emitter.ENABLE_TRACKING) {
                             // console.warn(
-                            //     `Listener already disposed`,
+                            //     `dockview: listener already disposed`,
                             //     Stacktrace.create().print()
                             // );
                         }
@@ -120,7 +120,7 @@ export class Emitter {
                         var _a;
                         // don't check until stack of execution is completed to allow for out-of-order disposals within the same execution block
                         for (const listener of this._listeners) {
-                            console.warn((_a = listener.stacktrace) === null || _a === void 0 ? void 0 : _a.print());
+                            console.warn('dockview: stacktrace', (_a = listener.stacktrace) === null || _a === void 0 ? void 0 : _a.print());
                         }
                     });
                 }

package/dist/esm/index.d.ts

@@ -1,10 +1,11 @@
 export * from './dnd/dataTransfer';
 /**
- * Events, Emitters and Disposables are very common concepts that most codebases will contain.
- * We export them with a 'Dockview' prefix here to prevent accidental use by others.
+ * Events, Emitters and Disposables are very common concepts that many codebases will contain, however we need
+ * to export them for dockview framework packages to use.
+ * To be a good citizen these are exported with a `Dockview` prefix to prevent accidental use by others.
  */
 export { Emitter as DockviewEmitter, Event as DockviewEvent } from './events';
-export { IDisposable as IDockviewDisposable, MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, } from './lifecycle';
+export { IDisposable as IDockviewDisposable, MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, Disposable as DockviewDisposable, } from './lifecycle';
 export * from './panel/types';
 export * from './panel/componentFactory';
 export * from './splitview/splitview';

package/dist/esm/index.js

@@ -1,10 +1,11 @@
 export * from './dnd/dataTransfer';
 /**
- * Events, Emitters and Disposables are very common concepts that most codebases will contain.
- * We export them with a 'Dockview' prefix here to prevent accidental use by others.
+ * Events, Emitters and Disposables are very common concepts that many codebases will contain, however we need
+ * to export them for dockview framework packages to use.
+ * To be a good citizen these are exported with a `Dockview` prefix to prevent accidental use by others.
  */
 export { Emitter as DockviewEmitter, Event as DockviewEvent } from './events';
-export { MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, } from './lifecycle';
+export { MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, Disposable as DockviewDisposable, } from './lifecycle';
 export * from './panel/types';
 export * from './panel/componentFactory';
 export * from './splitview/splitview';

package/dist/styles/dockview.css

@@ -438,16 +438,16 @@
 .dv-dockview .dv-overlay-render-container {
   position: relative;
 }
-.dv-dockview .split-view-container.horizontal > .view-container > .view:not(:last-child) {
+.dv-dockview .split-view-container.horizontal > .view-container > .view:not(:last-child) .groupview {
   border-right: var(--dv-group-gap-size) solid transparent;
 }
-.dv-dockview .split-view-container.horizontal > .view-container > .view:not(:first-child) {
+.dv-dockview .split-view-container.horizontal > .view-container > .view:not(:first-child) .groupview {
   border-left: var(--dv-group-gap-size) solid transparent;
 }
-.dv-dockview .split-view-container.vertical > .view-container > .view:not(:last-child) {
+.dv-dockview .split-view-container.vertical > .view-container > .view:not(:last-child) .groupview {
   border-bottom: var(--dv-group-gap-size) solid transparent;
 }
-.dv-dockview .split-view-container.vertical > .view-container > .view:not(:first-child) {
+.dv-dockview .split-view-container.vertical > .view-container > .view:not(:first-child) .groupview {
   border-top: var(--dv-group-gap-size) solid transparent;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dockview-core",
-  "version": "1.13.1",
+  "version": "1.14.1",
   "description": "Zero dependency layout manager supporting tabs, grids and splitviews",
   "keywords": [
     "splitview",