dockview 1.6.0 → 1.7.0

package/dist/esm/dockview/dockviewPanel.js

@@ -1,111 +0,0 @@
-import { DockviewPanelApiImpl, } from '../api/dockviewPanelApi';
-import { CompositeDisposable, MutableDisposable, } from '../lifecycle';
-export class DockviewPanel extends CompositeDisposable {
-    get params() {
-        return this._params;
-    }
-    get title() {
-        return this._title;
-    }
-    get group() {
-        return this._group;
-    }
-    get view() {
-        return this._view;
-    }
-    constructor(id, accessor, containerApi, group) {
-        super();
-        this.id = id;
-        this.containerApi = containerApi;
-        this.mutableDisposable = new MutableDisposable();
-        this._title = '';
-        this._group = group;
-        this.api = new DockviewPanelApiImpl(this, this._group);
-        this.addDisposables(this.api.onActiveChange(() => {
-            accessor.setActivePanel(this);
-        }), this.api.onDidSizeChange((event) => {
-            // forward the resize event to the group since if you want to resize a panel
-            // you are actually just resizing the panels parent which is the group
-            this.group.api.setSize(event);
-        }));
-    }
-    init(params) {
-        var _a;
-        this._params = params.params;
-        this._view = params.view;
-        this.setTitle(params.title);
-        (_a = this.view) === null || _a === void 0 ? void 0 : _a.init(Object.assign(Object.assign({}, params), { api: this.api, containerApi: this.containerApi }));
-    }
-    focus() {
-        this.api._onFocusEvent.fire();
-    }
-    toJSON() {
-        return {
-            id: this.id,
-            view: this.view.toJSON(),
-            params: Object.keys(this._params || {}).length > 0
-                ? this._params
-                : undefined,
-            title: this.title,
-        };
-    }
-    setTitle(title) {
-        var _a, _b;
-        const didTitleChange = title !== ((_a = this._params) === null || _a === void 0 ? void 0 : _a.title);
-        if (didTitleChange) {
-            this._title = title;
-            (_b = this.view) === null || _b === void 0 ? void 0 : _b.update({
-                params: {
-                    params: this._params,
-                    title: this.title,
-                },
-            });
-            this.api._onDidTitleChange.fire({ title });
-        }
-    }
-    update(event) {
-        var _a;
-        const params = event.params;
-        this._params = Object.assign(Object.assign({}, (this._params || {})), event.params.params);
-        if (typeof params.title === 'string') {
-            if (params.title !== this.title) {
-                this._title = params.title;
-                this.api._onDidTitleChange.fire({ title: this.title });
-            }
-        }
-        (_a = this.view) === null || _a === void 0 ? void 0 : _a.update({
-            params: {
-                params: this._params,
-                title: this.title,
-            },
-        });
-    }
-    updateParentGroup(group, isGroupActive) {
-        var _a;
-        this._group = group;
-        this.api.group = group;
-        const isPanelVisible = this._group.model.isPanelActive(this);
-        this.api._onDidActiveChange.fire({
-            isActive: isGroupActive && isPanelVisible,
-        });
-        this.api._onDidVisibilityChange.fire({
-            isVisible: isPanelVisible,
-        });
-        (_a = this.view) === null || _a === void 0 ? void 0 : _a.updateParentGroup(this._group, this._group.model.isPanelActive(this));
-    }
-    layout(width, height) {
-        var _a;
-        // the obtain the correct dimensions of the content panel we must deduct the tab height
-        this.api._onDidDimensionChange.fire({
-            width,
-            height: height - (this.group.model.header.height || 0),
-        });
-        (_a = this.view) === null || _a === void 0 ? void 0 : _a.layout(width, height);
-    }
-    dispose() {
-        var _a;
-        this.api.dispose();
-        this.mutableDisposable.dispose();
-        (_a = this.view) === null || _a === void 0 ? void 0 : _a.dispose();
-    }
-}

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

@@ -1,110 +0,0 @@
-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/esm/dockview/options.js

