dockview 1.5.2 → 1.7.0

package/dist/esm/gridview/branchNode.js

@@ -1,218 +0,0 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Splitview, Orientation, LayoutPriority, } from '../splitview/core/splitview';
-import { Emitter, Event } from '../events';
-import { LeafNode } from './leafNode';
-import { CompositeDisposable, Disposable } from '../lifecycle';
-export class BranchNode extends CompositeDisposable {
-    constructor(orientation, proportionalLayout, styles, size, orthogonalSize, childDescriptors) {
-        super();
-        this.orientation = orientation;
-        this.proportionalLayout = proportionalLayout;
-        this.styles = styles;
-        this.children = [];
-        this._onDidChange = new Emitter();
-        this.onDidChange = this._onDidChange.event;
-        this._childrenDisposable = Disposable.NONE;
-        this._orthogonalSize = orthogonalSize;
-        this._size = size;
-        this.element = document.createElement('div');
-        this.element.className = 'branch-node';
-        if (!childDescriptors) {
-            this.splitview = new Splitview(this.element, {
-                orientation: this.orientation,
-                proportionalLayout,
-                styles,
-            });
-            this.splitview.layout(this.size, this.orthogonalSize);
-        }
-        else {
-            const descriptor = {
-                views: childDescriptors.map((childDescriptor) => {
-                    return {
-                        view: childDescriptor.node,
-                        size: childDescriptor.node.size,
-                        visible: childDescriptor.node instanceof LeafNode &&
-                            childDescriptor.visible !== undefined
-                            ? childDescriptor.visible
-                            : true,
-                    };
-                }),
-                size: this.size,
-            };
-            this.children = childDescriptors.map((c) => c.node);
-            this.splitview = new Splitview(this.element, {
-                orientation: this.orientation,
-                descriptor,
-                proportionalLayout,
-            });
-        }
-        this.addDisposables(this._onDidChange, this.splitview.onDidSashEnd(() => {
-            this._onDidChange.fire({});
-        }));
-        this.setupChildrenEvents();
-    }
-    get width() {
-        return this.orientation === Orientation.HORIZONTAL
-            ? this.size
-            : this.orthogonalSize;
-    }
-    get height() {
-        return this.orientation === Orientation.HORIZONTAL
-            ? this.orthogonalSize
-            : this.size;
-    }
-    get minimumSize() {
-        return this.children.length === 0
-            ? 0
-            : Math.max(...this.children.map((c) => c.minimumOrthogonalSize));
-    }
-    get maximumSize() {
-        return Math.min(...this.children.map((c) => c.maximumOrthogonalSize));
-    }
-    get minimumOrthogonalSize() {
-        return this.splitview.minimumSize;
-    }
-    get maximumOrthogonalSize() {
-        return this.splitview.maximumSize;
-    }
-    get orthogonalSize() {
-        return this._orthogonalSize;
-    }
-    get size() {
-        return this._size;
-    }
-    get minimumWidth() {
-        return this.orientation === Orientation.HORIZONTAL
-            ? this.minimumOrthogonalSize
-            : this.minimumSize;
-    }
-    get minimumHeight() {
-        return this.orientation === Orientation.HORIZONTAL
-            ? this.minimumSize
-            : this.minimumOrthogonalSize;
-    }
-    get maximumWidth() {
-        return this.orientation === Orientation.HORIZONTAL
-            ? this.maximumOrthogonalSize
-            : this.maximumSize;
-    }
-    get maximumHeight() {
-        return this.orientation === Orientation.HORIZONTAL
-            ? this.maximumSize
-            : this.maximumOrthogonalSize;
-    }
-    get priority() {
-        if (this.children.length === 0) {
-            return LayoutPriority.Normal;
-        }
-        const priorities = this.children.map((c) => typeof c.priority === 'undefined'
-            ? LayoutPriority.Normal
-            : c.priority);
-        if (priorities.some((p) => p === LayoutPriority.High)) {
-            return LayoutPriority.High;
-        }
-        else if (priorities.some((p) => p === LayoutPriority.Low)) {
-            return LayoutPriority.Low;
-        }
-        return LayoutPriority.Normal;
-    }
-    setVisible(visible) {
-        for (const child of this.children) {
-            child.setVisible(visible);
-        }
-    }
-    isChildVisible(index) {
-        if (index < 0 || index >= this.children.length) {
-            throw new Error('Invalid index');
-        }
-        return this.splitview.isViewVisible(index);
-    }
-    setChildVisible(index, visible) {
-        if (index < 0 || index >= this.children.length) {
-            throw new Error('Invalid index');
-        }
-        if (this.splitview.isViewVisible(index) === visible) {
-            return;
-        }
-        this.splitview.setViewVisible(index, visible);
-    }
-    moveChild(from, to) {
-        if (from === to) {
-            return;
-        }
-        if (from < 0 || from >= this.children.length) {
-            throw new Error('Invalid from index');
-        }
-        if (from < to) {
-            to--;
-        }
-        this.splitview.moveView(from, to);
-        const child = this._removeChild(from);
-        this._addChild(child, to);
-    }
-    getChildSize(index) {
-        if (index < 0 || index >= this.children.length) {
-            throw new Error('Invalid index');
-        }
-        return this.splitview.getViewSize(index);
-    }
-    resizeChild(index, size) {
-        if (index < 0 || index >= this.children.length) {
-            throw new Error('Invalid index');
-        }
-        this.splitview.resizeView(index, size);
-    }
-    layout(size, orthogonalSize) {
-        this._size = orthogonalSize;
-        this._orthogonalSize = size;
-        this.splitview.layout(this.size, this.orthogonalSize);
-    }
-    addChild(node, size, index, skipLayout) {
-        if (index < 0 || index > this.children.length) {
-            throw new Error('Invalid index');
-        }
-        this.splitview.addView(node, size, index, skipLayout);
-        this._addChild(node, index);
-    }
-    getChildCachedVisibleSize(index) {
-        if (index < 0 || index >= this.children.length) {
-            throw new Error('Invalid index');
-        }
-        return this.splitview.getViewCachedVisibleSize(index);
-    }
-    removeChild(index, sizing) {
-        if (index < 0 || index >= this.children.length) {
-            throw new Error('Invalid index');
-        }
-        this.splitview.removeView(index, sizing);
-        this._removeChild(index);
-    }
-    _addChild(node, index) {
-        this.children.splice(index, 0, node);
-        this.setupChildrenEvents();
-    }
-    _removeChild(index) {
-        const [child] = this.children.splice(index, 1);
-        this.setupChildrenEvents();
-        return child;
-    }
-    setupChildrenEvents() {
-        this._childrenDisposable.dispose();
-        this._childrenDisposable = Event.any(...this.children.map((c) => c.onDidChange))((e) => {
-            /**
-             * indicate a change has occured to allows any re-rendering but don't bubble
-             * event because that was specific to this branch
-             */
-            this._onDidChange.fire({ size: e.orthogonalSize });
-        });
-    }
-    dispose() {
-        super.dispose();
-        this._childrenDisposable.dispose();
-        this.children.forEach((child) => child.dispose());
-        this.splitview.dispose();
-    }
-}

