dockview-core 5.2.0 → 6.0.0

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

@@ -8,7 +8,7 @@ import { BaseGrid, IBaseGrid } from '../gridview/baseComponentGridview';
 import { DockviewApi } from '../api/component.api';
 import { Orientation } from '../splitview/splitview';
 import { GroupOptions, GroupPanelViewState, DockviewDidDropEvent, DockviewWillDropEvent } from './dockviewGroupPanelModel';
-import { DockviewWillShowOverlayLocationEvent } from './events';
+import { DockviewWillShowOverlayLocationEvent, DockviewTabGroupChangeEvent, DockviewTabGroupCollapsedChangeEvent, DockviewTabGroupPanelChangeEvent } from './events';
 import { DockviewGroupPanel } from './dockviewGroupPanel';
 import { Parameters } from '../panel/types';
 import { DockviewFloatingGroupPanel } from './dockviewFloatingGroupPanel';
@@ -16,7 +16,11 @@ import { GroupDragEvent, TabDragEvent } from './components/titlebar/tabsContaine
 import { AnchoredBox, AnchorPosition, Box } from '../types';
 import { DockviewPanelRenderer, OverlayRenderContainer } from '../overlay/overlayRenderContainer';
 import { PopupService } from './components/popupService';
+import { ContextMenuController } from './contextMenu';
 import { DropTargetAnchorContainer } from '../dnd/dropTargetAnchorContainer';