@@ -1,24 +0,0 @@
-export function isPanelOptionsWithPanel(data) {
-    if (data.referencePanel) {
-        return true;
-    }
-    return false;
-}
-export function isPanelOptionsWithGroup(data) {
-    if (data.referenceGroup) {
-        return true;
-    }
-    return false;
-}
-export function isGroupOptionsWithPanel(data) {
-    if (data.referencePanel) {
-        return true;
-    }
-    return false;
-}
-export function isGroupOptionsWithGroup(data) {
-    if (data.referenceGroup) {
-        return true;
-    }
-    return false;
-}

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

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

package/dist/esm/dockview/validation.js

@@ -1,86 +0,0 @@
-import { Orientation } from '../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) {
-    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');
-    }
-    for (const child of value.views) {
-        if (typeof child !== 'string') {
-            if (!Array.isArray(value.views)) {
-                throw new Error('invalid layout');
-            }
-        }
-    }
-}
-function validateSerializedGridObject(value) {
-    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)) {
-        for (const child of value.data) {
-            validateSerializedGridObject(child);
-        }
-    }
-    else {
-        validateGroupPanelViewState(value.data);
-    }
-}
-export function validateSerializedDockview(data) {
-    if (typeof data !== 'object') {
-        throw new Error('invalid layout');
-    }
-    const { grid, panels, options, activeGroup } = data;
-    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 !== Orientation.HORIZONTAL &&
-        grid.orientation !== 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');
-    }
-    for (const value of Object.values(data.panels)) {
-        validateGroupViewPanelState(value);
-    }
-}

package/dist/esm/dom.d.ts

@@ -1,14 +0,0 @@
-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;

package/dist/esm/dom.js

@@ -1,113 +0,0 @@
-import { Emitter, addDisposableListener, addDisposableWindowListener, } from './events';
-import { CompositeDisposable } from './lifecycle';
-export function watchElementResize(element, cb) {
-    const observer = new ResizeObserver((entires) => {
-        const firstEntry = entires[0];
-        cb(firstEntry);
-    });
-    observer.observe(element);
-    return {
-        dispose: () => {
-            observer.unobserve(element);
-            observer.disconnect();
-        },
-    };
-}
-export const removeClasses = (element, ...classes) => {
-    for (const classname of classes) {
-        if (element.classList.contains(classname)) {
-            element.classList.remove(classname);
-        }
-    }
-};
-export const addClasses = (element, ...classes) => {
-    for (const classname of classes) {
-        if (!element.classList.contains(classname)) {
-            element.classList.add(classname);
-        }
-    }
-};
-export const toggleClass = (element, className, isToggled) => {
-    const hasClass = element.classList.contains(className);
-    if (isToggled && !hasClass) {
-        element.classList.add(className);
-    }
-    if (!isToggled && hasClass) {
-        element.classList.remove(className);
-    }
-};
-export function isAncestor(testChild, testAncestor) {
-    while (testChild) {
-        if (testChild === testAncestor) {
-            return true;
-        }
-        testChild = testChild.parentNode;
-    }
-    return false;
-}
-export function getElementsByTagName(tag) {
-    return Array.prototype.slice.call(document.getElementsByTagName(tag), 0);
-}
-export function trackFocus(element) {
-    return new FocusTracker(element);
-}
-/**
- * Track focus on an element. Ensure tabIndex is set when an HTMLElement is not focusable by default
- */
-class FocusTracker extends CompositeDisposable {
-    constructor(element) {
-        super();
-        this._onDidFocus = new Emitter();
-        this.onDidFocus = this._onDidFocus.event;
-        this._onDidBlur = new Emitter();
-        this.onDidBlur = this._onDidBlur.event;
-        let hasFocus = isAncestor(document.activeElement, element);
-        let loosingFocus = false;
-        const onFocus = () => {
-            loosingFocus = false;
-            if (!hasFocus) {
-                hasFocus = true;
-                this._onDidFocus.fire();
-            }
-        };
-        const onBlur = () => {
-            if (hasFocus) {
-                loosingFocus = true;
-                window.setTimeout(() => {
-                    if (loosingFocus) {
-                        loosingFocus = false;
-                        hasFocus = false;
-                        this._onDidBlur.fire();
-                    }
-                }, 0);
-            }
-        };
-        this._refreshStateHandler = () => {
-            const currentNodeHasFocus = isAncestor(document.activeElement, element);
-            if (currentNodeHasFocus !== hasFocus) {
-                if (hasFocus) {
-                    onBlur();
-                }
-                else {
-                    onFocus();
-                }
-            }
-        };
-        if (element instanceof HTMLElement) {
-            this.addDisposables(addDisposableListener(element, 'focus', onFocus, true));
-            this.addDisposables(addDisposableListener(element, 'blur', onBlur, true));
-        }
-        else {
-            this.addDisposables(addDisposableWindowListener(element, 'focus', onFocus, true));
-            this.addDisposables(addDisposableWindowListener(element, 'blur', onBlur, true));
-        }
-    }
-    refreshState() {
-        this._refreshStateHandler();
-    }
-    dispose() {
-        super.dispose();
-        this._onDidBlur.dispose();
-        this._onDidFocus.dispose();
-    }
-}