package/dist/esm/gridview/gridviewComponent.d.ts

@@ -1,85 +0,0 @@
-import { SerializedGridObject } from './gridview';
-import { Position } from '../dnd/droptarget';
-import { IPanelDeserializer } from '../dockview/deserializer';
-import { GridviewComponentOptions } from './options';
-import { BaseGrid, Direction, IBaseGrid, IGridPanelView } from './baseComponentGridview';
-import { GridviewPanel, GridviewInitParameters, GridPanelViewState, IGridviewPanel } from './gridviewPanel';
-import { BaseComponentOptions } from '../panel/types';
-import { Orientation, Sizing } from '../splitview/core/splitview';
-import { Event } from '../events';
-export interface SerializedGridview {
-    grid: {
-        height: number;
-        width: number;
-        orientation: Orientation;
-        root: SerializedGridObject<GridPanelViewState>;
-    };
-    activePanel?: string;
-}
-export interface AddComponentOptions extends BaseComponentOptions {
-    minimumWidth?: number;
-    maximumWidth?: number;
-    minimumHeight?: number;
-    maximumHeight?: number;
-    position?: {
-        direction: Direction;
-        referencePanel: string;
-    };
-    location?: number[];
-}
-export interface IGridPanelComponentView extends IGridPanelView {
-    init: (params: GridviewInitParameters) => void;
-}
-export declare type GridviewComponentUpdateOptions = Pick<GridviewComponentOptions, 'orientation' | 'components' | 'frameworkComponents'>;
-export interface IGridviewComponent extends IBaseGrid<GridviewPanel> {
-    readonly orientation: Orientation;
-    readonly onDidLayoutFromJSON: Event<void>;
-    updateOptions(options: Partial<GridviewComponentUpdateOptions>): void;
-    addPanel(options: AddComponentOptions): IGridviewPanel;
-    removePanel(panel: IGridviewPanel, sizing?: Sizing): void;
-    focus(): void;
-    fromJSON(serializedGridview: SerializedGridview): void;
-    toJSON(): SerializedGridview;
-    movePanel(panel: IGridviewPanel, options: {
-        direction: Direction;
-        reference: string;
-        size?: number;
-    }): void;
-    setVisible(panel: IGridviewPanel, visible: boolean): void;
-    setActive(panel: IGridviewPanel): void;
-}
-export declare class GridviewComponent extends BaseGrid<GridviewPanel> implements IGridviewComponent {
-    private _options;
-    private _deserializer;
-    private readonly _onDidLayoutfromJSON;
-    readonly onDidLayoutFromJSON: Event<void>;
-    get orientation(): Orientation;
-    set orientation(value: Orientation);
-    get options(): GridviewComponentOptions;
-    get deserializer(): IPanelDeserializer | undefined;
-    set deserializer(value: IPanelDeserializer | undefined);
-    constructor(element: HTMLElement, options: GridviewComponentOptions);
-    updateOptions(options: Partial<GridviewComponentUpdateOptions>): void;
-    removePanel(panel: GridviewPanel): void;
-    /**
-     * Serialize the current state of the layout
-     *
-     * @returns A JSON respresentation of the layout
-     */
-    toJSON(): SerializedGridview;
-    setVisible(panel: GridviewPanel, visible: boolean): void;
-    setActive(panel: GridviewPanel): void;
-    focus(): void;
-    fromJSON(serializedGridview: SerializedGridview): void;
-    clear(): void;
-    movePanel(panel: GridviewPanel, options: {
-        direction: Direction;
-        reference: string;
-        size?: number;
-    }): void;
-    addPanel(options: AddComponentOptions): IGridviewPanel;
-    private registerPanel;
-    moveGroup(referenceGroup: IGridPanelComponentView, groupId: string, target: Position): void;
-    removeGroup(group: GridviewPanel): void;
-    dispose(): void;
-}

