dockview-core 1.11.0 → 1.13.0

package/dist/esm/dockview/dockviewGroupPanelModel.js

@@ -5,6 +5,7 @@ import { addDisposableListener, DockviewEvent, Emitter, } from '../events';
 import { CompositeDisposable } from '../lifecycle';
 import { ContentContainer, } from './components/panel/content';
 import { TabsContainer, } from './components/titlebar/tabsContainer';
+import { DockviewUnhandledDragOverEvent, } from './options';
 export class DockviewDidDropEvent extends DockviewEvent {
     get nativeEvent() {
         return this.options.nativeEvent;
@@ -40,7 +41,7 @@ export class DockviewWillDropEvent extends DockviewDidDropEvent {
 }
 export class WillShowOverlayLocationEvent {
     get kind() {
-        return this._kind;
+        return this.options.kind;
     }
     get nativeEvent() {
         return this.event.nativeEvent;
@@ -51,12 +52,24 @@ export class WillShowOverlayLocationEvent {
     get defaultPrevented() {
         return this.event.defaultPrevented;
     }
+    get panel() {
+        return this.options.panel;
+    }
+    get api() {
+        return this.options.api;
+    }
+    get group() {
+        return this.options.group;
+    }
     preventDefault() {
         this.event.preventDefault();
     }
+    getData() {
+        return this.options.getData();
+    }
     constructor(event, options) {
         this.event = event;
-        this._kind = options.kind;
+        this.options = options;
     }
 }
 export class DockviewGroupPanelModel extends CompositeDisposable {
@@ -170,6 +183,8 @@ export class DockviewGroupPanelModel extends CompositeDisposable {
         this.onDidRemovePanel = this._onDidRemovePanel.event;
         this._onDidActivePanelChange = new Emitter();
         this.onDidActivePanelChange = this._onDidActivePanelChange.event;
+        this._onUnhandledDragOverEvent = new Emitter();
+        this.onUnhandledDragOverEvent = this._onUnhandledDragOverEvent.event;
         this._overwriteRenderContainer = null;
         toggleClass(this.container, 'groupview', true);
         this._api = new DockviewApi(this.accessor);
@@ -195,8 +210,12 @@ export class DockviewGroupPanelModel extends CompositeDisposable {
         }), this.contentContainer.dropTarget.onWillShowOverlay((event) => {
             this._onWillShowOverlay.fire(new WillShowOverlayLocationEvent(event, {
                 kind: 'content',
+                panel: this.activePanel,
+                api: this._api,
+                group: this.groupPanel,
+                getData: getPanelData,
             }));
-        }), this._onMove, this._onDidChange, this._onDidDrop, this._onWillDrop, this._onDidAddPanel, this._onDidRemovePanel, this._onDidActivePanelChange);
+        }), this._onMove, this._onDidChange, this._onDidDrop, this._onWillDrop, this._onDidAddPanel, this._onDidRemovePanel, this._onDidActivePanelChange, this._onUnhandledDragOverEvent);
     }
     focusContent() {
         this.contentContainer.element.focus();
@@ -227,33 +246,36 @@ export class DockviewGroupPanelModel extends CompositeDisposable {
         // correctly initialized
         this.setActive(this.isActive, true);
         this.updateContainer();
-        if (this.accessor.options.createRightHeaderActionsElement) {
+        if (this.accessor.options.createRightHeaderActionComponent) {
             this._rightHeaderActions =
-                this.accessor.options.createRightHeaderActionsElement(this.groupPanel);
+                this.accessor.options.createRightHeaderActionComponent(this.groupPanel);
             this.addDisposables(this._rightHeaderActions);
             this._rightHeaderActions.init({
                 containerApi: this._api,
                 api: this.groupPanel.api,
+                group: this.groupPanel,
             });
             this.tabsContainer.setRightActionsElement(this._rightHeaderActions.element);
         }
-        if (this.accessor.options.createLeftHeaderActionsElement) {
+        if (this.accessor.options.createLeftHeaderActionComponent) {
             this._leftHeaderActions =
-                this.accessor.options.createLeftHeaderActionsElement(this.groupPanel);
+                this.accessor.options.createLeftHeaderActionComponent(this.groupPanel);
             this.addDisposables(this._leftHeaderActions);
             this._leftHeaderActions.init({
                 containerApi: this._api,
                 api: this.groupPanel.api,
+                group: this.groupPanel,
             });
             this.tabsContainer.setLeftActionsElement(this._leftHeaderActions.element);
         }
-        if (this.accessor.options.createPrefixHeaderActionsElement) {
+        if (this.accessor.options.createPrefixHeaderActionComponent) {
             this._prefixHeaderActions =
-                this.accessor.options.createPrefixHeaderActionsElement(this.groupPanel);
+                this.accessor.options.createPrefixHeaderActionComponent(this.groupPanel);
             this.addDisposables(this._prefixHeaderActions);
             this._prefixHeaderActions.init({
                 containerApi: this._api,
                 api: this.groupPanel.api,
+                group: this.groupPanel,
             });
             this.tabsContainer.setPrefixActionsElement(this._prefixHeaderActions.element);
         }
@@ -452,7 +474,8 @@ export class DockviewGroupPanelModel extends CompositeDisposable {
         this.tabsContainer.delete(panel.id);
         this._panels.splice(index, 1);
         if (this.mostRecentlyUsed.includes(panel)) {
-            this.mostRecentlyUsed.splice(this.mostRecentlyUsed.indexOf(panel), 1);
+            const index = this.mostRecentlyUsed.indexOf(panel);
+            this.mostRecentlyUsed.splice(index, 1);
         }
         const disposable = this._panelDisposables.get(panel.id);
         if (disposable) {
@@ -527,17 +550,9 @@ export class DockviewGroupPanelModel extends CompositeDisposable {
         }
     }
     canDisplayOverlay(event, position, target) {
-        // custom overlay handler
-        if (this.accessor.options.showDndOverlay) {
-            return this.accessor.options.showDndOverlay({
-                nativeEvent: event,
-                target,
-                group: this.accessor.getPanel(this.id),
-                position,
-                getData: getPanelData,
-            });
-        }
-        return false;
+        const firedEvent = new DockviewUnhandledDragOverEvent(event, target, position, getPanelData, this.accessor.getPanel(this.id));
+        this._onUnhandledDragOverEvent.fire(firedEvent);
+        return firedEvent.isAccepted;
     }
     handleDropEvent(type, event, position, index) {
         if (this.locked === 'no-drop-target') {

package/dist/esm/dockview/dockviewPanelModel.js

@@ -1,5 +1,4 @@
 import { DefaultTab } from './components/tab/defaultTab';
-import { createComponent } from '../panel/componentFactory';
 export class DockviewPanelModel {
     get content() {
         return this._content;
@@ -16,7 +15,7 @@ export class DockviewPanelModel {
         this._tab = this.createTabComponent(this.id, tabComponent);
     }
     init(params) {
-        this.content.init(Object.assign(Object.assign({}, params), { tab: this.tab }));
+        this.content.init(params);
         this.tab.init(params);
     }
     updateParentGroup(_group, _isPanelVisible) {
@@ -37,19 +36,28 @@ export class DockviewPanelModel {
         (_d = (_c = this.tab).dispose) === null || _d === void 0 ? void 0 : _d.call(_c);
     }
     createContentComponent(id, componentName) {
-        var _a, _b;
-        return createComponent(id, componentName, (_a = this.accessor.options.components) !== null && _a !== void 0 ? _a : {}, this.accessor.options.frameworkComponents, (_b = this.accessor.options.frameworkComponentFactory) === null || _b === void 0 ? void 0 : _b.content);
+        return this.accessor.options.createComponent({
+            id,
+            name: componentName,
+        });
     }
     createTabComponent(id, componentName) {
-        var _a, _b;
-        if (componentName) {
-            return createComponent(id, componentName, this.accessor.options.tabComponents, this.accessor.options.frameworkTabComponents, (_a = this.accessor.options.frameworkComponentFactory) === null || _a === void 0 ? void 0 : _a.tab, () => new DefaultTab());
-        }
-        else if (this.accessor.options.defaultTabComponent) {
-            return createComponent(id, this.accessor.options.defaultTabComponent, this.accessor.options.tabComponents, this.accessor.options.frameworkTabComponents, (_b = this.accessor.options.frameworkComponentFactory) === null || _b === void 0 ? void 0 : _b.tab, () => new DefaultTab());
-        }
-        else {
-            return new DefaultTab();
+        const name = componentName !== null && componentName !== void 0 ? componentName : this.accessor.options.defaultTabComponent;
+        if (name) {
+            if (this.accessor.options.createTabComponent) {
+                const component = this.accessor.options.createTabComponent({
+                    id,
+                    name,
+                });
+                if (component) {
+                    return component;
+                }
+                else {
+                    return new DefaultTab();
+                }
+            }
+            console.warn(`dockview: tabComponent '${componentName}' was not found. falling back to the default tab.`);
         }
+        return new DefaultTab();
     }
 }

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

@@ -0,0 +1,38 @@
+import { DockviewApi } from '../api/component.api';
+import { DockviewGroupPanelApi } from '../api/dockviewGroupPanelApi';
+import { DockviewPanelApi } from '../api/dockviewPanelApi';
+import { PanelParameters } from '../framwork';
+import { DockviewGroupPanel, IDockviewGroupPanel } from './dockviewGroupPanel';
+import { IDockviewPanel } from './dockviewPanel';
+export interface IGroupPanelBaseProps<T extends {
+    [index: string]: any;
+} = any> extends PanelParameters<T> {
+    api: DockviewPanelApi;
+    containerApi: DockviewApi;
+}
+export type IDockviewPanelHeaderProps<T extends {
+    [index: string]: any;
+} = any> = IGroupPanelBaseProps<T>;
+export type IDockviewPanelProps<T extends {
+    [index: string]: any;
+} = any> = IGroupPanelBaseProps<T>;
+export interface IDockviewHeaderActionsProps {
+    api: DockviewGroupPanelApi;
+    containerApi: DockviewApi;
+    panels: IDockviewPanel[];
+    activePanel: IDockviewPanel | undefined;
+    isGroupActive: boolean;
+    group: DockviewGroupPanel;
+}
+export interface IGroupHeaderProps {
+    api: DockviewGroupPanelApi;
+    containerApi: DockviewApi;
+    group: IDockviewGroupPanel;
+}
+export interface IWatermarkPanelProps {
+    containerApi: DockviewApi;
+    group?: IDockviewGroupPanel;
+}
+export interface DockviewReadyEvent {
+    api: DockviewApi;
+}

package/dist/esm/dockview/framework.js

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

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

@@ -1,74 +1,33 @@
 import { DockviewApi } from '../api/component.api';
 import { Direction } from '../gridview/baseComponentGridview';
 import { IGridView } from '../gridview/gridview';
-import { IContentRenderer, ITabRenderer, WatermarkConstructor, IWatermarkRenderer } from './types';
+import { IContentRenderer, ITabRenderer, IWatermarkRenderer } from './types';
 import { Parameters } from '../panel/types';
 import { DockviewGroupPanel } from './dockviewGroupPanel';
-import { ISplitviewStyles, Orientation } from '../splitview/splitview';
 import { PanelTransfer } from '../dnd/dataTransfer';
 import { IDisposable } from '../lifecycle';
 import { DroptargetOverlayModel, Position } from '../dnd/droptarget';
 import { DockviewGroupDropLocation, GroupOptions } from './dockviewGroupPanelModel';
 import { IDockviewPanel } from './dockviewPanel';
-import { ComponentConstructor, FrameworkFactory } from '../panel/componentFactory';
-import { DockviewGroupPanelApi } from '../api/dockviewGroupPanelApi';
 import { DockviewPanelRenderer } from '../overlayRenderContainer';
+import { IGroupHeaderProps } from './framework';
 export interface IHeaderActionsRenderer extends IDisposable {
     readonly element: HTMLElement;
-    init(params: {
-        containerApi: DockviewApi;
-        api: DockviewGroupPanelApi;
-    }): void;
-}
-export interface GroupPanelFrameworkComponentFactory {
-    content: FrameworkFactory<IContentRenderer>;
-    tab: FrameworkFactory<ITabRenderer>;
-    watermark: FrameworkFactory<IWatermarkRenderer>;
+    init(params: IGroupHeaderProps): void;
 }
 export interface TabContextMenuEvent {
     event: MouseEvent;
     api: DockviewApi;
     panel: IDockviewPanel;
 }
-export interface DockviewRenderFunctions {
-    tabComponents?: {
-        [componentName: string]: ComponentConstructor<ITabRenderer>;
-    };
-    components?: {
-        [componentName: string]: ComponentConstructor<IContentRenderer>;
-    };
-    frameworkTabComponents?: {
-        [componentName: string]: any;
-    };
-    frameworkComponents?: {
-        [componentName: string]: any;
-    };
-}
 export interface ViewFactoryData {
     content: string;
     tab?: string;
 }
-export interface DockviewDndOverlayEvent {
-    nativeEvent: DragEvent;
-    target: DockviewGroupDropLocation;
-    position: Position;
-    group?: DockviewGroupPanel;
-    getData: () => PanelTransfer | undefined;
-}
-export interface DockviewComponentOptions extends DockviewRenderFunctions {
+export interface DockviewOptions {
     disableAutoResizing?: boolean;
-    watermarkComponent?: WatermarkConstructor;
-    watermarkFrameworkComponent?: any;
-    frameworkComponentFactory?: GroupPanelFrameworkComponentFactory;
-    orientation?: Orientation;
-    styles?: ISplitviewStyles;
-    defaultTabComponent?: string;
-    showDndOverlay?: (event: DockviewDndOverlayEvent) => boolean;
-    createRightHeaderActionsElement?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
-    createLeftHeaderActionsElement?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
-    createPrefixHeaderActionsElement?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
+    hideBorders?: boolean;
     singleTabMode?: 'fullwidth' | 'default';
-    parentElement: HTMLElement;
     disableFloatingGroups?: boolean;
     floatingGroupBounds?: 'boundedWithinViewport' | {
         minimumHeightWithinViewport?: number;
@@ -81,6 +40,44 @@ export interface DockviewComponentOptions extends DockviewRenderFunctions {
     locked?: boolean;
     disableDnd?: boolean;
 }
+export interface DockviewDndOverlayEvent {
+    nativeEvent: DragEvent;
+    target: DockviewGroupDropLocation;
+    position: Position;
+    group?: DockviewGroupPanel;
+    getData: () => PanelTransfer | undefined;
+    isAccepted: boolean;
+    accept(): void;
+}
+export declare class DockviewUnhandledDragOverEvent implements DockviewDndOverlayEvent {
+    readonly nativeEvent: DragEvent;
+    readonly target: DockviewGroupDropLocation;
+    readonly position: Position;
+    readonly getData: () => PanelTransfer | undefined;
+    readonly group?: DockviewGroupPanel | undefined;
+    private _isAccepted;
+    get isAccepted(): boolean;
+    constructor(nativeEvent: DragEvent, target: DockviewGroupDropLocation, position: Position, getData: () => PanelTransfer | undefined, group?: DockviewGroupPanel | undefined);
+    accept(): void;
+}
+export declare const PROPERTY_KEYS: (keyof DockviewOptions)[];
+export interface DockviewFrameworkOptions {
+    parentElement: HTMLElement;
+    defaultTabComponent?: string;
+    createRightHeaderActionComponent?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
+    createLeftHeaderActionComponent?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
+    createPrefixHeaderActionComponent?: (group: DockviewGroupPanel) => IHeaderActionsRenderer;
+    createTabComponent?: (options: {
+        id: string;
+        name: string;
+    }) => ITabRenderer | undefined;
+    createComponent: (options: {
+        id: string;
+        name: string;
+    }) => IContentRenderer;
+    createWatermarkComponent?: () => IWatermarkRenderer;
+}
+export type DockviewComponentOptions = DockviewOptions & DockviewFrameworkOptions;
 export interface PanelOptions<P extends object = Parameters> {
     component: string;
     tabComponent?: string;
@@ -118,11 +115,36 @@ type AddPanelPositionUnion = {
 type AddPanelOptionsUnion = AddPanelFloatingGroupUnion | AddPanelPositionUnion;
 export type AddPanelOptions<P extends object = Parameters> = {
     params?: P;
+    /**
+     * The unique id for the panel
+     */
     id: string;
+    /**
+     * The title for the panel which can be accessed within both the tab and component.
+     *
+     * If using the default tab renderer this title will be displayed in the tab.
+     */
     title?: string;
+    /**
+     * The id of the component renderer
+     */
     component: string;
+    /**
+     * The id of the tab componnet renderer
+     */
     tabComponent?: string;
+    /**
+     * The rendering mode of the panel.
+     *
+     * This dictates what happens to the HTML of the panel when it is hidden.
+     */
     renderer?: DockviewPanelRenderer;
+    /**
+     * If true then add the panel without setting it as the active panel.
+     *
+     * Defaults to `false` which forces newly added panels to become active.
+     */
+    inactive?: boolean;
 } & Partial<AddPanelOptionsUnion>;
 type AddGroupOptionsWithPanel = {
     referencePanel: string | IDockviewPanel;

package/dist/esm/dockview/options.js

@@ -1,3 +1,39 @@
+export class DockviewUnhandledDragOverEvent {
+    get isAccepted() {
+        return this._isAccepted;
+    }
+    constructor(nativeEvent, target, position, getData, group) {
+        this.nativeEvent = nativeEvent;
+        this.target = target;
+        this.position = position;
+        this.getData = getData;
+        this.group = group;
+        this._isAccepted = false;
+    }
+    accept() {
+        this._isAccepted = true;
+    }
+}
+export const PROPERTY_KEYS = (() => {
+    /**
+     * by readong the keys from an empty value object TypeScript will error
+     * when we add or remove new properties to `DockviewOptions`
+     */
+    const properties = {
+        disableAutoResizing: undefined,
+        hideBorders: undefined,
+        singleTabMode: undefined,
+        disableFloatingGroups: undefined,
+        floatingGroupBounds: undefined,
+        popoutUrl: undefined,
+        defaultRenderer: undefined,
+        debug: undefined,
+        rootOverlayModel: undefined,
+        locked: undefined,
+        disableDnd: undefined,
+    };
+    return Object.keys(properties);
+})();
 export function isPanelOptionsWithPanel(data) {
     if (data.referencePanel) {
         return true;

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

@@ -2,7 +2,6 @@ import { IDockviewComponent } from './dockviewComponent';
 import { DockviewPanelApi } from '../api/dockviewPanelApi';
 import { PanelInitParameters, IPanel } from '../panel/types';
 import { DockviewApi } from '../api/component.api';
-import { Event } from '../events';
 import { Optional } from '../types';
 import { DockviewGroupPanel, IDockviewGroupPanel } from './dockviewGroupPanel';
 import { DockviewPanelRenderer } from '../overlayRenderContainer';
@@ -13,27 +12,22 @@ export interface GroupPanelPartInitParameters extends PanelInitParameters, Heade
     api: DockviewPanelApi;
     containerApi: DockviewApi;
 }
-export interface GroupPanelContentPartInitParameters extends GroupPanelPartInitParameters {
-    tab: ITabRenderer;
-}
 export interface WatermarkRendererInitParameters {
     containerApi: DockviewApi;
     group?: IDockviewGroupPanel;
 }
-export interface IWatermarkRenderer extends Optional<Omit<IPanel, 'id' | 'init'>, 'dispose' | 'update' | 'layout' | 'toJSON'> {
+export interface IWatermarkRenderer extends Optional<Omit<IPanel, 'id' | 'init'>, 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus'> {
     readonly element: HTMLElement;
     init: (params: WatermarkRendererInitParameters) => void;
     updateParentGroup(group: DockviewGroupPanel, visible: boolean): void;
 }
-export interface ITabRenderer extends Optional<Omit<IPanel, 'id'>, 'dispose' | 'update' | 'layout' | 'toJSON'> {
+export interface ITabRenderer extends Optional<Omit<IPanel, 'id'>, 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus'> {
     readonly element: HTMLElement;
     init(parameters: GroupPanelPartInitParameters): void;
 }
-export interface IContentRenderer extends Optional<Omit<IPanel, 'id'>, 'dispose' | 'update' | 'layout' | 'toJSON'> {
+export interface IContentRenderer extends Optional<Omit<IPanel, 'id'>, 'dispose' | 'update' | 'layout' | 'toJSON' | 'focus'> {
     readonly element: HTMLElement;
-    readonly onDidFocus?: Event<void>;
-    readonly onDidBlur?: Event<void>;
-    init(parameters: GroupPanelContentPartInitParameters): void;
+    init(parameters: GroupPanelPartInitParameters): void;
 }
 export interface WatermarkPartInitParameters {
     accessor: IDockviewComponent;

package/dist/esm/framwork.d.ts

@@ -0,0 +1,4 @@
+import { Parameters } from "./panel/types";
+export interface PanelParameters<T extends {} = Parameters> {
+    params: T;
+}

package/dist/esm/framwork.js

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

package/dist/esm/index.d.ts

@@ -12,14 +12,15 @@ export { SplitviewComponentOptions, PanelViewInitParameters, } from './splitview
 export * from './paneview/paneview';
 export * from './gridview/gridview';
 export { GridviewComponentOptions } from './gridview/options';
-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/dockviewGroupPanelModel';
 export { TabDragEvent, GroupDragEvent, } from './dockview/components/titlebar/tabsContainer';
 export * from './dockview/types';
 export * from './dockview/dockviewGroupPanel';
+export { IGroupPanelBaseProps, IDockviewPanelHeaderProps, IDockviewPanelProps, IDockviewHeaderActionsProps, IGroupHeaderProps, IWatermarkPanelProps, DockviewReadyEvent, } from './dockview/framework';
 export * from './dockview/options';
 export * from './dockview/dockviewPanel';
 export * from './dockview/components/tab/defaultTab';

package/dist/esm/index.js

@@ -10,11 +10,11 @@ export * from './panel/componentFactory';
 export * from './splitview/splitview';
 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/dockviewGroupPanelModel';
 export * from './dockview/types';
 export * from './dockview/dockviewGroupPanel';
 export * from './dockview/options';

package/dist/esm/overlayRenderContainer.d.ts

@@ -1,7 +1,7 @@
 import { Droptarget } from './dnd/droptarget';
 import { CompositeDisposable } from './lifecycle';
 import { IDockviewPanel } from './dockview/dockviewPanel';
-export type DockviewPanelRenderer = 'onlyWhenVisibile' | 'always';
+export type DockviewPanelRenderer = 'onlyWhenVisible' | 'always';
 export interface IRenderable {
     readonly element: HTMLElement;
     readonly dropTarget: Droptarget;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dockview-core",
-  "version": "1.11.0",
-  "description": "Zero dependency layout manager supporting tabs, grids and splitviews with ReactJS support",
+  "version": "1.13.0",
+  "description": "Zero dependency layout manager supporting tabs, grids and splitviews",
   "keywords": [
     "splitview",
     "split-view",