dockview-core 1.6.0

package/dist/esm/index.js

@@ -0,0 +1,35 @@
+export * from './dnd/dataTransfer';
+export { watchElementResize } from './dom';
+/**
+ * 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.
+ */
+export { Emitter as DockviewEmitter, Event as DockviewEvent } from './events';
+export { MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, } from './lifecycle';
+export * from './panel/types';
+export * from './panel/componentFactory';
+export * from './splitview/splitview';
+export * from './splitview/options';
+export * from './paneview/paneview';
+export * from './gridview/gridview';
+export * from './dockview/dockviewGroupPanelModel';
+export * from './gridview/baseComponentGridview';
+export * from './paneview/draggablePaneviewPanel';
+export * from './dockview/components/panel/content';
+export * from './dockview/components/tab/tab';
+export * from './dockview/types';
+export * from './dockview/dockviewGroupPanel';
+export * from './dockview/options';
+export * from './dockview/dockviewPanel';
+export * from './dockview/components/tab/defaultTab';
+export * from './dockview/deserializer';
+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 './dockview/types';
+export { positionToDirection, directionToPosition, } from './dnd/droptarget';
+export { SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, } from './api/component.api';

package/dist/esm/lifecycle.d.ts

@@ -0,0 +1,22 @@
+export interface IDisposable {
+    dispose: () => void;
+}
+export interface IValueDisposable<T> {
+    readonly value: T;
+    readonly disposable: IDisposable;
+}
+export declare namespace Disposable {
+    const NONE: IDisposable;
+}
+export declare class CompositeDisposable {
+    private readonly disposables;
+    static from(...args: IDisposable[]): CompositeDisposable;
+    constructor(...args: IDisposable[]);
+    addDisposables(...args: IDisposable[]): void;
+    dispose(): void;
+}
+export declare class MutableDisposable implements IDisposable {
+    private _disposable;
+    set value(disposable: IDisposable);
+    dispose(): void;
+}

package/dist/esm/lifecycle.js

@@ -0,0 +1,39 @@
+export var Disposable;
+(function (Disposable) {
+    Disposable.NONE = {
+        dispose: () => {
+            // noop
+        },
+    };
+})(Disposable || (Disposable = {}));
+export class CompositeDisposable {
+    static from(...args) {
+        return new CompositeDisposable(...args);
+    }
+    constructor(...args) {
+        this.disposables = args;
+    }
+    addDisposables(...args) {
+        args.forEach((arg) => this.disposables.push(arg));
+    }
+    dispose() {
+        this.disposables.forEach((arg) => arg.dispose());
+    }
+}
+export class MutableDisposable {
+    constructor() {
+        this._disposable = Disposable.NONE;
+    }
+    set value(disposable) {
+        if (this._disposable) {
+            this._disposable.dispose();
+        }
+        this._disposable = disposable;
+    }
+    dispose() {
+        if (this._disposable) {
+            this._disposable.dispose();
+            this._disposable = Disposable.NONE;
+        }
+    }
+}

package/dist/esm/math.d.ts

@@ -0,0 +1,5 @@
+export declare const clamp: (value: number, min: number, max: number) => number;
+export declare const sequentialNumberGenerator: () => {
+    next: () => string;
+};
+export declare const range: (from: number, to?: number) => number[];

package/dist/esm/math.js

@@ -0,0 +1,28 @@
+export const clamp = (value, min, max) => {
+    if (min > max) {
+        throw new Error(`${min} > ${max} is an invalid condition`);
+    }
+    return Math.min(max, Math.max(value, min));
+};
+export const sequentialNumberGenerator = () => {
+    let value = 1;
+    return { next: () => (value++).toString() };
+};
+export const range = (from, to) => {
+    const result = [];
+    if (typeof to !== 'number') {
+        to = from;
+        from = 0;
+    }
+    if (from <= to) {
+        for (let i = from; i < to; i++) {
+            result.push(i);
+        }
+    }
+    else {
+        for (let i = from; i > to; i--) {
+            result.push(i);
+        }
+    }
+    return result;
+};

package/dist/esm/panel/componentFactory.d.ts

