dockview 1.5.1 → 1.6.0

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

@@ -1,88 +1,110 @@
-import { DockviewApi } from '../api/component.api';
-import { Direction } from '../gridview/baseComponentGridview';
-import { IGridView } from '../gridview/gridview';
-import { IDockviewPanel } from '../groupview/groupPanel';
-import { IContentRenderer, ITabRenderer, WatermarkConstructor, IWatermarkRenderer } from '../groupview/types';
-import { GroupPanel } from '../groupview/groupviewPanel';
-import { ISplitviewStyles, Orientation } from '../splitview/core/splitview';
-import { FrameworkFactory } from '../types';
-import { DockviewDropTargets } from '../groupview/dnd';
-import { PanelTransfer } from '../dnd/dataTransfer';
-import { IGroupControlRenderer } from '../react/dockview/groupControlsRenderer';
-export interface GroupPanelFrameworkComponentFactory {
-    content: FrameworkFactory<IContentRenderer>;
-    tab: FrameworkFactory<ITabRenderer>;
-    watermark: FrameworkFactory<IWatermarkRenderer>;
-}
-export interface TabContextMenuEvent {
-    event: MouseEvent;
-    api: DockviewApi;
-    panel: IDockviewPanel;
-}
-export interface DockviewRenderFunctions {
-    tabComponents?: {
-        [componentName: string]: {
-            new (id: string, component: string): ITabRenderer;
-        };
-    };
-    components?: {
-        [componentName: string]: {
-            new (id: string, component: string): IContentRenderer;
-        };
-    };
-    frameworkTabComponents?: {
-        [componentName: string]: any;
-    };
-    frameworkComponents?: {
-        [componentName: string]: any;
-    };
-}
-export interface ViewFactoryData {
-    content: string;
-    tab?: string;
-}
-export interface DockviewDndOverlayEvent {
-    nativeEvent: DragEvent;
-    target: DockviewDropTargets;
-    group: GroupPanel;
-    getData: () => PanelTransfer | undefined;
-}
-export interface DockviewComponentOptions extends DockviewRenderFunctions {
-    watermarkComponent?: WatermarkConstructor;
-    watermarkFrameworkComponent?: any;
-    frameworkComponentFactory?: GroupPanelFrameworkComponentFactory;
-    tabHeight?: number;
-    orientation?: Orientation;
-    styles?: ISplitviewStyles;
-    defaultTabComponent?: string;
-    showDndOverlay?: (event: DockviewDndOverlayEvent) => boolean;
-    createGroupControlElement?: (group: GroupPanel) => IGroupControlRenderer;
-}
-export interface PanelOptions {
-    component: string;
-    tabComponent?: string;
-    params?: {
-        [key: string]: any;
-    };
-    id: string;
-    title?: string;
-}
-export interface AddPanelOptions extends Omit<PanelOptions, 'component' | 'tabComponent'> {
-    component: string;
-    tabComponent?: string;
-    position?: {
-        direction?: Direction;
-        referencePanel?: string;
-    };
-}
-export interface AddGroupOptions {
-    direction?: 'left' | 'right' | 'above' | 'below';
-    referencePanel: string;
-}
-export interface MovementOptions2 {
-    group?: IGridView;
-}
-export interface MovementOptions extends MovementOptions2 {
-    includePanel?: boolean;
-    group?: GroupPanel;
-}
+import { DockviewApi } from '../api/component.api';
+import { Direction } from '../gridview/baseComponentGridview';
+import { IGridView } from '../gridview/gridview';
+import { IContentRenderer, ITabRenderer, WatermarkConstructor, IWatermarkRenderer } from '../groupview/types';
+import { GroupPanel } from '../groupview/groupviewPanel';
+import { ISplitviewStyles, Orientation } from '../splitview/core/splitview';
+import { FrameworkFactory } from '../types';
+import { DockviewDropTargets } from '../groupview/dnd';
+import { PanelTransfer } from '../dnd/dataTransfer';
+import { IGroupControlRenderer } from '../react/dockview/groupControlsRenderer';
+import { Position } from '../dnd/droptarget';
+import { IDockviewPanel } from './dockviewPanel';
+export interface GroupPanelFrameworkComponentFactory {
+    content: FrameworkFactory<IContentRenderer>;
+    tab: FrameworkFactory<ITabRenderer>;
+    watermark: FrameworkFactory<IWatermarkRenderer>;
+}
+export interface TabContextMenuEvent {
+    event: MouseEvent;
+    api: DockviewApi;
+    panel: IDockviewPanel;
+}
+export interface DockviewRenderFunctions {
+    tabComponents?: {
+        [componentName: string]: {
+            new (id: string, component: string): ITabRenderer;
+        };
+    };
+    components?: {
+        [componentName: string]: {
+            new (id: string, component: string): IContentRenderer;
+        };
+    };
+    frameworkTabComponents?: {
+        [componentName: string]: any;
+    };
+    frameworkComponents?: {
+        [componentName: string]: any;
+    };
+}
+export interface ViewFactoryData {
+    content: string;
+    tab?: string;
+}
+export interface DockviewDndOverlayEvent {
+    nativeEvent: DragEvent;
+    target: DockviewDropTargets;
+    position: Position;
+    group?: GroupPanel;
+    getData: () => PanelTransfer | undefined;
+}
+export interface DockviewComponentOptions extends DockviewRenderFunctions {
+    watermarkComponent?: WatermarkConstructor;
+    watermarkFrameworkComponent?: any;
+    frameworkComponentFactory?: GroupPanelFrameworkComponentFactory;
+    tabHeight?: number;
+    orientation?: Orientation;
+    styles?: ISplitviewStyles;
+    defaultTabComponent?: string;
+    showDndOverlay?: (event: DockviewDndOverlayEvent) => boolean;
+    createGroupControlElement?: (group: GroupPanel) => IGroupControlRenderer;
+    singleTabMode?: 'fullwidth' | 'default';
+}
+export interface PanelOptions {
+    component: string;
+    tabComponent?: string;
+    params?: {
+        [key: string]: any;
+    };
+    id: string;
+    title?: string;
+}
+type RelativePanel = {
+    direction?: Direction;
+    referencePanel: string | IDockviewPanel;
+};
+type RelativeGroup = {
+    direction?: Direction;
+    referenceGroup: string | GroupPanel;
+};
+type AbsolutePosition = {
+    direction: Omit<Direction, 'within'>;
+};
+export type AddPanelPositionOptions = RelativePanel | RelativeGroup | AbsolutePosition;
+export declare function isPanelOptionsWithPanel(data: AddPanelPositionOptions): data is RelativePanel;
+export declare function isPanelOptionsWithGroup(data: AddPanelPositionOptions): data is RelativeGroup;
+export interface AddPanelOptions extends Omit<PanelOptions, 'component' | 'tabComponent'> {
+    component: string;
+    tabComponent?: string;
+    position?: AddPanelPositionOptions;
+}
+type AddGroupOptionsWithPanel = {
+    referencePanel: string | IDockviewPanel;
+    direction?: Omit<Direction, 'within'>;
+};
+type AddGroupOptionsWithGroup = {
+    referenceGroup: string | GroupPanel;
+    direction?: Omit<Direction, 'within'>;
+};
+export type AddGroupOptions = AddGroupOptionsWithGroup | AddGroupOptionsWithPanel | AbsolutePosition;
+export declare function isGroupOptionsWithPanel(data: AddGroupOptions): data is AddGroupOptionsWithPanel;
+export declare function isGroupOptionsWithGroup(data: AddGroupOptions): data is AddGroupOptionsWithGroup;
+export interface MovementOptions2 {
+    group?: IGridView;
+}
+export interface MovementOptions extends MovementOptions2 {
+    includePanel?: boolean;
+    group?: GroupPanel;
+}
+export {};

