dockview-core 8.5.1 → 8.6.0

package/dist/cjs/api/component.api.d.ts

@@ -564,8 +564,14 @@ export declare class DockviewApi implements CommonApi<SerializedDockview> {
     addPanel<T extends object = Parameters>(options: AddPanelOptions<T>): IDockviewPanel;
     /**
      * Remove a panel given the panel object.
+     *
+     * `removeEmptyGroup` overrides the `closeEmptyGroups` option for this
+     * call: `false` keeps the group if the panel was its last one, `true`
+     * removes it.
      */
-    removePanel(panel: IDockviewPanel): void;
+    removePanel(panel: IDockviewPanel, options?: {
+        removeEmptyGroup?: boolean;
+    }): void;
     /**
      * Add a group and return the created object.
      */

package/dist/cjs/api/dockviewGroupPanelApi.d.ts

@@ -120,6 +120,8 @@ export declare class DockviewGroupPanelApiImpl extends GridviewPanelApiImpl {
     private readonly accessor;
     private _group;
     private _pendingSize;
+    private _isApplyingSize;
+    private _reportedSize;
     readonly _onDidLocationChange: Emitter<DockviewGroupPanelLocationChangeEvent>;
     readonly onDidLocationChange: Event<DockviewGroupPanelLocationChangeEvent>;
     readonly _onDidActivePanelChange: Emitter<DockviewGroupActivePanelChangeEvent>;

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

@@ -274,7 +274,9 @@ export interface IDockviewComponent extends IBaseGrid<DockviewGroupPanel> {
     doSetGroupActive: (group: DockviewGroupPanel, skipFocus?: boolean) => void;
     removeGroup: (group: DockviewGroupPanel) => void;
     addPanel<T extends object = Parameters>(options: AddPanelOptions<T>): IDockviewPanel;
-    removePanel(panel: IDockviewPanel): void;
+    removePanel(panel: IDockviewPanel, options?: {
+        removeEmptyGroup?: boolean;
+    }): void;
     getGroupPanel: (id: string) => IDockviewPanel | undefined;
     createWatermarkComponent(): IWatermarkRenderer;
     addGroup(options?: AddGroupOptions): DockviewGroupPanel;
@@ -686,7 +688,20 @@ export declare class DockviewComponent extends BaseGrid<DockviewGroupPanel> impl
     private disposePopoutWindow;
     addFloatingGroup(item: DockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptionsInternal): void;
     private _doAddFloatingGroup;
+    /** The `closeEmptyGroups` option: remove a group once it empties. */
+    private get closeEmptyGroups();
+    /** Whether a move leaves its emptied source group in place. */
+    private keepEmptyGroups;
     private removeGroupIfEmpty;
+    /**
+     * Locks the main grid, the shell whose splitviews host the edge groups,
+     * and the nested gridviews of floating and popout windows. The base
+     * setter stops at the main grid; `updateOptions` reaches this override.
+     */
+    get locked(): boolean;
+    set locked(value: boolean);
+    /** The gridviews hosted by open floating and popout windows. */
+    private nestedGridviews;
     /**
      * Build an empty gridview configured to match the main grid's styling and
      * resize behaviour, for hosting a nested layout inside a floating or popout

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

@@ -2,6 +2,14 @@ import { Event } from '../events';
 import { IDisposable } from '../lifecycle';
 import { IView, LayoutPriority } from '../splitview/splitview';
 export type EdgeGroupPosition = 'top' | 'bottom' | 'left' | 'right';
+export declare function isHorizontal(position: EdgeGroupPosition): boolean;
+/** What an edge view reads live from the splitview it sits in. */
+export interface IEdgeGroupAxis {
+    /** The size each visible view gives up to the margins between them. */
+    readonly marginShare: number;
+    /** The splitview's extent along the axis; zero until it is laid out. */
+    readonly size: number;
+}
 export interface EdgeGroupOptions {
     id: string;
     initialSize?: number;
@@ -69,10 +77,11 @@ export declare class EdgeGroupView implements IView {
     readonly snap = false;
     readonly priority = LayoutPriority.Low;
     private _isCollapsed;
+    private _isVisible;
     private _lastExpandedSize;
     private _baseCollapsedSize;
     private _baseMinimumSize;
-    private _gapAdd;
+    private readonly _axis;
     private readonly _expandedMaximumSize;
     private _measuredTabSize;
     private readonly _tabSizeDisposables;
@@ -97,7 +106,7 @@ export declare class EdgeGroupView implements IView {
     get configuredMinimumSize(): number | undefined;
     get configuredMaximumSize(): number;
     get configuredCollapsedSize(): number;
-    constructor(options: EdgeGroupOptions, group: IEdgeGroupHost, orientation: 'horizontal' | 'vertical', gapAdd?: number);
+    constructor(options: EdgeGroupOptions, group: IEdgeGroupHost, orientation: 'horizontal' | 'vertical', axis?: IEdgeGroupAxis);
     /**
      * Watch the group's tab strip so the collapsed size follows the live tab
      * height. The strip's cross-axis size (height for top/bottom, width for
@@ -113,20 +122,19 @@ export declare class EdgeGroupView implements IView {
     private _applyMeasuredTabSize;
     layout(size: number, orthogonalSize: number): void;
     setCollapsed(collapsed: boolean): void;
-    setVisible(_visible: boolean): void;
+    setVisible(visible: boolean): void;
     /**
-     * Restore the last-expanded size from serialized state without triggering
-     * a layout. Must be called before setCollapsed(true) during fromJSON so
-     * that expanding after deserialization restores the correct size.
+     * Set the expanded size without triggering a layout: from serialized
+     * state (before setCollapsed(true) during fromJSON, so that expanding
+     * restores the right size) or from an explicit resize.
      */
     restoreExpandedSize(size: number): void;
     /**
-     * Apply a new base (pre-gap) collapsed size, base minimum size and gap
-     * contribution after a theme or gap change. Base values come from the
-     * original config; the ShellManager owns the gap arithmetic. A live
-     * measured tab size (if any) continues to win over the base collapsed size.
+     * Apply a new base (pre-gap) collapsed size and base minimum size after a
+     * theme change. Base values come from the original config. A live measured
+     * tab size (if any) continues to win over the base collapsed size.
      */
-    updateSizing(baseCollapsedSize: number, baseMinimumSize: number | undefined, gapAdd: number): void;
+    updateSizing(baseCollapsedSize: number, baseMinimumSize: number | undefined): void;
     dispose(): void;
 }
 export declare class ShellManager implements IDisposable {
@@ -149,6 +157,13 @@ export declare class ShellManager implements IDisposable {
     private _defaultCollapsedSize;
     constructor(container: HTMLElement, dockviewElement: HTMLElement, layoutGrid: (width: number, height: number) => void, gap?: number, defaultCollapsedSize?: number);
     get element(): HTMLElement;
+    /**
+     * The dock's `locked` option. The edge groups are resized with the sashes
+     * of the shell's own splitviews (left/right in the outer one, top/bottom
+     * in the middle column), so locking disables both.
+     */
+    get locked(): boolean;
+    set locked(value: boolean);
     /**
      * Add an edge group view at the given position. The view wraps the
      * provided group element inside the shell's splitview layout.
@@ -174,6 +189,21 @@ export declare class ShellManager implements IDisposable {
      * and tab-strip dimensions.
      */
     updateTheme(gap: number, defaultCollapsedSize: number): void;
+    /** Whether the other edge of `position`'s axis holds a view. */
+    private _hasSiblingOn;
+    /** The splitview `position`'s view sits in, as its edge axis. */
+    private _axisFor;
+    /** Re-derive every edge view's base sizing from its original config and
+     *  the current defaults. */
+    private _applyThemeSizing;
+    /**
+     * Lay the shell out again at its current size, once it has one. The
+     * splitviews clamp every view to its current constraints, which is how a
+     * collapsed strip or a group at its minimum follows a moved gap share.
+     */
+    private _relayout;
+    /** The view's slot in its splitview: its laid-out size plus the gap share. */
+    private _slotSize;
     removeEdgeView(position: EdgeGroupPosition): void;
     hasEdgeGroup(position: EdgeGroupPosition): boolean;
     setEdgeGroupVisible(position: EdgeGroupPosition, visible: boolean): void;
@@ -199,6 +229,12 @@ export declare class ShellManager implements IDisposable {
     getEdgeGroupExpandedSize(position: EdgeGroupPosition): number;
     private _getView;
     toJSON(): SerializedEdgeGroups;
+    /** The size to restore the group to. An expanded-but-hidden group has a
+     *  slot of 0, so fall back to its cached visible size (then
+     *  lastExpandedSize); otherwise re-showing snaps to minimumSize. */
+    private _expandedSize;
+    /** The slot a hidden view had when it was last visible. */
+    private _cachedVisibleSize;
     fromJSON(data: SerializedEdgeGroups): void;
     dispose(): void;
 }

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

@@ -392,6 +392,12 @@ export interface DockviewOptions {
      * Define the behaviour of the dock when there are no panels to display. Defaults to `watermark`.
      */
     noPanelsOverlay?: 'emptyGroup' | 'watermark';
+    /**
+     * Whether a group is removed once its last panel is closed or moved out.
+     * Defaults to `true`. When `false` the empty group stays in the layout
+     * (rendering the watermark) until it is closed explicitly.
+     */
+    closeEmptyGroups?: boolean;
     theme?: DockviewTheme;
     disableTabsOverflowList?: boolean;
     /**

package/dist/cjs/splitview/splitview.d.ts

@@ -108,6 +108,11 @@ export declare class Splitview {
     get disabled(): boolean;
     set disabled(value: boolean);
     get margin(): number;
+    /**
+     * The size each visible view gives up to the margins: `n` visible views
+     * are separated by `n - 1` margins, spread evenly over the `n`.
+     */
+    get marginShare(): number;
     set margin(value: number);
     constructor(container: HTMLElement, options: SplitViewOptions);
     style(styles?: ISplitviewStyles): void;
@@ -136,6 +141,7 @@ export declare class Splitview {
      * For each view `i` the offet must be adjusted by `m * i/(n - 1)`.
      */
     private layoutViews;
+    private marginShareFor;
     private findFirstSnapIndex;
     private updateSashEnablement;
     private updateSash;