@@ -0,0 +1,10 @@
+export interface FrameworkFactory<T> {
+    createComponent: (id: string, componentId: string, component: any) => T;
+}
+export declare function createComponent<T>(id: string, componentName?: string, components?: {
+    [componentName: string]: {
+        new (id: string, component: string): T;
+    };
+}, frameworkComponents?: {
+    [componentName: string]: any;
+}, createFrameworkComponent?: FrameworkFactory<T>, fallback?: () => T): T;

package/dist/esm/panel/componentFactory.js

@@ -0,0 +1,24 @@
+export function createComponent(id, componentName, components = {}, frameworkComponents = {}, createFrameworkComponent, fallback) {
+    const Component = typeof componentName === 'string'
+        ? components[componentName]
+        : undefined;
+    const FrameworkComponent = typeof componentName === 'string'
+        ? frameworkComponents[componentName]
+        : undefined;
+    if (Component && FrameworkComponent) {
+        throw new Error(`Cannot create '${id}'. component '${componentName}' registered as both a component and frameworkComponent`);
+    }
+    if (FrameworkComponent) {
+        if (!createFrameworkComponent) {
+            throw new Error(`Cannot create '${id}' for framework component '${componentName}'. you must register a frameworkPanelWrapper to use framework components`);
+        }
+        return createFrameworkComponent.createComponent(id, componentName, FrameworkComponent);
+    }
+    if (!Component) {
+        if (fallback) {
+            return fallback();
+        }
+        throw new Error(`Cannot create '${id}', no component '${componentName}' provided`);
+    }
+    return new Component(id, componentName);
+}

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

@@ -0,0 +1,33 @@
+import { IDisposable } from '../lifecycle';
+import { LayoutPriority } from '../splitview/splitview';
+/**
+ * A key-value object of anything that is a valid JavaScript Object.
+ */
+export interface Parameters {
+    [key: string]: any;
+}
+export interface PanelInitParameters {
+    params: Parameters;
+}
+export interface PanelUpdateEvent<T extends Parameters = Parameters> {
+    params: Partial<T>;
+}
+export interface IPanel extends IDisposable {
+    readonly id: string;
+    init(params: PanelInitParameters): void;
+    layout(width: number, height: number): void;
+    update(event: PanelUpdateEvent<Parameters>): void;
+    toJSON(): object;
+    focus?(): void;
+}
+export interface IFrameworkPart extends IDisposable {
+    update(params: Parameters): void;
+}
+export interface BaseComponentOptions {
+    id: string;
+    component: string;
+    params?: Parameters;
+    snap?: boolean;
+    priority?: LayoutPriority;
+    size?: number;
+}

package/dist/esm/panel/types.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,21 @@
+import { PaneviewPanelApiImpl } from '../api/paneviewPanelApi';
+import { CompositeDisposable } from '../lifecycle';
+import { PanelUpdateEvent } from '../panel/types';
+import { IPaneHeaderPart, PanePanelInitParameter } from './paneviewPanel';
+export declare class DefaultHeader extends CompositeDisposable implements IPaneHeaderPart {
+    private readonly _expandedIcon;
+    private readonly _collapsedIcon;
+    private readonly disposable;
+    private readonly _element;
+    private readonly _content;
+    private readonly _expander;
+    private apiRef;
+    get element(): HTMLElement;
+    constructor();
+    init(params: PanePanelInitParameter & {
+        api: PaneviewPanelApiImpl;
+    }): void;
+    private updateIcon;
+    update(_params: PanelUpdateEvent): void;
+    dispose(): void;
+}

package/dist/esm/paneview/defaultPaneviewHeader.js