package/dist/cjs/dockview/options.js

@@ -1,3 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGroupOptionsWithGroup = exports.isGroupOptionsWithPanel = exports.isPanelOptionsWithGroup = exports.isPanelOptionsWithPanel = void 0;
+function isPanelOptionsWithPanel(data) {
+    if (data.referencePanel) {
+        return true;
+    }
+    return false;
+}
+exports.isPanelOptionsWithPanel = isPanelOptionsWithPanel;
+function isPanelOptionsWithGroup(data) {
+    if (data.referenceGroup) {
+        return true;
+    }
+    return false;
+}
+exports.isPanelOptionsWithGroup = isPanelOptionsWithGroup;
+function isGroupOptionsWithPanel(data) {
+    if (data.referencePanel) {
+        return true;
+    }
+    return false;
+}
+exports.isGroupOptionsWithPanel = isGroupOptionsWithPanel;
+function isGroupOptionsWithGroup(data) {
+    if (data.referenceGroup) {
+        return true;
+    }
+    return false;
+}
+exports.isGroupOptionsWithGroup = isGroupOptionsWithGroup;
 //# sourceMappingURL=options.js.map

package/dist/cjs/dockview/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/dockview/options.ts"],"names":[],"mappings":""}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/dockview/options.ts"],"names":[],"mappings":";;;AAsGA,SAAgB,uBAAuB,CACnC,IAA6B;IAE7B,IAAK,IAAsB,CAAC,cAAc,EAAE;QACxC,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAPD,0DAOC;AAED,SAAgB,uBAAuB,CACnC,IAA6B;IAE7B,IAAK,IAAsB,CAAC,cAAc,EAAE;QACxC,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAPD,0DAOC;AAwBD,SAAgB,uBAAuB,CACnC,IAAqB;IAErB,IAAK,IAAiC,CAAC,cAAc,EAAE;QACnD,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAPD,0DAOC;AAED,SAAgB,uBAAuB,CACnC,IAAqB;IAErB,IAAK,IAAiC,CAAC,cAAc,EAAE;QACnD,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAPD,0DAOC"}

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

