dockview-core 7.0.3 → 8.0.0

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

@@ -6,6 +6,16 @@ export interface IRootDropTargetHost {
     readonly id: string;
     readonly element: HTMLElement;
     readonly options: DockviewComponentOptions;
+    /**
+     * Whether the two-band edge drag-reveal affordance is registered.
+     *
+     * Read lazily, never at construction: module services are created in
+     * registration order, and this one is built before any module that could
+     * provide the affordance, so at construction the answer is always `false`,
+     * even when the affordance is on its way. The module's `init` hook
+     * re-applies the options once every service exists.
+     */
+    readonly hasEdgeDragReveal: boolean;
     isGridEmpty(): boolean;
     rootDropTargetOverrideTarget(): DropTargetTargetModel | undefined;
     /**
@@ -26,6 +36,7 @@ export interface IRootDropTargetService extends IDisposable {
 export declare class RootDropTargetService implements IRootDropTargetService {
     private readonly _html5Target;
     private readonly _pointerTarget;
+    private readonly _host;
     readonly onWillShowOverlay: Event<WillShowOverlayEvent>;
     readonly onDrop: Event<DroptargetEvent>;
     constructor(host: IRootDropTargetHost);

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

@@ -2,7 +2,7 @@
  * A single entry in the tab-group color palette.
  *
  * `id` is the value stored on `ITabGroup.color` and serialized in
- * `SerializedTabGroup.color`. `value` is any CSS color expression — a hex
+ * `SerializedTabGroup.color`. `value` is any CSS color expression: a hex
  * literal, an rgb()/hsl()/oklch() function, or a `var(...)` reference.
  *
  * The default palette ships with `var(--dv-tab-group-color-${id})` values so

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

@@ -0,0 +1,10 @@
+import { IDisposable } from '../lifecycle';
+import { DockviewGroupPanel } from './dockviewGroupPanel';
+import { ITabGroupChipsHost, ITabGroupChipsService } from './moduleContracts';
+export declare class TabGroupChipsService implements ITabGroupChipsService {
+    private readonly _host;
+    constructor(host: ITabGroupChipsHost);
+    attachToGroup(group: DockviewGroupPanel): IDisposable;
+    dispose(): void;
+}
+export declare const TabGroupChipsModule: import("./modules").DockviewModule<ITabGroupChipsHost>;

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

@@ -57,8 +57,8 @@ export interface DockviewTheme {
     /**
      * Controls tab drag-and-drop reorder animation style.
      *
-     * - `"smooth"`: tabs animate smoothly during drag-and-drop reorder —
-     *   tabs slide apart to reveal the insertion gap, then animate to their
+     * - `"smooth"`: tabs animate smoothly during drag-and-drop reorder. They
+     *   slide apart to reveal the insertion gap, then animate to their
      *   final positions on drop (Chrome-like behavior).
      * - `"default"`: standard tab reorder behavior without animation.
      *

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

@@ -49,5 +49,8 @@ export interface GroupviewPanelState {
     minimumHeight?: number;
     maximumWidth?: number;
     maximumHeight?: number;
+    /** Pinned tab state (PinnedTabs module). Emitted only when `true`; absent
+     *  layouts load unpinned. */
+    pinned?: boolean;
 }
 export {};

package/dist/cjs/dom.d.ts

@@ -55,6 +55,14 @@ export declare function isChildEntirelyVisibleWithinParent(child: HTMLElement, p
 export declare function onDidWindowMoveEnd(window: Window): Emitter<void>;
 export declare function onDidWindowResizeEnd(element: Window, cb: () => void): CompositeDisposable;
 export declare function shiftAbsoluteElementIntoView(element: HTMLElement, root: HTMLElement, options?: {
-    buffer: number;
+    buffer?: number;
 }): void;
 export declare function findRelativeZIndexParent(el: HTMLElement): HTMLElement | null;
+/** Whether the user has requested reduced motion: the JS counterpart to the
+ *  `prefers-reduced-motion` media query, for animations driven in script. */
+export declare function prefersReducedMotion(doc?: Document): boolean;
+/** The first opaque computed background colour walking up from `element` (the
+ *  element itself, then its ancestors). Use to give a floating/overlapping
+ *  surface a non-see-through backdrop derived from the live DOM. Returns `''`
+ *  when nothing opaque is found (let the stylesheet decide). */
+export declare function resolveOpaqueBackground(element: HTMLElement): string;

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

@@ -103,8 +103,8 @@ export declare abstract class BaseGrid<T extends IGridPanelView> extends Resizab
     getPanel(id: string): T | undefined;
     doSetGroupActive(group: T | undefined): void;
     removeGroup(group: T): void;
-    moveToNext(options?: MovementOptions2): void;
-    moveToPrevious(options?: MovementOptions2): void;
+    activateNext(options?: MovementOptions2): void;
+    activatePrevious(options?: MovementOptions2): void;
     protected forceRelayout(): void;
     layout(width: number, height: number, forceResize?: boolean): void;
     dispose(): void;

package/dist/cjs/gridview/gridview.d.ts

@@ -49,6 +49,7 @@ export interface GridBranchNode<T extends IGridView> {
         width: number;
         height: number;
     };
+    readonly cachedVisibleSize: number | undefined;
 }
 export type GridNode<T extends IGridView> = GridLeafNode<T> | GridBranchNode<T>;
 export declare function isGridBranchNode<T extends IGridView>(node: GridNode<T>): node is GridBranchNode<T>;
