dockview-core 1.9.2 → 1.10.0

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

@@ -1,13 +1,12 @@
 import { SerializedGridObject } from '../gridview/gridview';
 import { Position } from '../dnd/droptarget';
 import { DockviewPanel, IDockviewPanel } from './dockviewPanel';
-import { Event } from '../events';
+import { Event, Emitter } from '../events';
 import { IWatermarkRenderer, GroupviewPanelState } from './types';
 import { AddGroupOptions, AddPanelOptions, DockviewComponentOptions, MovementOptions } from './options';
 import { BaseGrid, IBaseGrid } from '../gridview/baseComponentGridview';
-import { DockviewApi } from '../api/component.api';
 import { Orientation } from '../splitview/splitview';
-import { GroupOptions, GroupPanelViewState, GroupviewDropEvent } from './dockviewGroupPanelModel';
+import { GroupOptions, GroupPanelViewState, DockviewDidDropEvent, DockviewWillDropEvent, WillShowOverlayLocationEvent } from './dockviewGroupPanelModel';
 import { DockviewGroupPanel } from './dockviewGroupPanel';
 import { Parameters } from '../panel/types';
 import { GroupDragEvent, TabDragEvent } from './components/titlebar/tabsContainer';
@@ -27,6 +26,7 @@ export interface SerializedFloatingGroup {
 }
 export interface SerializedPopoutGroup {
     data: GroupPanelViewState;
+    gridReferenceGroup?: string;
     position: Box | null;
 }
 export interface SerializedDockview {
@@ -41,22 +41,50 @@ export interface SerializedDockview {
     floatingGroups?: SerializedFloatingGroup[];
     popoutGroups?: SerializedPopoutGroup[];
 }
-export type DockviewComponentUpdateOptions = Pick<DockviewComponentOptions, 'orientation' | 'components' | 'frameworkComponents' | 'tabComponents' | 'frameworkTabComponents' | 'showDndOverlay' | 'watermarkFrameworkComponent' | 'defaultTabComponent' | 'createLeftHeaderActionsElement' | 'createRightHeaderActionsElement' | 'createPrefixHeaderActionsElement' | 'disableFloatingGroups' | 'floatingGroupBounds' | 'rootOverlayModel'>;
-export interface DockviewDropEvent extends GroupviewDropEvent {
-    api: DockviewApi;
-    group: DockviewGroupPanel | null;
-}
+export type DockviewComponentUpdateOptions = Pick<DockviewComponentOptions, 'orientation' | 'components' | 'frameworkComponents' | 'tabComponents' | 'frameworkTabComponents' | 'showDndOverlay' | 'watermarkFrameworkComponent' | 'defaultTabComponent' | 'createLeftHeaderActionsElement' | 'createRightHeaderActionsElement' | 'createPrefixHeaderActionsElement' | 'disableFloatingGroups' | 'floatingGroupBounds' | 'rootOverlayModel' | 'disableDnd'>;
+type MoveGroupOptions = {
+    from: {
+        group: DockviewGroupPanel;
+    };
+    to: {
+        group: DockviewGroupPanel;
+        position: Position;
+    };
+};
+type MoveGroupOrPanelOptions = {
+    from: {
+        groupId: string;
+        panelId?: string;
+    };
+    to: {
+        group: DockviewGroupPanel;
+        position: Position;
+        index?: number;
+    };
+};
 export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     readonly activePanel: IDockviewPanel | undefined;
     readonly totalPanels: number;
     readonly panels: IDockviewPanel[];
-    readonly onDidDrop: Event<DockviewDropEvent>;
     readonly orientation: Orientation;
+    readonly onDidDrop: Event<DockviewDidDropEvent>;
+    readonly onWillDrop: Event<DockviewWillDropEvent>;
+    readonly onWillShowOverlay: Event<WillShowOverlayLocationEvent>;
+    readonly onDidRemovePanel: Event<IDockviewPanel>;
+    readonly onDidAddPanel: Event<IDockviewPanel>;
+    readonly onDidLayoutFromJSON: Event<void>;
+    readonly onDidActivePanelChange: Event<IDockviewPanel | undefined>;
+    readonly onWillDragPanel: Event<TabDragEvent>;
+    readonly onWillDragGroup: Event<GroupDragEvent>;
+    readonly onDidRemoveGroup: Event<DockviewGroupPanel>;
+    readonly onDidAddGroup: Event<DockviewGroupPanel>;
+    readonly onDidActiveGroupChange: Event<DockviewGroupPanel | undefined>;
+    readonly options: DockviewComponentOptions;
     updateOptions(options: DockviewComponentUpdateOptions): void;
-    moveGroupOrPanel(referenceGroup: DockviewGroupPanel, groupId: string, itemId: string, target: Position, index?: number): void;
+    moveGroupOrPanel(options: MoveGroupOrPanelOptions): void;
+    moveGroup(options: MoveGroupOptions): void;
     doSetGroupActive: (group: DockviewGroupPanel, skipFocus?: boolean) => void;
     removeGroup: (group: DockviewGroupPanel) => void;
-    options: DockviewComponentOptions;
     addPanel<T extends object = Parameters>(options: AddPanelOptions<T>): IDockviewPanel;
     removePanel(panel: IDockviewPanel): void;
     getGroupPanel: (id: string) => IDockviewPanel | undefined;
@@ -69,12 +97,6 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     focus(): void;
     toJSON(): SerializedDockview;
     fromJSON(data: SerializedDockview): void;
-    readonly onDidRemovePanel: Event<IDockviewPanel>;
-    readonly onDidAddPanel: Event<IDockviewPanel>;
-    readonly onDidLayoutFromJSON: Event<void>;
-    readonly onDidActivePanelChange: Event<IDockviewPanel | undefined>;
-    readonly onWillDragPanel: Event<TabDragEvent>;
-    readonly onWillDragGroup: Event<GroupDragEvent>;
     addFloatingGroup(item: IDockviewPanel | DockviewGroupPanel, coord?: {
         x: number;
         y: number;
@@ -82,7 +104,15 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     addPopoutGroup(item: IDockviewPanel | DockviewGroupPanel, options?: {
         position?: Box;
         popoutUrl?: string;
-    }): void;
+        onDidOpen?: (event: {
+            id: string;
+            window: Window;
+        }) => void;
+        onWillClose?: (event: {
+            id: string;
+            window: Window;
+        }) => void;
+    }): Promise<void>;
 }
 export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> implements IDockviewComponent {
     private readonly nextGroupId;
@@ -96,7 +126,11 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     private readonly _onWillDragGroup;
     readonly onWillDragGroup: Event<GroupDragEvent>;
     private readonly _onDidDrop;
-    readonly onDidDrop: Event<DockviewDropEvent>;
+    readonly onDidDrop: Event<DockviewDidDropEvent>;
+    private readonly _onWillDrop;
+    readonly onWillDrop: Event<DockviewWillDropEvent>;
+    private readonly _onWillShowOverlay;
+    readonly onWillShowOverlay: Event<WillShowOverlayLocationEvent>;
     private readonly _onDidRemovePanel;
     readonly onDidRemovePanel: Event<IDockviewPanel>;
     private readonly _onDidAddPanel;
@@ -105,9 +139,17 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     readonly onDidLayoutFromJSON: Event<void>;
     private readonly _onDidActivePanelChange;
     readonly onDidActivePanelChange: Event<IDockviewPanel | undefined>;
+    private readonly _onDidMovePanel;
     private readonly _floatingGroups;
     private readonly _popoutGroups;
     private readonly _rootDropTarget;
+    private _ignoreEvents;
+    private readonly _onDidRemoveGroup;
+    readonly onDidRemoveGroup: Event<DockviewGroupPanel>;
+    protected readonly _onDidAddGroup: Emitter<DockviewGroupPanel>;
+    readonly onDidAddGroup: Event<DockviewGroupPanel>;
+    private readonly _onDidActiveGroupChange;
+    readonly onDidActiveGroupChange: Event<DockviewGroupPanel | undefined>;
     get orientation(): Orientation;
     get totalPanels(): number;
     get panels(): IDockviewPanel[];
@@ -115,11 +157,20 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     get activePanel(): IDockviewPanel | undefined;
     get renderer(): DockviewPanelRenderer;
     constructor(options: DockviewComponentOptions);
-    addPopoutGroup(item: DockviewPanel | DockviewGroupPanel, options?: {
+    addPopoutGroup(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: {
         skipRemoveGroup?: boolean;
         position?: Box;
         popoutUrl?: string;
-    }): void;
+        onDidOpen?: (event: {
+            id: string;
+            window: Window;
+        }) => void;
+        onWillClose?: (event: {
+            id: string;
+            window: Window;
+        }) => void;
+        overridePopoutGroup?: DockviewGroupPanel;
+    }): Promise<void>;
     addFloatingGroup(item: DockviewPanel | DockviewGroupPanel, coord?: {
         x?: number;
         y?: number;
@@ -128,6 +179,7 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     }, options?: {
         skipRemoveGroup?: boolean;
         inDragMode: boolean;
+        skipActiveGroup?: boolean;
     }): void;
     private orthogonalize;
     updateOptions(options: DockviewComponentUpdateOptions): void;
@@ -150,6 +202,7 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     removePanel(panel: IDockviewPanel, options?: {
         removeEmptyGroup: boolean;
         skipDispose: boolean;
+        skipSetActiveGroup?: boolean;
     }): void;
     createWatermarkComponent(): IWatermarkRenderer;
     private updateWatermark;
@@ -157,17 +210,25 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     removeGroup(group: DockviewGroupPanel, options?: {
         skipActive?: boolean;
         skipDispose?: boolean;
+        skipPopoutAssociated?: boolean;
+        skipPopoutReturn?: boolean;
     } | undefined): void;
     protected doRemoveGroup(group: DockviewGroupPanel, options?: {
         skipActive?: boolean;
         skipDispose?: boolean;
+        skipPopoutAssociated?: boolean;
+        skipPopoutReturn?: boolean;
     } | undefined): DockviewGroupPanel;
-    moveGroupOrPanel(destinationGroup: DockviewGroupPanel, sourceGroupId: string, sourceItemId: string | undefined, destinationTarget: Position, destinationIndex?: number): void;
-    private moveGroup;
-    doSetGroupAndPanelActive(group: DockviewGroupPanel | undefined, skipFocus?: boolean): void;
+    private _moving;
+    movingLock<T>(func: () => T): T;
+    moveGroupOrPanel(options: MoveGroupOrPanelOptions): void;
+    moveGroup(options: MoveGroupOptions): void;
+    doSetGroupActive(group: DockviewGroupPanel | undefined): void;
+    doSetGroupAndPanelActive(group: DockviewGroupPanel | undefined): void;
+    private getNextGroupId;
     createGroup(options?: GroupOptions): DockviewGroupPanel;
     private createPanel;
     private createGroupAtLocation;
     private findGroup;
 }
-//# sourceMappingURL=dockviewComponent.d.ts.map
+export {};