@@ -0,0 +1,2 @@
+import { SerializedDockview } from './dockviewComponent';
+export declare function validateSerializedDockview(data: SerializedDockview): void;

package/dist/cjs/dockview/validation.js

@@ -0,0 +1,135 @@
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSerializedDockview = void 0;
+var splitview_1 = require("../splitview/core/splitview");
+function validateGroupViewPanelState(value) {
+    if (typeof value.id !== 'string') {
+        throw new Error('invalid layout');
+    }
+    if (typeof value.title !== 'string') {
+        throw new Error('invalid layout');
+    }
+    if (value.params !== undefined && typeof value.params !== 'object') {
+        throw new Error('invalid layout');
+    }
+}
+function validateGroupPanelViewState(value) {
+    var e_1, _a;
+    if (typeof value.id !== 'string') {
+        throw new Error('invalid layout');
+    }
+    if (value.locked !== undefined && typeof value.locked !== 'boolean') {
+        throw new Error('invalid layout');
+    }
+    if (value.hideHeader !== undefined && typeof value.locked !== 'boolean') {
+        throw new Error('invalid layout');
+    }
+    if (value.activeView !== undefined &&
+        typeof value.activeView !== 'string') {
+        throw new Error('invalid layout');
+    }
+    if (!Array.isArray(value.views)) {
+        throw new Error('invalid layout');
+    }
+    try {
+        for (var _b = __values(value.views), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var child = _c.value;
+            if (typeof child !== 'string') {
+                if (!Array.isArray(value.views)) {
+                    throw new Error('invalid layout');
+                }
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+}
+function validateSerializedGridObject(value) {
+    var e_2, _a;
+    if (value.size !== undefined && typeof value.size !== 'number') {
+        throw new Error('invalid layout');
+    }
+    if (value.visible !== undefined && typeof value.size !== 'boolean') {
+        throw new Error('invalid layout');
+    }
+    if (value.type !== 'branch' && value.type !== 'leaf') {
+        throw new Error('invalid layout');
+    }
+    if (Array.isArray(value.data)) {
+        try {
+            for (var _b = __values(value.data), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var child = _c.value;
+                validateSerializedGridObject(child);
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+    }
+    else {
+        validateGroupPanelViewState(value.data);
+    }
+}
+function validateSerializedDockview(data) {
+    var e_3, _a;
+    if (typeof data !== 'object') {
+        throw new Error('invalid layout');
+    }
+    var grid = data.grid, panels = data.panels, options = data.options, activeGroup = data.activeGroup;
+    if (typeof grid !== 'object') {
+        throw new Error('invalid layout');
+    }
+    if (typeof grid.height !== 'number') {
+        throw new Error('invalid layout');
+    }
+    if (typeof grid.width !== 'number') {
+        throw new Error('invalid layout');
+    }
+    if (grid.orientation !== splitview_1.Orientation.HORIZONTAL &&
+        grid.orientation !== splitview_1.Orientation.VERTICAL) {
+        throw new Error('invalid layout');
+    }
+    validateSerializedGridObject(grid.root);
+    if (data.activeGroup !== undefined &&
+        typeof data.activeGroup !== 'string') {
+        throw new Error('invalid layout');
+    }
+    if (typeof data.panels !== 'object') {
+        throw new Error('invalid layout');
+    }
+    try {
+        for (var _b = __values(Object.values(data.panels)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var value = _c.value;
+            validateGroupViewPanelState(value);
+        }
+    }
+    catch (e_3_1) { e_3 = { error: e_3_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_3) throw e_3.error; }
+    }
+}
+exports.validateSerializedDockview = validateSerializedDockview;
+//# sourceMappingURL=validation.js.map

package/dist/cjs/dockview/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../src/dockview/validation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAGA,yDAA0D;AAG1D,SAAS,2BAA2B,CAAC,KAA0B;IAC3D,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE;QAChE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;AACL,CAAC;AAED,SAAS,2BAA2B,CAAC,KAA0B;;IAC3D,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE;QACjE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE;QACrE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IACD,IACI,KAAK,CAAC,UAAU,KAAK,SAAS;QAC9B,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,EACtC;QACE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;;QAED,KAAoB,IAAA,KAAA,SAAA,KAAK,CAAC,KAAK,CAAA,gBAAA,4BAAE;YAA5B,IAAM,KAAK,WAAA;YACZ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;oBAC7B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;iBACrC;aACJ;SACJ;;;;;;;;;AACL,CAAC;AAED,SAAS,4BAA4B,CACjC,KAAgD;;IAEhD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;QAC5D,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;QAChE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE;QAClD,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;;YAC3B,KAAoB,IAAA,KAAA,SAAA,KAAK,CAAC,IAAI,CAAA,gBAAA,4BAAE;gBAA3B,IAAM,KAAK,WAAA;gBACZ,4BAA4B,CAAC,KAAK,CAAC,CAAC;aACvC;;;;;;;;;KACJ;SAAM;QACH,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;KAC3C;AACL,CAAC;AAED,SAAgB,0BAA0B,CAAC,IAAwB;;IAC/D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAEO,IAAA,IAAI,GAAmC,IAAI,KAAvC,EAAE,MAAM,GAA2B,IAAI,OAA/B,EAAE,OAAO,GAAkB,IAAI,QAAtB,EAAE,WAAW,GAAK,IAAI,YAAT,CAAU;IAEpD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IACI,IAAI,CAAC,WAAW,KAAK,uBAAW,CAAC,UAAU;QAC3C,IAAI,CAAC,WAAW,KAAK,uBAAW,CAAC,QAAQ,EAC3C;QACE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAExC,IACI,IAAI,CAAC,WAAW,KAAK,SAAS;QAC9B,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,EACtC;QACE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;IAED,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACrC;;QAED,KAAoB,IAAA,KAAA,SAAA,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA,gBAAA,4BAAE;YAA3C,IAAM,KAAK,WAAA;YACZ,2BAA2B,CAAC,KAAK,CAAC,CAAC;SACtC;;;;;;;;;AACL,CAAC;AA1CD,gEA0CC"}

package/dist/cjs/dom.d.ts

@@ -1,14 +1,14 @@
-import { Event } from './events';
-import { IDisposable } from './lifecycle';
-export declare function watchElementResize(element: HTMLElement, cb: (entry: ResizeObserverEntry) => void): IDisposable;
-export declare const removeClasses: (element: HTMLElement, ...classes: string[]) => void;
-export declare const addClasses: (element: HTMLElement, ...classes: string[]) => void;
-export declare const toggleClass: (element: HTMLElement, className: string, isToggled: boolean) => void;
-export declare function isAncestor(testChild: Node | null, testAncestor: Node | null): boolean;
-export declare function getElementsByTagName(tag: string): HTMLElement[];
-export interface IFocusTracker extends IDisposable {
-    onDidFocus: Event<void>;
-    onDidBlur: Event<void>;
-    refreshState?(): void;
-}
-export declare function trackFocus(element: HTMLElement | Window): IFocusTracker;
+import { Event } from './events';
+import { IDisposable } from './lifecycle';
+export declare function watchElementResize(element: HTMLElement, cb: (entry: ResizeObserverEntry) => void): IDisposable;
+export declare const removeClasses: (element: HTMLElement, ...classes: string[]) => void;
+export declare const addClasses: (element: HTMLElement, ...classes: string[]) => void;
+export declare const toggleClass: (element: HTMLElement, className: string, isToggled: boolean) => void;
+export declare function isAncestor(testChild: Node | null, testAncestor: Node | null): boolean;
+export declare function getElementsByTagName(tag: string): HTMLElement[];
+export interface IFocusTracker extends IDisposable {
+    onDidFocus: Event<void>;
+    onDidBlur: Event<void>;
+    refreshState?(): void;
+}
+export declare function trackFocus(element: HTMLElement | Window): IFocusTracker;