@@ -0,0 +1,63 @@
+import { addDisposableListener } from '../events';
+import { CompositeDisposable, MutableDisposable } from '../lifecycle';
+import { toggleClass } from '../dom';
+import { createChevronRightButton, createExpandMoreButton } from '../svg';
+export class DefaultHeader extends CompositeDisposable {
+    get element() {
+        return this._element;
+    }
+    constructor() {
+        super();
+        this._expandedIcon = createExpandMoreButton();
+        this._collapsedIcon = createChevronRightButton();
+        this.disposable = new MutableDisposable();
+        this.apiRef = { api: null };
+        this._element = document.createElement('div');
+        this.element.className = 'default-header';
+        this._content = document.createElement('span');
+        this._expander = document.createElement('div');
+        this._expander.className = 'dockview-pane-header-icon';
+        this.element.appendChild(this._expander);
+        this.element.appendChild(this._content);
+        this.addDisposables(addDisposableListener(this._element, 'click', () => {
+            var _a;
+            (_a = this.apiRef.api) === null || _a === void 0 ? void 0 : _a.setExpanded(!this.apiRef.api.isExpanded);
+        }));
+    }
+    init(params) {
+        this.apiRef.api = params.api;
+        this._content.textContent = params.title;
+        this.updateIcon();
+        this.disposable.value = params.api.onDidExpansionChange(() => {
+            this.updateIcon();
+        });
+    }
+    updateIcon() {
+        var _a;
+        const isExpanded = !!((_a = this.apiRef.api) === null || _a === void 0 ? void 0 : _a.isExpanded);
+        toggleClass(this._expander, 'collapsed', !isExpanded);
+        if (isExpanded) {
+            if (this._expander.contains(this._collapsedIcon)) {
+                this._collapsedIcon.remove();
+            }
+            if (!this._expander.contains(this._expandedIcon)) {
+                this._expander.appendChild(this._expandedIcon);
+            }
+        }
+        else {
+            if (this._expander.contains(this._expandedIcon)) {
+                this._expandedIcon.remove();
+            }
+            if (!this._expander.contains(this._collapsedIcon)) {
+                this._expander.appendChild(this._collapsedIcon);
+            }
+        }
+    }
+    update(_params) {
+        //
+    }
+    dispose() {
+        this.disposable.dispose();
+        super.dispose();
+    }
+}

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

@@ -0,0 +1,21 @@
+import { PaneviewApi } from '../api/component.api';
+import { PaneTransfer } from '../dnd/dataTransfer';
+import { DroptargetEvent } from '../dnd/droptarget';
+import { Orientation } from '../splitview/splitview';
+import { IPaneviewComponent } from './paneviewComponent';
+import { IPaneviewPanel, PaneviewPanel } from './paneviewPanel';
+export interface PaneviewDropEvent extends DroptargetEvent {
+    panel: IPaneviewPanel;
+    getData: () => PaneTransfer | undefined;
+    api: PaneviewApi;
+}
+export declare abstract class DraggablePaneviewPanel extends PaneviewPanel {
+    private readonly accessor;
+    private handler;
+    private target;
+    private readonly _onDidDrop;
+    readonly onDidDrop: import("../events").Event<PaneviewDropEvent>;
+    constructor(accessor: IPaneviewComponent, id: string, component: string, headerComponent: string | undefined, orientation: Orientation, isExpanded: boolean, disableDnd: boolean);
+    private initDragFeatures;
+    private onDrop;
+}

package/dist/esm/paneview/draggablePaneviewPanel.js