package/dist/esm/gridview/gridviewComponent.js

@@ -1,238 +0,0 @@
-import { getRelativeLocation, getGridLocation, } from './gridview';
-import { Position } from '../dnd/droptarget';
-import { tail, sequenceEquals } from '../array';
-import { CompositeDisposable } from '../lifecycle';
-import { BaseGrid, toTarget, } from './baseComponentGridview';
-import { createComponent } from '../panel/componentFactory';
-import { Emitter } from '../events';
-export class GridviewComponent extends BaseGrid {
-    constructor(element, options) {
-        super(element, {
-            proportionalLayout: options.proportionalLayout,
-            orientation: options.orientation,
-            styles: options.styles,
-        });
-        this._onDidLayoutfromJSON = new Emitter();
-        this.onDidLayoutFromJSON = this._onDidLayoutfromJSON.event;
-        this._options = options;
-        if (!this.options.components) {
-            this.options.components = {};
-        }
-        if (!this.options.frameworkComponents) {
-            this.options.frameworkComponents = {};
-        }
-    }
-    get orientation() {
-        return this.gridview.orientation;
-    }
-    set orientation(value) {
-        this.gridview.orientation = value;
-    }
-    get options() {
-        return this._options;
-    }
-    get deserializer() {
-        return this._deserializer;
-    }
-    set deserializer(value) {
-        this._deserializer = value;
-    }
-    updateOptions(options) {
-        const hasOrientationChanged = typeof options.orientation === 'string' &&
-            this.gridview.orientation !== options.orientation;
-        this._options = Object.assign(Object.assign({}, this.options), options);
-        if (hasOrientationChanged) {
-            this.gridview.orientation = options.orientation;
-        }
-        this.layout(this.gridview.width, this.gridview.height, true);
-    }
-    removePanel(panel) {
-        this.removeGroup(panel);
-    }
-    /**
-     * Serialize the current state of the layout
-     *
-     * @returns A JSON respresentation of the layout
-     */
-    toJSON() {
-        var _a;
-        const data = this.gridview.serialize();
-        return {
-            grid: data,
-            activePanel: (_a = this.activeGroup) === null || _a === void 0 ? void 0 : _a.id,
-        };
-    }
-    setVisible(panel, visible) {
-        this.gridview.setViewVisible(getGridLocation(panel.element), visible);
-    }
-    setActive(panel) {
-        this._groups.forEach((value, _key) => {
-            value.value.setActive(panel === value.value);
-        });
-    }
-    focus() {
-        var _a;
-        (_a = this.activeGroup) === null || _a === void 0 ? void 0 : _a.focus();
-    }
-    fromJSON(serializedGridview) {
-        this.clear();
-        const { grid, activePanel } = serializedGridview;
-        const queue = [];
-        this.gridview.deserialize(grid, {
-            fromJSON: (node) => {
-                const { data } = node;
-                const view = createComponent(data.id, data.component, this.options.components || {}, this.options.frameworkComponents || {}, this.options.frameworkComponentFactory
-                    ? {
-                        createComponent: this.options.frameworkComponentFactory
-                            .createComponent,
-                    }
-                    : undefined);
-                queue.push(() => view.init({
-                    params: data.params,
-                    minimumWidth: data.minimumWidth,
-                    maximumWidth: data.maximumWidth,
-                    minimumHeight: data.minimumHeight,
-                    maximumHeight: data.maximumHeight,
-                    priority: data.priority,
-                    snap: !!data.snap,
-                    accessor: this,
-                    isVisible: node.visible,
-                }));
-                this._onDidAddGroup.fire(view);
-                this.registerPanel(view);
-                return view;
-            },
-        });
-        this.layout(this.width, this.height, true);
-        queue.forEach((f) => f());
-        if (typeof activePanel === 'string') {
-            const panel = this.getPanel(activePanel);
-            if (panel) {
-                this.doSetGroupActive(panel);
-            }
-        }
-        this._onDidLayoutfromJSON.fire();
-    }
-    clear() {
-        const hasActiveGroup = this.activeGroup;
-        const groups = Array.from(this._groups.values()); // reassign since group panels will mutate
-        for (const group of groups) {
-            group.disposable.dispose();
-            this.doRemoveGroup(group.value, { skipActive: true });
-        }
-        if (hasActiveGroup) {
-            this.doSetGroupActive(undefined);
-        }
-        this.gridview.clear();
-    }
-    movePanel(panel, options) {
-        var _a;
-        let relativeLocation;
-        const removedPanel = this.gridview.remove(panel);
-        const referenceGroup = (_a = this._groups.get(options.reference)) === null || _a === void 0 ? void 0 : _a.value;
-        if (!referenceGroup) {
-            throw new Error(`reference group ${options.reference} does not exist`);
-        }
-        const target = toTarget(options.direction);
-        if (target === Position.Center) {
-            throw new Error(`${target} not supported as an option`);
-        }
-        else {
-            const location = getGridLocation(referenceGroup.element);
-            relativeLocation = getRelativeLocation(this.gridview.orientation, location, target);
-        }
-        this.doAddGroup(removedPanel, relativeLocation, options.size);
-    }
-    addPanel(options) {
-        var _a, _b;
-        let relativeLocation = options.location || [0];
-        if ((_a = options.position) === null || _a === void 0 ? void 0 : _a.referencePanel) {
-            const referenceGroup = (_b = this._groups.get(options.position.referencePanel)) === null || _b === void 0 ? void 0 : _b.value;
-            if (!referenceGroup) {
-                throw new Error(`reference group ${options.position.referencePanel} does not exist`);
-            }
-            const target = toTarget(options.position.direction);
-            if (target === Position.Center) {
-                throw new Error(`${target} not supported as an option`);
-            }
-            else {
-                const location = getGridLocation(referenceGroup.element);
-                relativeLocation = getRelativeLocation(this.gridview.orientation, location, target);
-            }
-        }
-        const view = createComponent(options.id, options.component, this.options.components || {}, this.options.frameworkComponents || {}, this.options.frameworkComponentFactory
-            ? {
-                createComponent: this.options.frameworkComponentFactory
-                    .createComponent,
-            }
-            : undefined);
-        view.init({
-            params: options.params || {},
-            minimumWidth: options.minimumWidth,
-            maximumWidth: options.maximumWidth,
-            minimumHeight: options.minimumHeight,
-            maximumHeight: options.maximumHeight,
-            priority: options.priority,
-            snap: !!options.snap,
-            accessor: this,
-            isVisible: true,
-        });
-        this.registerPanel(view);
-        this.doAddGroup(view, relativeLocation, options.size);
-        return view;
-    }
-    registerPanel(panel) {
-        const disposable = new CompositeDisposable(panel.api.onDidFocusChange((event) => {
-            if (!event.isFocused) {
-                return;
-            }
-            this._groups.forEach((groupItem) => {
-                const group = groupItem.value;
-                if (group !== panel) {
-                    group.setActive(false);
-                }
-                else {
-                    group.setActive(true);
-                }
-            });
-        }));
-        this._groups.set(panel.id, {
-            value: panel,
-            disposable,
-        });
-    }
-    moveGroup(referenceGroup, groupId, target) {
-        const sourceGroup = this.getPanel(groupId);
-        if (!sourceGroup) {
-            throw new Error('invalid operation');
-        }
-        const referenceLocation = getGridLocation(referenceGroup.element);
-        const targetLocation = getRelativeLocation(this.gridview.orientation, referenceLocation, target);
-        const [targetParentLocation, to] = tail(targetLocation);
-        const sourceLocation = getGridLocation(sourceGroup.element);
-        const [sourceParentLocation, from] = tail(sourceLocation);
-        if (sequenceEquals(sourceParentLocation, targetParentLocation)) {
-            // special case when 'swapping' two views within same grid location
-            // if a group has one tab - we are essentially moving the 'group'
-            // which is equivalent to swapping two views in this case
-            this.gridview.moveView(sourceParentLocation, from, to);
-            return;
-        }
-        // source group will become empty so delete the group
-        const targetGroup = this.doRemoveGroup(sourceGroup, {
-            skipActive: true,
-            skipDispose: true,
-        });
-        // after deleting the group we need to re-evaulate the ref location
-        const updatedReferenceLocation = getGridLocation(referenceGroup.element);
-        const location = getRelativeLocation(this.gridview.orientation, updatedReferenceLocation, target);
-        this.doAddGroup(targetGroup, location);
-    }
-    removeGroup(group) {
-        super.removeGroup(group);
-    }
-    dispose() {
-        super.dispose();
-        this._onDidLayoutfromJSON.dispose();
-    }
-}

