dockview 1.5.2 → 1.7.0

package/dist/esm/gridview/gridview.js

@@ -1,397 +1,67 @@
-/*---------------------------------------------------------------------------------------------
- * Accreditation: This file is largly based upon the MIT licenced VSCode sourcecode found at:
- * https://github.com/microsoft/vscode/tree/main/src/vs/base/browser/ui/grid
- *--------------------------------------------------------------------------------------------*/
-import { Orientation, Sizing, } from '../splitview/core/splitview';
-import { Position } from '../dnd/droptarget';
-import { tail } from '../array';
-import { LeafNode } from './leafNode';
-import { BranchNode } from './branchNode';
-import { Emitter } from '../events';
-import { MutableDisposable } from '../lifecycle';
-function findLeaf(candiateNode, last) {
-    if (candiateNode instanceof LeafNode) {
-        return candiateNode;
-    }
-    if (candiateNode instanceof BranchNode) {
-        return findLeaf(candiateNode.children[last ? candiateNode.children.length - 1 : 0], last);
-    }
-    throw new Error('invalid node');
-}
-function flipNode(node, size, orthogonalSize) {
-    if (node instanceof BranchNode) {
-        const result = new BranchNode(orthogonal(node.orientation), node.proportionalLayout, node.styles, size, orthogonalSize);
-        let totalSize = 0;
-        for (let i = node.children.length - 1; i >= 0; i--) {
-            const child = node.children[i];
-            const childSize = child instanceof BranchNode ? child.orthogonalSize : child.size;
-            let newSize = node.size === 0
-                ? 0
-                : Math.round((size * childSize) / node.size);
-            totalSize += newSize;
-            // The last view to add should adjust to rounding errors
-            if (i === 0) {
-                newSize += size - totalSize;
-            }
-            result.addChild(flipNode(child, orthogonalSize, newSize), newSize, 0, true);
-        }
-        return result;
-    }
-    else {
-        return new LeafNode(node.view, orthogonal(node.orientation), orthogonalSize);
-    }
-}
-export function indexInParent(element) {
-    const parentElement = element.parentElement;
-    if (!parentElement) {
-        throw new Error('Invalid grid element');
-    }
-    let el = parentElement.firstElementChild;
-    let index = 0;
-    while (el !== element && el !== parentElement.lastElementChild && el) {
-        el = el.nextElementSibling;
-        index++;
-    }
-    return index;
-}
-/**
- * Find the grid location of a specific DOM element by traversing the parent
- * chain and finding each child index on the way.
- *
- * This will break as soon as DOM structures of the Splitview or Gridview change.
- */
-export function getGridLocation(element) {
-    const parentElement = element.parentElement;
-    if (!parentElement) {
-        throw new Error('Invalid grid element');
-    }
-    if (/\bgrid-view\b/.test(parentElement.className)) {
-        return [];
-    }
-    const index = indexInParent(parentElement);
-    const ancestor = parentElement.parentElement.parentElement.parentElement;
-    return [...getGridLocation(ancestor), index];
-}
-export function getRelativeLocation(rootOrientation, location, direction) {
-    const orientation = getLocationOrientation(rootOrientation, location);
-    const directionOrientation = getDirectionOrientation(direction);
-    if (orientation === directionOrientation) {
-        const [rest, _index] = tail(location);
-        let index = _index;
-        if (direction === Position.Right || direction === Position.Bottom) {
-            index += 1;
-        }
-        return [...rest, index];
-    }
-    else {
-        const index = direction === Position.Right || direction === Position.Bottom
-            ? 1
-            : 0;
-        return [...location, index];
-    }
-}
-export function getDirectionOrientation(direction) {
-    return direction === Position.Top || direction === Position.Bottom
-        ? Orientation.VERTICAL
-        : Orientation.HORIZONTAL;
-}
-export function getLocationOrientation(rootOrientation, location) {
-    return location.length % 2 === 0
-        ? orthogonal(rootOrientation)
-        : rootOrientation;
-}
-export const orthogonal = (orientation) => orientation === Orientation.HORIZONTAL
-    ? Orientation.VERTICAL
-    : Orientation.HORIZONTAL;
-export function isGridBranchNode(node) {
-    return !!node.children;
-}
-const serializeBranchNode = (node, orientation) => {
-    const size = orientation === Orientation.VERTICAL ? node.box.width : node.box.height;
-    if (!isGridBranchNode(node)) {
-        if (typeof node.cachedVisibleSize === 'number') {
-            return {
-                type: 'leaf',
-                data: node.view.toJSON(),
-                size: node.cachedVisibleSize,
-                visible: false,
+import * as React from 'react';
+import { GridviewComponent, Orientation, GridviewApi, watchElementResize, } from 'dockview-core';
+import { ReactGridPanelView } from './view';
+import { usePortalsLifecycle } from '../react';
+export const GridviewReact = React.forwardRef((props, ref) => {
+    const domRef = React.useRef(null);
+    const gridviewRef = React.useRef();
+    const [portals, addPortal] = usePortalsLifecycle();
+    React.useImperativeHandle(ref, () => domRef.current, []);
+    React.useEffect(() => {
+        if (props.disableAutoResizing) {
+            return () => {
+                //
             };
         }
-        return { type: 'leaf', data: node.view.toJSON(), size };
-    }
-    return {
-        type: 'branch',
-        data: node.children.map((c) => serializeBranchNode(c, orthogonal(orientation))),
-        size,
-    };
-};
-export class Gridview {
-    constructor(proportionalLayout, styles, orientation) {
-        this.proportionalLayout = proportionalLayout;
-        this.styles = styles;
-        this.disposable = new MutableDisposable();
-        this._onDidChange = new Emitter();
-        this.onDidChange = this._onDidChange.event;
-        this.element = document.createElement('div');
-        this.element.className = 'grid-view';
-        this.root = new BranchNode(orientation, proportionalLayout, styles, 0, 0);
-    }
-    serialize() {
-        const root = serializeBranchNode(this.getView(), this.orientation);
-        return {
-            root,
-            width: this.width,
-            height: this.height,
-            orientation: this.orientation,
+        const watcher = watchElementResize(domRef.current, (entry) => {
+            var _a;
+            const { width, height } = entry.contentRect;
+            (_a = gridviewRef.current) === null || _a === void 0 ? void 0 : _a.layout(width, height);
+        });
+        return () => {
+            watcher.dispose();
         };
-    }
-    dispose() {
-        this.disposable.dispose();
-        this._onDidChange.dispose();
-        this.root.dispose();
-        this.element.remove();
-    }
-    clear() {
-        const orientation = this.root.orientation;
-        this.root = new BranchNode(orientation, this.proportionalLayout, this.styles, this.root.size, this.root.orthogonalSize);
-    }
-    deserialize(json, deserializer) {
-        const orientation = json.orientation;
-        const height = orientation === Orientation.VERTICAL ? json.height : json.width;
-        this._deserialize(json.root, orientation, deserializer, height);
-    }
-    _deserialize(root, orientation, deserializer, orthogonalSize) {
-        this.root = this._deserializeNode(root, orientation, deserializer, orthogonalSize, true);
-    }
-    _deserializeNode(node, orientation, deserializer, orthogonalSize, isRoot = false) {
-        let result;
-        if (node.type === 'branch') {
-            const serializedChildren = node.data;
-            const children = serializedChildren.map((serializedChild) => {
-                return {
-                    node: this._deserializeNode(serializedChild, orthogonal(orientation), deserializer, node.size),
-                    visible: serializedChild.visible,
-                };
-            });
-            // HORIZONTAL => height=orthogonalsize width=size
-            // VERTICAL => height=size width=orthogonalsize
-            result = new BranchNode(orientation, this.proportionalLayout, this.styles, isRoot ? orthogonalSize : node.size, isRoot ? node.size : orthogonalSize, children);
-        }
-        else {
-            result = new LeafNode(deserializer.fromJSON(node), orientation, orthogonalSize, node.size);
-        }
-        return result;
-    }
-    get orientation() {
-        return this.root.orientation;
-    }
-    set orientation(orientation) {
-        if (this.root.orientation === orientation) {
+    }, [props.disableAutoResizing]);
+    React.useEffect(() => {
+        var _a;
+        const element = document.createElement('div');
+        const gridview = new GridviewComponent(element, {
+            proportionalLayout: typeof props.proportionalLayout === 'boolean'
+                ? props.proportionalLayout
+                : true,
+            orientation: props.orientation || Orientation.HORIZONTAL,
+            frameworkComponents: props.components,
+            frameworkComponentFactory: {
+                createComponent: (id, componentId, component) => {
+                    return new ReactGridPanelView(id, componentId, component, {
+                        addPortal,
+                    });
+                },
+            },
+            styles: props.hideBorders
+                ? { separatorBorder: 'transparent' }
+                : undefined,
+        });
+        (_a = domRef.current) === null || _a === void 0 ? void 0 : _a.appendChild(gridview.element);
+        const { clientWidth, clientHeight } = domRef.current;
+        gridview.layout(clientWidth, clientHeight);
+        if (props.onReady) {
+            props.onReady({ api: new GridviewApi(gridview) });
+        }
+        gridviewRef.current = gridview;
+        return () => {
+            gridview.dispose();
+            element.remove();
+        };
+    }, []);
+    React.useEffect(() => {
+        if (!gridviewRef.current) {
             return;
         }
-        const { size, orthogonalSize } = this.root;
-        this.root = flipNode(this.root, orthogonalSize, size);
-        this.root.layout(size, orthogonalSize);
-    }
-    get root() {
-        return this._root;
-    }
-    set root(root) {
-        const oldRoot = this._root;
-        if (oldRoot) {
-            oldRoot.dispose();
-            this.element.removeChild(oldRoot.element);
-        }
-        this._root = root;
-        this.element.appendChild(this._root.element);
-        this.disposable.value = this._root.onDidChange((e) => {
-            this._onDidChange.fire(e);
+        gridviewRef.current.updateOptions({
+            frameworkComponents: props.components,
         });
-    }
-    next(location) {
-        return this.progmaticSelect(location);
-    }
-    previous(location) {
-        return this.progmaticSelect(location, true);
-    }
-    getView(location) {
-        const node = location ? this.getNode(location)[1] : this.root;
-        return this._getViews(node, this.orientation);
-    }
-    _getViews(node, orientation, cachedVisibleSize) {
-        const box = { height: node.height, width: node.width };
-        if (node instanceof LeafNode) {
-            return { box, view: node.view, cachedVisibleSize };
-        }
-        const children = [];
-        for (let i = 0; i < node.children.length; i++) {
-            const child = node.children[i];
-            const nodeCachedVisibleSize = node.getChildCachedVisibleSize(i);
-            children.push(this._getViews(child, orthogonal(orientation), nodeCachedVisibleSize));
-        }
-        return { box, children };
-    }
-    progmaticSelect(location, reverse = false) {
-        const [path, node] = this.getNode(location);
-        if (!(node instanceof LeafNode)) {
-            throw new Error('invalid location');
-        }
-        for (let i = path.length - 1; i > -1; i--) {
-            const n = path[i];
-            const l = location[i] || 0;
-            const canProgressInCurrentLevel = reverse
-                ? l - 1 > -1
-                : l + 1 < n.children.length;
-            if (canProgressInCurrentLevel) {
-                return findLeaf(n.children[reverse ? l - 1 : l + 1], reverse);
-            }
-        }
-        return findLeaf(this.root, reverse);
-    }
-    get width() {
-        return this.root.width;
-    }
-    get height() {
-        return this.root.height;
-    }
-    get minimumWidth() {
-        return this.root.minimumWidth;
-    }
-    get minimumHeight() {
-        return this.root.minimumHeight;
-    }
-    get maximumWidth() {
-        return this.root.maximumHeight;
-    }
-    get maximumHeight() {
-        return this.root.maximumHeight;
-    }
-    isViewVisible(location) {
-        const [rest, index] = tail(location);
-        const [, parent] = this.getNode(rest);
-        if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid from location');
-        }
-        return parent.isChildVisible(index);
-    }
-    setViewVisible(location, visible) {
-        const [rest, index] = tail(location);
-        const [, parent] = this.getNode(rest);
-        if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid from location');
-        }
-        parent.setChildVisible(index, visible);
-    }
-    moveView(parentLocation, from, to) {
-        const [, parent] = this.getNode(parentLocation);
-        if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid location');
-        }
-        parent.moveChild(from, to);
-    }
-    addView(view, size, location) {
-        const [rest, index] = tail(location);
-        const [pathToParent, parent] = this.getNode(rest);
-        if (parent instanceof BranchNode) {
-            const node = new LeafNode(view, orthogonal(parent.orientation), parent.orthogonalSize);
-            parent.addChild(node, size, index);
-        }
-        else {
-            const [grandParent, ..._] = [...pathToParent].reverse();
-            const [parentIndex, ...__] = [...rest].reverse();
-            let newSiblingSize = 0;
-            const newSiblingCachedVisibleSize = grandParent.getChildCachedVisibleSize(parentIndex);
-            if (typeof newSiblingCachedVisibleSize === 'number') {
-                newSiblingSize = Sizing.Invisible(newSiblingCachedVisibleSize);
-            }
-            grandParent.removeChild(parentIndex);
-            const newParent = new BranchNode(parent.orientation, this.proportionalLayout, this.styles, parent.size, parent.orthogonalSize);
-            grandParent.addChild(newParent, parent.size, parentIndex);
-            const newSibling = new LeafNode(parent.view, grandParent.orientation, parent.size);
-            newParent.addChild(newSibling, newSiblingSize, 0);
-            if (typeof size !== 'number' && size.type === 'split') {
-                size = { type: 'split', index: 0 };
-            }
-            const node = new LeafNode(view, grandParent.orientation, parent.size);
-            newParent.addChild(node, size, index);
-        }
-    }
-    remove(view, sizing) {
-        const location = getGridLocation(view.element);
-        return this.removeView(location, sizing);
-    }
-    removeView(location, sizing) {
-        const [rest, index] = tail(location);
-        const [pathToParent, parent] = this.getNode(rest);
-        if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid location');
-        }
-        const node = parent.children[index];
-        if (!(node instanceof LeafNode)) {
-            throw new Error('Invalid location');
-        }
-        parent.removeChild(index, sizing);
-        if (parent.children.length === 0) {
-            return node.view;
-        }
-        if (parent.children.length > 1) {
-            return node.view;
-        }
-        const sibling = parent.children[0];
-        if (pathToParent.length === 0) {
-            // parent is root
-            if (sibling instanceof LeafNode) {
-                return node.view;
-            }
-            // we must promote sibling to be the new root
-            parent.removeChild(0, sizing);
-            this.root = sibling;
-            return node.view;
-        }
-        const [grandParent, ..._] = [...pathToParent].reverse();
-        const [parentIndex, ...__] = [...rest].reverse();
-        const isSiblingVisible = parent.isChildVisible(0);
-        parent.removeChild(0, sizing);
-        const sizes = grandParent.children.map((_size, i) => grandParent.getChildSize(i));
-        grandParent.removeChild(parentIndex, sizing);
-        if (sibling instanceof BranchNode) {
-            sizes.splice(parentIndex, 1, ...sibling.children.map((c) => c.size));
-            for (let i = 0; i < sibling.children.length; i++) {
-                const child = sibling.children[i];
-                grandParent.addChild(child, child.size, parentIndex + i);
-            }
-        }
-        else {
-            const newSibling = new LeafNode(sibling.view, orthogonal(sibling.orientation), sibling.size);
-            const siblingSizing = isSiblingVisible
-                ? sibling.orthogonalSize
-                : Sizing.Invisible(sibling.orthogonalSize);
-            grandParent.addChild(newSibling, siblingSizing, parentIndex);
-        }
-        for (let i = 0; i < sizes.length; i++) {
-            grandParent.resizeChild(i, sizes[i]);
-        }
-        return node.view;
-    }
-    layout(width, height) {
-        const [size, orthogonalSize] = this.root.orientation === Orientation.HORIZONTAL
-            ? [height, width]
-            : [width, height];
-        this.root.layout(size, orthogonalSize);
-    }
-    getNode(location, node = this.root, path = []) {
-        if (location.length === 0) {
-            return [path, node];
-        }
-        if (!(node instanceof BranchNode)) {
-            throw new Error('Invalid location');
-        }
-        const [index, ...rest] = location;
-        if (index < 0 || index >= node.children.length) {
-            throw new Error('Invalid location');
-        }
-        const child = node.children[index];
-        path.push(node);
-        return this.getNode(rest, child, path);
-    }
-}
+    }, [props.components]);
+    return (React.createElement("div", { className: props.className, style: { height: '100%', width: '100%' }, ref: domRef }, portals));
+});
+GridviewReact.displayName = 'GridviewComponent';

package/dist/esm/{react/gridview → gridview}/view.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="react" />
-import { GridviewPanel } from '../../gridview/gridviewPanel';
-import { IFrameworkPart } from '../../panel/types';
+import { GridviewPanel, IFrameworkPart } from 'dockview-core';
 import { ReactPortalStore } from '../react';
 import { IGridviewPanelProps } from './gridview';
 export declare class ReactGridPanelView extends GridviewPanel {

package/dist/esm/{react/gridview → gridview}/view.js

@@ -1,5 +1,4 @@
-import { GridviewApi } from '../../api/component.api';
-import { GridviewPanel, } from '../../gridview/gridviewPanel';
+import { GridviewApi, GridviewPanel, } from 'dockview-core';
 import { ReactPart } from '../react';
 export class ReactGridPanelView extends GridviewPanel {
     constructor(id, component, reactComponent, reactPortalStore) {

package/dist/esm/index.d.ts

@@ -1,30 +1,10 @@
-export * from './dnd/dataTransfer';
-export * from './splitview/core/splitview';
-export * from './paneview/paneview';
+export * from 'dockview-core';
+export * from './dockview/dockview';
+export * from './dockview/defaultTab';
+export * from './splitview/splitview';
 export * from './gridview/gridview';
-export * from './groupview/groupview';
-export * from './gridview/baseComponentGridview';
-export * from './groupview/panel/content';
-export * from './groupview/tab';
-export * from './groupview/dnd';
-export * from './groupview/types';
-export * from './dockview/options';
-export * from './dockview/dockviewComponent';
-export * from './gridview/gridviewComponent';
-export * from './splitview/splitviewComponent';
-export * from './paneview/paneviewComponent';
-export { PaneviewComponentOptions } from './paneview/options';
-export * from './gridview/gridviewPanel';
-export * from './splitview/splitviewPanel';
-export * from './paneview/paneviewPanel';
-export * from './groupview/groupPanel';
+export { IDockviewGroupControlProps } from './dockview/groupControlsRenderer';
+export { IWatermarkPanelProps } from './dockview/reactWatermarkPart';
+export * from './paneview/paneview';
+export * from './types';
 export * from './react';
-export { Event } from './events';
-export { IDisposable } from './lifecycle';
-export { Position } from './dnd/droptarget';
-export { FocusEvent, PanelDimensionChangeEvent, VisibilityEvent, ActiveEvent, PanelApi, } from './api/panelApi';
-export { SizeEvent, GridviewPanelApi, GridConstraintChangeEvent, } from './api/gridviewPanelApi';
-export { TitleEvent, DockviewPanelApi } from './api/groupPanelApi';
-export { PanelSizeEvent, PanelConstraintChangeEvent, SplitviewPanelApi, } from './api/splitviewPanelApi';
-export { ExpansionEvent, PaneviewPanelApi } from './api/paneviewPanelApi';
-export { CommonApi, SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, } from './api/component.api';

package/dist/esm/index.js

@@ -1,23 +1,8 @@
-export * from './dnd/dataTransfer';
-export * from './splitview/core/splitview';
-export * from './paneview/paneview';
+export * from 'dockview-core';
+export * from './dockview/dockview';
+export * from './dockview/defaultTab';
+export * from './splitview/splitview';
 export * from './gridview/gridview';
-export * from './groupview/groupview';
-export * from './gridview/baseComponentGridview';
-export * from './groupview/panel/content';
-export * from './groupview/tab';
-export * from './groupview/dnd';
-export * from './groupview/types';
-export * from './dockview/options';
-export * from './dockview/dockviewComponent';
-export * from './gridview/gridviewComponent';
-export * from './splitview/splitviewComponent';
-export * from './paneview/paneviewComponent';
-export * from './gridview/gridviewPanel';
-export * from './splitview/splitviewPanel';
-export * from './paneview/paneviewPanel';
-export * from './groupview/groupPanel';
-export * from './react'; // TODO: should be conditional on whether user wants the React wrappers
-export { Event } from './events';
-export { Position } from './dnd/droptarget';
-export { SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, } from './api/component.api';
+export * from './paneview/paneview';
+export * from './types';
+export * from './react';

package/dist/esm/paneview/paneview.d.ts

@@ -1,40 +1,24 @@
-import { Orientation, ISplitViewDescriptor, Sizing } from '../splitview/core/splitview';
-import { CompositeDisposable, IDisposable } from '../lifecycle';
-import { Event } from '../events';
-import { PaneviewPanel } from './paneviewPanel';
-interface PaneItem {
-    pane: PaneviewPanel;
-    disposable: IDisposable;
+import * as React from 'react';
+import { PaneviewPanelApi, PaneviewDndOverlayEvent, PaneviewApi, PaneviewDropEvent } from 'dockview-core';
+import { PanelCollection, PanelParameters } from '../types';
+export interface PaneviewReadyEvent {
+    api: PaneviewApi;
 }
-export declare class Paneview extends CompositeDisposable implements IDisposable {
-    private element;
-    private splitview;
-    private paneItems;
-    private _orientation;
-    private animationTimer;
-    private skipAnimation;
-    private readonly _onDidChange;
-    readonly onDidChange: Event<void>;
-    get onDidAddView(): Event<PaneviewPanel>;
-    get onDidRemoveView(): Event<PaneviewPanel>;
-    get minimumSize(): number;
-    get maximumSize(): number;
-    get orientation(): Orientation;
-    get size(): number;
-    get orthogonalSize(): number;
-    constructor(container: HTMLElement, options: {
-        orientation: Orientation;
-        descriptor?: ISplitViewDescriptor;
-    });
-    addPane(pane: PaneviewPanel, size?: number | Sizing, index?: number, skipLayout?: boolean): void;
-    getViewSize(index: number): number;
-    getPanes(): PaneviewPanel[];
-    removePane(index: number, options?: {
-        skipDispose: boolean;
-    }): PaneItem;
-    moveView(from: number, to: number): void;
-    layout(size: number, orthogonalSize: number): void;
-    private setupAnimation;
-    dispose(): void;
+export interface IPaneviewPanelProps<T extends {
+    [index: string]: any;
+} = any> extends PanelParameters<T> {
+    api: PaneviewPanelApi;
+    containerApi: PaneviewApi;
+    title: string;
 }
-export {};
+export interface IPaneviewReactProps {
+    onReady: (event: PaneviewReadyEvent) => void;
+    components: PanelCollection<IPaneviewPanelProps>;
+    headerComponents?: PanelCollection<IPaneviewPanelProps>;
+    className?: string;
+    disableAutoResizing?: boolean;
+    disableDnd?: boolean;
+    showDndOverlay?: (event: PaneviewDndOverlayEvent) => boolean;
+    onDidDrop?(event: PaneviewDropEvent): void;
+}
+export declare const PaneviewReact: React.ForwardRefExoticComponent<IPaneviewReactProps & React.RefAttributes<HTMLDivElement>>;