@@ -0,0 +1,92 @@
+import { PaneviewApi } from '../api/component.api';
+import { DragHandler } from '../dnd/abstractDragHandler';
+import { getPaneData, LocalSelectionTransfer, PaneTransfer, } from '../dnd/dataTransfer';
+import { Droptarget } from '../dnd/droptarget';
+import { Emitter } from '../events';
+import { PaneviewPanel, } from './paneviewPanel';
+export class DraggablePaneviewPanel extends PaneviewPanel {
+    constructor(accessor, id, component, headerComponent, orientation, isExpanded, disableDnd) {
+        super(id, component, headerComponent, orientation, isExpanded, true);
+        this.accessor = accessor;
+        this._onDidDrop = new Emitter();
+        this.onDidDrop = this._onDidDrop.event;
+        if (!disableDnd) {
+            this.initDragFeatures();
+        }
+    }
+    initDragFeatures() {
+        if (!this.header) {
+            return;
+        }
+        const id = this.id;
+        const accessorId = this.accessor.id;
+        this.header.draggable = true;
+        this.handler = new (class PaneDragHandler extends DragHandler {
+            getData() {
+                LocalSelectionTransfer.getInstance().setData([new PaneTransfer(accessorId, id)], PaneTransfer.prototype);
+                return {
+                    dispose: () => {
+                        LocalSelectionTransfer.getInstance().clearData(PaneTransfer.prototype);
+                    },
+                };
+            }
+        })(this.header);
+        this.target = new Droptarget(this.element, {
+            acceptedTargetZones: ['top', 'bottom'],
+            overlayModel: {
+                activationSize: { type: 'percentage', value: 50 },
+            },
+            canDisplayOverlay: (event) => {
+                const data = getPaneData();
+                if (data) {
+                    if (data.paneId !== this.id &&
+                        data.viewId === this.accessor.id) {
+                        return true;
+                    }
+                }
+                if (this.accessor.options.showDndOverlay) {
+                    return this.accessor.options.showDndOverlay({
+                        nativeEvent: event,
+                        getData: getPaneData,
+                        panel: this,
+                    });
+                }
+                return false;
+            },
+        });
+        this.addDisposables(this._onDidDrop, this.handler, this.target, this.target.onDrop((event) => {
+            this.onDrop(event);
+        }));
+    }
+    onDrop(event) {
+        const data = getPaneData();
+        if (!data || data.viewId !== this.accessor.id) {
+            // if there is no local drag event for this panel
+            // or if the drag event was creating by another Paneview instance
+            this._onDidDrop.fire(Object.assign(Object.assign({}, event), { panel: this, api: new PaneviewApi(this.accessor), getData: getPaneData }));
+            return;
+        }
+        const containerApi = this._params
+            .containerApi;
+        const panelId = data.paneId;
+        const existingPanel = containerApi.getPanel(panelId);
+        if (!existingPanel) {
+            // if the panel doesn't exist
+            this._onDidDrop.fire(Object.assign(Object.assign({}, event), { panel: this, getData: getPaneData, api: new PaneviewApi(this.accessor) }));
+            return;
+        }
+        const allPanels = containerApi.panels;
+        const fromIndex = allPanels.indexOf(existingPanel);
+        let toIndex = containerApi.panels.indexOf(this);
+        if (event.position === 'left' || event.position === 'top') {
+            toIndex = Math.max(0, toIndex - 1);
+        }
+        if (event.position === 'right' || event.position === 'bottom') {
+            if (fromIndex > toIndex) {
+                toIndex++;
+            }
+            toIndex = Math.min(allPanels.length - 1, toIndex);
+        }
+        containerApi.movePanel(fromIndex, toIndex);
+    }
+}

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

@@ -0,0 +1,27 @@
+import { FrameworkFactory } from '../panel/componentFactory';
+import { PaneviewDndOverlayEvent } from './paneviewComponent';
+import { IPaneBodyPart, IPaneHeaderPart, PaneviewPanel } from './paneviewPanel';
+export interface PaneviewComponentOptions {
+    components?: {
+        [componentName: string]: {
+            new (id: string, componentName: string): PaneviewPanel;
+        };
+    };
+    frameworkComponents?: {
+        [componentName: string]: any;
+    };
+    headerComponents?: {
+        [componentName: string]: {
+            new (id: string, componentName: string): PaneviewPanel;
+        };
+    };
+    headerframeworkComponents?: {
+        [componentName: string]: any;
+    };
+    frameworkWrapper?: {
+        header: FrameworkFactory<IPaneHeaderPart>;
+        body: FrameworkFactory<IPaneBodyPart>;
+    };
+    disableDnd?: boolean;
+    showDndOverlay?: (event: PaneviewDndOverlayEvent) => boolean;
+}

package/dist/esm/paneview/options.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,40 @@
+import { Orientation, ISplitViewDescriptor, Sizing } from '../splitview/splitview';
+import { CompositeDisposable, IDisposable } from '../lifecycle';
+import { Event } from '../events';
+import { PaneviewPanel } from './paneviewPanel';
+interface PaneItem {
+    pane: PaneviewPanel;
+    disposable: IDisposable;
+}
+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 {};

package/dist/esm/paneview/paneview.js