+import { EdgeGroupPosition, EdgeGroupOptions, SerializedEdgeGroups } from './dockviewShell';
+import { DockviewGroupPanelApi } from '../api/dockviewGroupPanelApi';
+import { TabGroupColorPalette } from './tabGroupAccent';
 export interface DockviewPopoutGroupOptions {
     /**
      * The position of the popout group
@@ -68,6 +72,7 @@ export interface SerializedDockview {
     activeGroup?: string;
     floatingGroups?: SerializedFloatingGroup[];
     popoutGroups?: SerializedPopoutGroup[];
+    edgeGroups?: SerializedEdgeGroups;
 }
 export interface MovePanelEvent {
     panel: IDockviewPanel;
@@ -87,6 +92,7 @@ type MoveGroupOrPanelOptions = {
     from: {
         groupId: string;
         panelId?: string;
+        tabGroupId?: string;
     };
     to: {
         group: DockviewGroupPanel;
@@ -103,7 +109,7 @@ export interface FloatingGroupOptions {
     width?: number;
     position?: AnchorPosition;
 }
-export interface FloatingGroupOptionsInternal extends FloatingGroupOptions {
+interface FloatingGroupOptionsInternal extends FloatingGroupOptions {
     skipRemoveGroup?: boolean;
     inDragMode?: boolean;
     skipActiveGroup?: boolean;
@@ -145,7 +151,14 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     readonly onDidPopoutGroupSizeChange: Event<PopoutGroupChangeSizeEvent>;
     readonly onDidPopoutGroupPositionChange: Event<PopoutGroupChangePositionEvent>;
     readonly onDidOpenPopoutWindowFail: Event<void>;
+    readonly onDidCreateTabGroup: Event<DockviewTabGroupChangeEvent>;
+    readonly onDidDestroyTabGroup: Event<DockviewTabGroupChangeEvent>;
+    readonly onDidAddPanelToTabGroup: Event<DockviewTabGroupPanelChangeEvent>;
+    readonly onDidRemovePanelFromTabGroup: Event<DockviewTabGroupPanelChangeEvent>;
+    readonly onDidTabGroupChange: Event<DockviewTabGroupChangeEvent>;
+    readonly onDidTabGroupCollapsedChange: Event<DockviewTabGroupCollapsedChangeEvent>;
     readonly options: DockviewComponentOptions;
+    readonly tabGroupColorPalette: TabGroupColorPalette;
     updateOptions(options: DockviewOptions): void;
     moveGroupOrPanel(options: MoveGroupOrPanelOptions): void;
     moveGroup(options: MoveGroupOptions): void;
@@ -179,16 +192,24 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     fromJSON(data: any, options?: {
         reuseExistingPanels: boolean;
     }): void;
+    addEdgeGroup(position: EdgeGroupPosition, options: EdgeGroupOptions): DockviewGroupPanelApi;
+    getEdgeGroup(position: EdgeGroupPosition): DockviewGroupPanelApi | undefined;
+    setEdgeGroupVisible(position: EdgeGroupPosition, visible: boolean): void;
+    isEdgeGroupVisible(position: EdgeGroupPosition): boolean;
+    removeEdgeGroup(position: EdgeGroupPosition): void;
 }
 export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> implements IDockviewComponent {
     private readonly nextGroupId;
     private readonly _deserializer;
     private readonly _api;
     private _options;
+    private _tabGroupColorPalette;
     private _watermark;
-    private readonly _themeClassnames;
+    private _shellThemeClassnames;
     readonly overlayRenderContainer: OverlayRenderContainer;
     readonly popupService: PopupService;
+    private readonly _popoutPopupServices;
+    readonly contextMenuController: ContextMenuController;
     readonly rootDropTargetContainer: DropTargetAnchorContainer;
     private readonly _onWillDragPanel;
     readonly onWillDragPanel: Event<TabDragEvent>;
@@ -218,8 +239,25 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     readonly onDidActivePanelChange: Event<IDockviewPanel | undefined>;
     private readonly _onDidMovePanel;
     readonly onDidMovePanel: Event<MovePanelEvent>;
+    private readonly _onDidCreateTabGroup;
+    readonly onDidCreateTabGroup: Event<DockviewTabGroupChangeEvent>;
+    private readonly _onDidDestroyTabGroup;
+    readonly onDidDestroyTabGroup: Event<DockviewTabGroupChangeEvent>;
+    private readonly _onDidAddPanelToTabGroup;
+    readonly onDidAddPanelToTabGroup: Event<DockviewTabGroupPanelChangeEvent>;
+    private readonly _onDidRemovePanelFromTabGroup;
+    readonly onDidRemovePanelFromTabGroup: Event<DockviewTabGroupPanelChangeEvent>;
+    private readonly _onDidTabGroupChange;
+    readonly onDidTabGroupChange: Event<DockviewTabGroupChangeEvent>;
+    private readonly _onDidTabGroupCollapsedChange;
+    readonly onDidTabGroupCollapsedChange: Event<DockviewTabGroupChangeEvent>;
     private readonly _onDidMaximizedGroupChange;
     readonly onDidMaximizedGroupChange: Event<DockviewMaximizedGroupChanged>;
+    private _shellManager;
+    private _floatingOverlayHost;
+    private _inShellLayout;
+    private readonly _edgeGroups;
+    private readonly _edgeGroupDisposables;
     private readonly _floatingGroups;
     private readonly _popoutGroups;
     private readonly _rootDropTarget;
@@ -236,6 +274,7 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     get totalPanels(): number;
     get panels(): IDockviewPanel[];
     get options(): DockviewComponentOptions;
+    get tabGroupColorPalette(): TabGroupColorPalette;
     get activePanel(): IDockviewPanel | undefined;
     get renderer(): DockviewPanelRenderer;
     get defaultHeaderPosition(): DockviewHeaderPosition;
@@ -248,11 +287,28 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     get popoutRestorationPromise(): Promise<void>;
     constructor(container: HTMLElement, options: DockviewComponentOptions);
     setVisible(panel: DockviewGroupPanel, visible: boolean): void;
+    /**
+     * Returns the {@link PopupService} that should host popovers (context
+     * menus, tab overflow menus) for the given group. Popout groups have their
+     * own service rooted in their popout window so the popover renders there
+     * and dismisses on events from that window.
+     */
+    getPopupServiceForGroup(group: DockviewGroupPanel): PopupService;
     addPopoutGroup(itemToPopout: DockviewPanel | DockviewGroupPanel, options?: DockviewPopoutGroupOptions): Promise<boolean>;
     addFloatingGroup(item: DockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptionsInternal): void;
     private orthogonalize;
     updateOptions(options: Partial<DockviewComponentOptions>): void;
     layout(width: number, height: number, forceResize?: boolean | undefined): void;
+    private _syncFloatingOverlayHost;
+    private _layoutFromShell;
+    protected forceRelayout(): void;
+    addEdgeGroup(position: EdgeGroupPosition, options: EdgeGroupOptions): DockviewGroupPanelApi;
+    getEdgeGroup(position: EdgeGroupPosition): DockviewGroupPanelApi | undefined;
+    setEdgeGroupVisible(position: EdgeGroupPosition, visible: boolean): void;
+    isEdgeGroupVisible(position: EdgeGroupPosition): boolean;
+    removeEdgeGroup(position: EdgeGroupPosition): void;
+    setEdgeGroupCollapsed(group: DockviewGroupPanel, collapsed: boolean): void;
+    isEdgeGroupCollapsed(group: DockviewGroupPanel): boolean;
     private updateDragAndDropState;
     focus(): void;
     getGroupPanel(id: string): IDockviewPanel | undefined;
@@ -297,6 +353,7 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     private debouncedUpdateAllPositions;
     movingLock<T>(func: () => T): T;
     moveGroupOrPanel(options: MoveGroupOrPanelOptions): void;
+    private moveTabGroupToGroup;
     moveGroup(options: MoveGroupOptions): void;
     doSetGroupActive(group: DockviewGroupPanel | undefined): void;
     doSetGroupAndPanelActive(group: DockviewGroupPanel | undefined): void;