package/dist/esm/events.d.ts

@@ -1,30 +0,0 @@
-import { IDisposable } from './lifecycle';
-export interface Event<T> {
-    (listener: (e: T) => any): IDisposable;
-}
-export interface EmitterOptions {
-    replay?: boolean;
-}
-export declare namespace Event {
-    const any: <T>(...children: Event<T>[]) => Event<T>;
-}
-export declare class Emitter<T> implements IDisposable {
-    private readonly options?;
-    private _event?;
-    private _last?;
-    private _listeners;
-    private _disposed;
-    constructor(options?: EmitterOptions | undefined);
-    get event(): Event<T>;
-    fire(e: T): void;
-    dispose(): void;
-}
-export declare function addDisposableWindowListener<K extends keyof WindowEventMap>(element: Window, type: K, listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions): IDisposable;
-export declare function addDisposableListener<K extends keyof HTMLElementEventMap>(element: HTMLElement, type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): IDisposable;
-export declare class TickDelayedEvent implements IDisposable {
-    private timer;
-    private readonly _onFired;
-    readonly onEvent: Event<void>;
-    fire(): void;
-    dispose(): void;
-}

package/dist/esm/events.js

@@ -1,88 +0,0 @@
-export var Event;
-(function (Event) {
-    Event.any = (...children) => {
-        return (listener) => {
-            const disposables = children.map((child) => child(listener));
-            return {
-                dispose: () => {
-                    disposables.forEach((d) => {
-                        d.dispose();
-                    });
-                },
-            };
-        };
-    };
-})(Event || (Event = {}));
-// dumb event emitter with better typings than nodes event emitter
-// https://github.com/microsoft/vscode/blob/master/src/vs/base/common/event.ts
-export class Emitter {
-    constructor(options) {
-        this.options = options;
-        this._listeners = [];
-        this._disposed = false;
-    }
-    get event() {
-        if (!this._event) {
-            this._event = (listener) => {
-                var _a;
-                if (((_a = this.options) === null || _a === void 0 ? void 0 : _a.replay) && this._last !== undefined) {
-                    listener(this._last);
-                }
-                this._listeners.push(listener);
-                return {
-                    dispose: () => {
-                        const index = this._listeners.indexOf(listener);
-                        if (index > -1) {
-                            this._listeners.splice(index, 1);
-                        }
-                    },
-                };
-            };
-        }
-        return this._event;
-    }
-    fire(e) {
-        this._last = e;
-        for (const listener of this._listeners) {
-            listener(e);
-        }
-    }
-    dispose() {
-        this._listeners = [];
-        this._disposed = true;
-    }
-}
-export function addDisposableWindowListener(element, type, listener, options) {
-    element.addEventListener(type, listener, options);
-    return {
-        dispose: () => {
-            element.removeEventListener(type, listener);
-        },
-    };
-}
-export function addDisposableListener(element, type, listener, options) {
-    element.addEventListener(type, listener, options);
-    return {
-        dispose: () => {
-            element.removeEventListener(type, listener);
-        },
-    };
-}
-export class TickDelayedEvent {
-    constructor() {
-        this._onFired = new Emitter();
-        this.onEvent = this._onFired.event;
-    }
-    fire() {
-        if (this.timer) {
-            clearTimeout(this.timer);
-        }
-        this.timer = setTimeout(() => {
-            this._onFired.fire();
-            clearTimeout(this.timer);
-        });
-    }
-    dispose() {
-        this._onFired.dispose();
-    }
-}

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