package/dist/esm/gridview/gridviewPanel.d.ts

@@ -1,60 +0,0 @@
-import { PanelInitParameters } from '../panel/types';
-import { GridviewComponent, IGridPanelComponentView } from './gridviewComponent';
-import { BasePanelView, BasePanelViewExported, BasePanelViewState } from './basePanelView';
-import { GridviewPanelApiImpl } from '../api/gridviewPanelApi';
-import { LayoutPriority } from '../splitview/core/splitview';
-import { Event } from '../events';
-import { IViewSize } from './gridview';
-export interface GridviewInitParameters extends PanelInitParameters {
-    minimumWidth?: number;
-    maximumWidth?: number;
-    minimumHeight?: number;
-    maximumHeight?: number;
-    priority?: LayoutPriority;
-    snap?: boolean;
-    accessor: GridviewComponent;
-    isVisible?: boolean;
-}
-export interface IGridviewPanel extends BasePanelViewExported<GridviewPanelApiImpl> {
-    readonly minimumWidth: number;
-    readonly maximumWidth: number;
-    readonly minimumHeight: number;
-    readonly maximumHeight: number;
-    readonly priority: LayoutPriority | undefined;
-    readonly snap: boolean;
-}
-export declare abstract class GridviewPanel extends BasePanelView<GridviewPanelApiImpl> implements IGridPanelComponentView, IGridviewPanel {
-    private _evaluatedMinimumWidth;
-    private _evaluatedMaximumWidth;
-    private _evaluatedMinimumHeight;
-    private _evaluatedMaximumHeight;
-    private _minimumWidth;
-    private _minimumHeight;
-    private _maximumWidth;
-    private _maximumHeight;
-    private _priority?;
-    private _snap;
-    private readonly _onDidChange;
-    readonly onDidChange: Event<IViewSize | undefined>;
-    get priority(): LayoutPriority | undefined;
-    get snap(): boolean;
-    get minimumWidth(): number;
-    get minimumHeight(): number;
-    get maximumHeight(): number;
-    get maximumWidth(): number;
-    get isActive(): boolean;
-    constructor(id: string, component: string, api?: GridviewPanelApiImpl);
-    setVisible(isVisible: boolean): void;
-    setActive(isActive: boolean): void;
-    init(parameters: GridviewInitParameters): void;
-    private updateConstraints;
-    toJSON(): GridPanelViewState;
-}
-export interface GridPanelViewState extends BasePanelViewState {
-    minimumHeight?: number;
-    maximumHeight?: number;
-    minimumWidth?: number;
-    maximumWidth?: number;
-    snap?: boolean;
-    priority?: LayoutPriority;
-}