@@ -68,6 +69,7 @@ export interface ISerializedBranchNode {
     type: 'branch';
     data: ISerializedNode[];
     size: number;
+    visible?: boolean;
 }
 export type ISerializedNode = ISerializedLeafNode | ISerializedBranchNode;
 export interface INodeDescriptor {

package/dist/cjs/index.d.ts

@@ -1,58 +1,64 @@
-export { getPaneData, getPanelData, PaneTransfer, PanelTransfer, } from './dnd/dataTransfer';
+export { getPaneData, getPanelData, LocalSelectionTransfer, PaneTransfer, PanelTransfer, } from './dnd/dataTransfer';
 /**
  * Events, Emitters and Disposables are very common concepts that many codebases will contain, however we need
  * to export them for dockview framework packages to use.
  * To be a good citizen these are exported with a `Dockview` prefix to prevent accidental use by others.
  */
 export { Emitter as DockviewEmitter, Event as DockviewEvent } from './events';
-export { IDisposable as DockviewIDisposable, MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, Disposable as DockviewDisposable, } from './lifecycle';
+export { type IDisposable as DockviewIDisposable, MutableDisposable as DockviewMutableDisposable, CompositeDisposable as DockviewCompositeDisposable, Disposable as DockviewDisposable, } from './lifecycle';
 export * from './panel/types';
 export * from './splitview/splitview';
-export { SplitviewComponentOptions, PanelViewInitParameters, SplitviewOptions, SplitviewFrameworkOptions, PROPERTY_KEYS_SPLITVIEW, } from './splitview/options';
+export { type SplitviewComponentOptions, type PanelViewInitParameters, type SplitviewOptions, type SplitviewFrameworkOptions, PROPERTY_KEYS_SPLITVIEW, } from './splitview/options';
 export * from './paneview/paneview';
 export * from './gridview/gridview';
-export { GridviewComponentOptions, GridviewOptions, GridviewFrameworkOptions, PROPERTY_KEYS_GRIDVIEW, } from './gridview/options';
+export { type GridviewComponentOptions, type GridviewOptions, type GridviewFrameworkOptions, PROPERTY_KEYS_GRIDVIEW, } from './gridview/options';
 export * from './gridview/baseComponentGridview';
-export { DraggablePaneviewPanel, PaneviewDidDropEvent, } from './paneview/draggablePaneviewPanel';
+export { DraggablePaneviewPanel, type PaneviewDidDropEvent, } from './paneview/draggablePaneviewPanel';
 export * from './dockview/components/panel/content';
 export * from './dockview/components/tab/tab';
-export { DockviewGroupPanelModel, DockviewDidDropEvent, DockviewWillDropEvent, DockviewGroupChangeEvent, DockviewGroupActivePanelChangeEvent, DockviewGroupLocation, } from './dockview/dockviewGroupPanelModel';
-export { DockviewWillShowOverlayLocationEvent, DockviewTabGroupChangeEvent, DockviewTabGroupCollapsedChangeEvent, DockviewTabGroupPanelChangeEvent, DockviewGroupDropLocation, } from './dockview/events';
-export { TabDragEvent, GroupDragEvent, } from './dockview/components/titlebar/tabsContainer';
+export { DockviewGroupPanelModel, DockviewDidDropEvent, DockviewWillDropEvent, type DockviewGroupChangeEvent, type DockviewGroupActivePanelChangeEvent, type DockviewGroupLocation, } from './dockview/dockviewGroupPanelModel';
+export { DockviewWillShowOverlayLocationEvent, type DockviewTabGroupChangeEvent, type DockviewTabGroupCollapsedChangeEvent, type DockviewTabGroupPanelChangeEvent, type DockviewGroupDropLocation, } from './dockview/events';
+export { type TabDragEvent, type GroupDragEvent, } from './dockview/components/titlebar/tabsContainer';
 export * from './dockview/types';
 export * from './dockview/dockviewGroupPanel';
-export { IGroupPanelBaseProps, IDockviewPanelHeaderProps, IDockviewPanelProps, IDockviewHeaderActionsProps, IGroupHeaderProps, IWatermarkPanelProps, DockviewReadyEvent, ITabGroupChipRenderer, IGroupDragGhostRenderer, } from './dockview/framework';
+export { type IGroupPanelBaseProps, type IDockviewPanelHeaderProps, type IDockviewPanelProps, type IDockviewHeaderActionsProps, type IGroupHeaderProps, type IWatermarkPanelProps, type DockviewReadyEvent, type ITabGroupChipRenderer, type IGroupDragGhostRenderer, } from './dockview/framework';
 export * from './dockview/options';
 export * from './dockview/theme';
 export * from './dockview/dockviewPanel';
-export { DockviewTabGroupColor, ITabGroup, SerializedTabGroup, TabGroupOptions, } from './dockview/tabGroup';
-export { DEFAULT_TAB_GROUP_COLORS, DockviewTabGroupColorEntry, TabGroupColorPalette, applyTabGroupAccent, resolveTabGroupAccent, } from './dockview/tabGroupAccent';
+export { type DockviewTabGroupColor, type ITabGroup, type SerializedTabGroup, type TabGroupOptions, } from './dockview/tabGroup';
+export { DEFAULT_TAB_GROUP_COLORS, type DockviewTabGroupColorEntry, TabGroupColorPalette, applyTabGroupAccent, resolveTabGroupAccent, } from './dockview/tabGroupAccent';
 export { DefaultTab } from './dockview/components/tab/defaultTab';
-export { DefaultDockviewDeserialzier, IPanelDeserializer, } from './dockview/deserializer';
+export { DefaultDockviewDeserialzier, type IPanelDeserializer, } from './dockview/deserializer';
 export * from './dockview/dockviewComponent';
-export { EdgeGroupOptions, EdgeGroupPosition, SerializedEdgeGroups, } from './dockview/dockviewShell';
+export { type EdgeGroupOptions, type AddEdgeGroupOptions, type EdgeGroupPosition, type SerializedEdgeGroups, } from './dockview/dockviewShell';
 export * from './gridview/gridviewComponent';
 export * from './splitview/splitviewComponent';
 export * from './paneview/paneviewComponent';
-export { PaneviewComponentOptions, PaneviewOptions, PaneviewFrameworkOptions, PROPERTY_KEYS_PANEVIEW, PaneviewUnhandledDragOverEvent, PaneviewDndOverlayEvent, } from './paneview/options';
+export { type PaneviewComponentOptions, type PaneviewOptions, type PaneviewFrameworkOptions, PROPERTY_KEYS_PANEVIEW, PaneviewUnhandledDragOverEvent, type PaneviewDndOverlayEvent, } from './paneview/options';
 export * from './gridview/gridviewPanel';
-export { SplitviewPanel, ISplitviewPanel } from './splitview/splitviewPanel';
+export { SplitviewPanel, type ISplitviewPanel, } from './splitview/splitviewPanel';
 export * from './paneview/paneviewPanel';
 export * from './dockview/types';
-export { Box, AnchorPosition, AnchoredBox } from './types';
-export { DockviewPanelRenderer } from './overlay/overlayRenderContainer';
-export { Position, positionToDirection, directionToPosition, MeasuredValue, DroptargetOverlayModel, } from './dnd/droptarget';
-export { FocusEvent, PanelDimensionChangeEvent, VisibilityEvent, ActiveEvent, PanelApi, } from './api/panelApi';
-export { SizeEvent, GridviewPanelApi, GridConstraintChangeEvent, } from './api/gridviewPanelApi';
-export { TitleEvent, RendererChangedEvent, DockviewPanelApi, DockviewPanelMoveParams, } from './api/dockviewPanelApi';
-export { PanelSizeEvent, PanelConstraintChangeEvent, SplitviewPanelApi, } from './api/splitviewPanelApi';
-export { ExpansionEvent, PaneviewPanelApi } from './api/paneviewPanelApi';
-export { DockviewGroupPanelApi, DockviewGroupPanelLocationChangeEvent, DockviewGroupPanelCollapsedChangeEvent, DockviewGroupMoveParams, } from './api/dockviewGroupPanelApi';
-export { CommonApi, SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, DockviewGetTabGroupsOptions, } from './api/component.api';
+export { type Box, type AnchorPosition, type AnchoredBox, type DragModifiers, } from './types';
+export { type DockviewPanelRenderer } from './overlay/overlayRenderContainer';
+export { type Position, positionToDirection, directionToPosition, type MeasuredValue, type DroptargetOverlayModel, type PositionResolver, type PositionResolverArgs, type PositionResolverResult, } from './dnd/droptarget';
+export { type FocusEvent, type PanelDimensionChangeEvent, type VisibilityEvent, type ActiveEvent, type PanelApi, } from './api/panelApi';
+export { type SizeEvent, type GridviewPanelApi, type GridConstraintChangeEvent, } from './api/gridviewPanelApi';
+export { type TitleEvent, type PinnedChangeEvent, type RendererChangedEvent, type DockviewPanelApi, type DockviewPanelMoveParams, } from './api/dockviewPanelApi';
+export { type PanelSizeEvent, type PanelConstraintChangeEvent, type SplitviewPanelApi, } from './api/splitviewPanelApi';
+export { type ExpansionEvent, type PaneviewPanelApi, } from './api/paneviewPanelApi';
+export { type DockviewGroupPanelApi, type DockviewGroupPanelLocationChangeEvent, type DockviewGroupPanelCollapsedChangeEvent, type DockviewGroupPanelPeekChangeEvent, type DockviewGroupPanelHeaderDirectionChangeEvent, type DockviewGroupMoveParams, } from './api/dockviewGroupPanelApi';
+export { type CommonApi, SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, type DockviewGetTabGroupsOptions, } from './api/component.api';
 export { createDockview, createGridview, createPaneview, createSplitview, } from './api/entryPoints';
-export { registerModules, getRegisteredModules, clearRegisteredModules, markDockviewPackageLoaded, isDockviewPackageLoaded, defineModule, DockviewModule, ServiceCollection, } from './dockview/modules';
-export { IAccessibilityHost, IAccessibilityService, IAdvancedDnDHost, IAdvancedDnDService, IContextMenuHost, IContextMenuService, IKeyboardDockingService, ITabGroupChipsHost, ITabGroupChipsService, } from './dockview/moduleContracts';
+export { registerModules, getRegisteredModules, clearRegisteredModules, defineModule, type DockviewModule, type ServiceCollection, } from './dockview/modules';
+export { type IKeyboardNavigationHost, type IKeyboardNavigationService, type IAdvancedDnDHost, type IAdvancedDnDService, type IAutoHideEdgeGroupHost, type IAutoHideEdgeGroupService, type IAutoEdgeGroupHost, type IAutoEdgeGroupService, type IContextMenuHost, type IContextMenuService, type IDndCompassHost, type IDndCompassService, type IKeyboardDockingService, type ILayoutHistoryHost, type ILayoutHistoryService, type LayoutHistoryChangeEvent, type LayoutHistoryKind, type IMultiRowTabsHost, type IMultiRowTabsService, type ISmartGuidesHost, type ISmartGuidesService, type SmartGuidesSnapPosition, type SmartGuidesSnapEvent, type SmartGuidesSnapTogetherEvent, type ITabGroupChipsHost, type ITabGroupChipsService, type IPinnedTabsHost, type IPinnedTabsService, type IAdvancedOverflowHost, type IAdvancedOverflowService, type IAdvancedOverflowRenderContext, type AdvancedOverflowRenderParams, type IOverflowRow, } from './dockview/moduleContracts';
 export { resolveMessages } from './dockview/accessibilityMessages';
-export { findRelativeZIndexParent } from './dom';
-export { IDragGhostSpec } from './dnd/backend';
+export { findRelativeZIndexParent, prefersReducedMotion, resolveOpaqueBackground, } from './dom';
+export { createDismissableLayer, type DismissableLayerOptions, } from './dismissableLayer';
+export { type IDragGhostSpec } from './dnd/backend';
 export { LiveRegionModule } from './dockview/liveRegionService';
+export { AdvancedDnDModule, AdvancedDnDService, } from './dockview/advancedDnDService';
+export { TabGroupChipsModule, TabGroupChipsService, } from './dockview/tabGroupChipsService';
+export { FloatingGroupModule } from './dockview/floatingGroupService';
+export { EdgeGroupModule } from './dockview/edgeGroupService';
+export { createCloseButton, createPinButton } from './svg';

package/dist/cjs/lifecycle.d.ts

@@ -20,6 +20,7 @@ export declare class CompositeDisposable {
 }
 export declare class MutableDisposable implements IDisposable {
     private _disposable;
+    get value(): IDisposable | undefined;
     set value(disposable: IDisposable);
     dispose(): void;
 }

package/dist/cjs/overlay/overlay.d.ts

@@ -1,6 +1,6 @@
 import { Event } from '../events';
 import { CompositeDisposable } from '../lifecycle';
-import { AnchoredBox, Box } from '../types';
+import { AnchoredBox, Box, DragModifiers } from '../types';
 /**
  * Context handed to {@link OverlayOptions.transformDragPosition} each
  * pointer-move frame while a floating overlay is being dragged.
@@ -15,6 +15,8 @@ export interface OverlayDragContext {
     };
     /** Bounds of the sibling overlays, snapshotted at drag start. */
     readonly others: readonly Box[];
+    /** Modifier-key state from this frame's pointer event. */
+    readonly modifiers: DragModifiers;
 }
 export declare class Overlay extends CompositeDisposable {
     private readonly options;
@@ -82,7 +84,7 @@ export declare class Overlay extends CompositeDisposable {
      */
     cancelPendingDrag(): void;
     setupDrag(dragTarget: HTMLElement, options?: {
-        inDragMode: boolean;
+        inDragMode?: boolean;
     }): void;
     private setupResize;
     private getMinimumWidth;

package/dist/cjs/overlay/overlayRenderContainer.d.ts

@@ -16,6 +16,14 @@ export declare class OverlayRenderContainer extends CompositeDisposable {
     private readonly pendingUpdates;
     constructor(element: HTMLElement, accessor: DockviewComponent);
     updateAllPositions(): void;
+    /**
+     * Reposition a single panel's overlay over its reference container,
+     * optionally forcing it visible even when the panel is not currently
+     * "visible" (e.g. its group is collapsed). Used by the auto-hide peek to
+     * slide an `always`-rendered panel out without reparenting it or mutating
+     * the panel's visibility state. No-op if the panel isn't overlay-rendered.
+     */
+    repositionPanelOverlay(panelId: string, forceVisible?: boolean, clip?: DOMRect): void;
     detatch(panel: IDockviewPanel): boolean;
     attach(options: {
         panel: IDockviewPanel;

package/dist/cjs/paneview/paneview.d.ts

@@ -29,9 +29,10 @@ export declare class Paneview extends CompositeDisposable implements IDisposable
     setViewVisible(index: number, visible: boolean): void;
     addPane(pane: PaneviewPanel, size?: number | Sizing, index?: number, skipLayout?: boolean): void;
     getViewSize(index: number): number;
+    getViewCachedVisibleSize(index: number): number | undefined;
     getPanes(): PaneviewPanel[];
     removePane(index: number, options?: {
-        skipDispose: boolean;
+        skipDispose?: boolean;
     }): PaneItem;
     moveView(from: number, to: number): void;
     layout(size: number, orthogonalSize: number): void;

package/dist/cjs/paneview/paneviewComponent.d.ts

@@ -24,6 +24,9 @@ export interface SerializedPaneviewPanel {
     };
     size: number;
     expanded?: boolean;
+    /** Absent/true = visible; false = the pane was hidden via setVisible and
+     *  `size` holds its cached pre-hide size. */
+    visible?: boolean;
 }
 export interface SerializedPaneview {
     size: number;

package/dist/cjs/paneview/paneviewPanel.d.ts

@@ -51,6 +51,11 @@ export declare abstract class PaneviewPanel extends BasePanelView<PaneviewPanelA
     private _minimumBodySize;
     private _maximumBodySize;
     private _isExpanded;
+    /**
+     * The pane's main-axis size captured just before it was collapsed, so a
+     * later re-expand can restore that size instead of the cross-axis width.
+     */
+    private _expandedSize;
     protected header?: HTMLElement;
     protected body?: HTMLElement;
     private bodyPart?;

package/dist/cjs/svg.d.ts

@@ -1,3 +1,4 @@
 export declare const createCloseButton: () => SVGSVGElement;
+export declare const createPinButton: () => SVGSVGElement;
 export declare const createExpandMoreButton: () => SVGSVGElement;
 export declare const createChevronRightButton: () => SVGSVGElement;

package/dist/cjs/types.d.ts

@@ -6,6 +6,14 @@ export interface Box {
     height: number;
     width: number;
 }
+/** Keyboard modifier state captured from a pointer event (e.g. for snapping
+ *  gates that suspend while a modifier is held). */
+export interface DragModifiers {
+    readonly altKey: boolean;
+    readonly ctrlKey: boolean;
+    readonly metaKey: boolean;
+    readonly shiftKey: boolean;
+}
 type TopLeft = {
     top: number;
     left: number;