@@ -0,0 +1,145 @@
+import { Splitview, Orientation, } from '../splitview/splitview';
+import { CompositeDisposable } from '../lifecycle';
+import { Emitter } from '../events';
+import { addClasses, removeClasses } from '../dom';
+export class Paneview extends CompositeDisposable {
+    get onDidAddView() {
+        return this.splitview.onDidAddView;
+    }
+    get onDidRemoveView() {
+        return this.splitview.onDidRemoveView;
+    }
+    get minimumSize() {
+        return this.splitview.minimumSize;
+    }
+    get maximumSize() {
+        return this.splitview.maximumSize;
+    }
+    get orientation() {
+        return this.splitview.orientation;
+    }
+    get size() {
+        return this.splitview.size;
+    }
+    get orthogonalSize() {
+        return this.splitview.orthogonalSize;
+    }
+    constructor(container, options) {
+        var _a;
+        super();
+        this.paneItems = [];
+        this.skipAnimation = false;
+        this._onDidChange = new Emitter();
+        this.onDidChange = this._onDidChange.event;
+        this._orientation = (_a = options.orientation) !== null && _a !== void 0 ? _a : Orientation.VERTICAL;
+        this.element = document.createElement('div');
+        this.element.className = 'pane-container';
+        container.appendChild(this.element);
+        this.splitview = new Splitview(this.element, {
+            orientation: this._orientation,
+            proportionalLayout: false,
+            descriptor: options.descriptor,
+        });
+        // if we've added views from the descriptor we need to
+        // add the panes to our Pane array and setup animation
+        this.getPanes().forEach((pane) => {
+            const disposable = new CompositeDisposable(pane.onDidChangeExpansionState(() => {
+                this.setupAnimation();
+                this._onDidChange.fire(undefined);
+            }));
+            const paneItem = {
+                pane,
+                disposable: {
+                    dispose: () => {
+                        disposable.dispose();
+                    },
+                },
+            };
+            this.paneItems.push(paneItem);
+            pane.orthogonalSize = this.splitview.orthogonalSize;
+        });
+        this.addDisposables(this._onDidChange, this.splitview.onDidSashEnd(() => {
+            this._onDidChange.fire(undefined);
+        }), this.splitview.onDidAddView(() => {
+            this._onDidChange.fire();
+        }), this.splitview.onDidRemoveView(() => {
+            this._onDidChange.fire();
+        }));
+    }
+    addPane(pane, size, index = this.splitview.length, skipLayout = false) {
+        const disposable = pane.onDidChangeExpansionState(() => {
+            this.setupAnimation();
+            this._onDidChange.fire(undefined);
+        });
+        const paneItem = {
+            pane,
+            disposable: {
+                dispose: () => {
+                    disposable.dispose();
+                },
+            },
+        };
+        this.paneItems.splice(index, 0, paneItem);
+        pane.orthogonalSize = this.splitview.orthogonalSize;
+        this.splitview.addView(pane, size, index, skipLayout);
+    }
+    getViewSize(index) {
+        return this.splitview.getViewSize(index);
+    }
+    getPanes() {
+        return this.splitview.getViews();
+    }
+    removePane(index, options = { skipDispose: false }) {
+        const paneItem = this.paneItems.splice(index, 1)[0];
+        this.splitview.removeView(index);
+        if (!options.skipDispose) {
+            paneItem.disposable.dispose();
+            paneItem.pane.dispose();
+        }
+        return paneItem;
+    }
+    moveView(from, to) {
+        if (from === to) {
+            return;
+        }
+        const view = this.removePane(from, { skipDispose: true });
+        this.skipAnimation = true;
+        try {
+            this.addPane(view.pane, view.pane.size, to, false);
+        }
+        finally {
+            this.skipAnimation = false;
+        }
+    }
+    layout(size, orthogonalSize) {
+        this.splitview.layout(size, orthogonalSize);
+    }
+    setupAnimation() {
+        if (this.skipAnimation) {
+            return;
+        }
+        if (this.animationTimer) {
+            clearTimeout(this.animationTimer);
+            this.animationTimer = undefined;
+        }
+        addClasses(this.element, 'animated');
+        this.animationTimer = setTimeout(() => {
+            this.animationTimer = undefined;
+            removeClasses(this.element, 'animated');
+        }, 200);
+    }
+    dispose() {
+        super.dispose();
+        if (this.animationTimer) {
+            clearTimeout(this.animationTimer);
+            this.animationTimer = undefined;
+        }
+        this.paneItems.forEach((paneItem) => {
+            paneItem.disposable.dispose();
+            paneItem.pane.dispose();
+        });
+        this.paneItems = [];
+        this.splitview.dispose();
+        this.element.remove();
+    }
+}