@@ -1,87 +0,0 @@
-import { Emitter, Event, TickDelayedEvent } from '../events';
-import { Gridview, IGridView } from './gridview';
-import { Position } from '../dnd/droptarget';
-import { CompositeDisposable, IValueDisposable } from '../lifecycle';
-import { ISplitviewStyles, Orientation } from '../splitview/core/splitview';
-import { IPanel } from '../panel/types';
-import { MovementOptions2 } from '../dockview/options';
-export type Direction = 'left' | 'right' | 'above' | 'below' | 'within';
-export declare function toTarget(direction: Direction): Position;
-export interface BaseGridOptions {
-    readonly proportionalLayout: boolean;
-    readonly orientation: Orientation;
-    readonly styles?: ISplitviewStyles;
-}
-export interface IGridPanelView extends IGridView, IPanel {
-    setActive(isActive: boolean): void;
-    readonly isActive: boolean;
-}
-export interface IBaseGrid<T extends IGridPanelView> {
-    readonly element: HTMLElement;
-    readonly id: string;
-    readonly width: number;
-    readonly height: number;
-    readonly minimumHeight: number;
-    readonly maximumHeight: number;
-    readonly minimumWidth: number;
-    readonly maximumWidth: number;
-    readonly activeGroup: T | undefined;
-    readonly size: number;
-    readonly groups: T[];
-    readonly onDidLayoutChange: Event<void>;
-    readonly onDidRemoveGroup: Event<T>;
-    readonly onDidAddGroup: Event<T>;
-    readonly onDidActiveGroupChange: Event<T | undefined>;
-    getPanel(id: string): T | undefined;
-    toJSON(): object;
-    fromJSON(data: any): void;
-    clear(): void;
-    layout(width: number, height: number, force?: boolean): void;
-    setVisible(panel: T, visible: boolean): void;
-    isVisible(panel: T): boolean;
-}
-export declare abstract class BaseGrid<T extends IGridPanelView> extends CompositeDisposable implements IBaseGrid<T> {
-    private readonly _element;
-    private readonly _id;
-    protected readonly _groups: Map<string, IValueDisposable<T>>;
-    protected readonly gridview: Gridview;
-    protected _activeGroup: T | undefined;
-    private _onDidLayoutChange;
-    readonly onDidLayoutChange: Event<void>;
-    private readonly _onDidRemoveGroup;
-    readonly onDidRemoveGroup: Event<T>;
-    protected readonly _onDidAddGroup: Emitter<T>;
-    readonly onDidAddGroup: Event<T>;
-    private readonly _onDidActiveGroupChange;
-    readonly onDidActiveGroupChange: Event<T | undefined>;
-    protected readonly _bufferOnDidLayoutChange: TickDelayedEvent;
-    get id(): string;
-    get element(): HTMLElement;
-    get size(): number;
-    get groups(): T[];
-    get width(): number;
-    get height(): number;
-    get minimumHeight(): number;
-    get maximumHeight(): number;
-    get minimumWidth(): number;
-    get maximumWidth(): number;
-    get activeGroup(): T | undefined;
-    constructor(_element: HTMLElement, options: BaseGridOptions);
-    abstract toJSON(): object;
-    abstract fromJSON(data: any): void;
-    abstract clear(): void;
-    setVisible(panel: T, visible: boolean): void;
-    isVisible(panel: T): boolean;
-    protected doAddGroup(group: T, location?: number[], size?: number): void;
-    protected doRemoveGroup(group: T, options?: {
-        skipActive?: boolean;
-        skipDispose?: boolean;
-    }): T;
-    getPanel(id: string): T | undefined;
-    doSetGroupActive(group: T | undefined, skipFocus?: boolean): void;
-    removeGroup(group: T): void;
-    moveToNext(options?: MovementOptions2): void;
-    moveToPrevious(options?: MovementOptions2): void;
-    layout(width: number, height: number, forceResize?: boolean): void;
-    dispose(): void;
-}