dockview-core 6.6.1 → 7.0.3

package/dist/esm/dockview/tabGroup.js

@@ -74,9 +74,9 @@ export class TabGroup extends CompositeDisposable {
         if (this._panelIds.includes(panelId)) {
             return;
         }
-        const insertIndex = index !== undefined
-            ? Math.max(0, Math.min(index, this._panelIds.length))
-            : this._panelIds.length;
+        const insertIndex = index === undefined
+            ? this._panelIds.length
+            : Math.max(0, Math.min(index, this._panelIds.length));
         this._panelIds.splice(insertIndex, 0, panelId);
         this._onDidPanelChange.fire({ panelId, type: 'add' });
     }

package/dist/esm/dockview/tabGroupAccent.js

@@ -87,9 +87,7 @@ let _fallbackPalette;
  * palette through.
  */
 function getFallbackPalette() {
-    if (!_fallbackPalette) {
-        _fallbackPalette = new TabGroupColorPalette(DEFAULT_TAB_GROUP_COLORS, true);
-    }
+    _fallbackPalette !== null && _fallbackPalette !== void 0 ? _fallbackPalette : (_fallbackPalette = new TabGroupColorPalette(DEFAULT_TAB_GROUP_COLORS, true));
     return _fallbackPalette;
 }
 /**

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

@@ -0,0 +1,30 @@
+import { IDisposable } from '../lifecycle';
+import { Event } from '../events';
+import { IWatermarkRenderer } from './types';
+import { DockviewApi } from '../api/component.api';
+import { DockviewGroupPanel } from './dockviewGroupPanel';
+export interface IWatermarkHost {
+    readonly api: DockviewApi;
+    readonly mountElement: HTMLElement;
+    createWatermarkComponent(): IWatermarkRenderer;
+    hasVisibleGridGroup(): boolean;
+    readonly onDidAdd: Event<DockviewGroupPanel>;
+    readonly onDidRemove: Event<DockviewGroupPanel>;
+    readonly onDidViewVisibilityChangeMicroTaskQueue: Event<unknown>;
+}
+export interface IWatermarkService extends IDisposable {
+    /** Mount or unmount the watermark based on current grid state. */
+    update(): void;
+    /** Tear down the current watermark and re-evaluate. Used when the watermark factory option changes. */
+    refresh(): void;
+}
+export declare class WatermarkService implements IWatermarkService {
+    private readonly _host;
+    private _watermark;
+    constructor(host: IWatermarkHost);
+    update(): void;
+    refresh(): void;
+    private _unmount;
+    dispose(): void;
+}
+export declare const WatermarkModule: import("./modules").DockviewModule<IWatermarkHost>;

package/dist/esm/dockview/watermarkService.js

@@ -0,0 +1,56 @@
+import { CompositeDisposable } from '../lifecycle';
+import { addTestId } from '../dom';
+import { Event } from '../events';
+import { defineModule } from './modules';
+export class WatermarkService {
+    constructor(host) {
+        this._watermark = null;
+        this._host = host;
+    }
+    update() {
+        if (this._host.hasVisibleGridGroup()) {
+            this._unmount();
+            return;
+        }
+        if (this._watermark) {
+            return;
+        }
+        this._watermark = this._host.createWatermarkComponent();
+        this._watermark.init({ containerApi: this._host.api });
+        const container = document.createElement('div');
+        container.className = 'dv-watermark-container';
+        addTestId(container, 'watermark-component');
+        container.appendChild(this._watermark.element);
+        this._host.mountElement.appendChild(container);
+    }
+    refresh() {
+        this._unmount();
+        this.update();
+    }
+    _unmount() {
+        var _a, _b;
+        if (!this._watermark) {
+            return;
+        }
+        this._watermark.element.parentElement.remove();
+        (_b = (_a = this._watermark).dispose) === null || _b === void 0 ? void 0 : _b.call(_a);
+        this._watermark = null;
+    }
+    dispose() {
+        this._unmount();
+    }
+}
+export const WatermarkModule = defineModule({
+    name: 'Watermark',
+    serviceKey: 'watermarkService',
+    create: (host) => new WatermarkService(host),
+    init: (host, service) => {
+        // Initial evaluation reflects the watermark state at construction time.
+        service.update();
+        return new CompositeDisposable(Event.any(host.onDidAdd, host.onDidRemove)(() => {
+            service.update();
+        }), host.onDidViewVisibilityChangeMicroTaskQueue(() => {
+            service.update();
+        }));
+    },
+});

package/dist/esm/dom.js

@@ -95,7 +95,7 @@ class FocusTracker extends CompositeDisposable {
         const onBlur = () => {
             if (hasFocus) {
                 loosingFocus = true;
-                window.setTimeout(() => {
+                globalThis.setTimeout(() => {
                     if (loosingFocus) {
                         loosingFocus = false;
                         hasFocus = false;

package/dist/esm/events.js

@@ -56,7 +56,7 @@ class LeakageMonitor {
 class Stacktrace {
     static create() {
         var _a;
-        return new Stacktrace((_a = new Error().stack) !== null && _a !== void 0 ? _a : '');
+        return new Stacktrace((_a = new Error('listener stacktrace').stack) !== null && _a !== void 0 ? _a : '');
     }
     constructor(value) {
         this.value = value;

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

@@ -95,7 +95,7 @@ export declare abstract class BaseGrid<T extends IGridPanelView> extends Resizab
     isMaximizedGroup(panel: T): boolean;
     exitMaximizedGroup(): void;
     hasMaximizedGroup(): boolean;
-    protected doAddGroup(group: T, location?: number[], size?: number): void;
+    protected doAddGroup(group: T, location?: number[], size?: number, gridview?: Gridview): void;
     protected doRemoveGroup(group: T, options?: {
         skipActive?: boolean;
         skipDispose?: boolean;

package/dist/esm/gridview/baseComponentGridview.js

@@ -93,8 +93,7 @@ export class BaseGrid extends Resizable {
         }), this.gridview.onDidViewVisibilityChange(() => this._onDidViewVisibilityChangeMicroTaskQueue.fire()), this.onDidViewVisibilityChangeMicroTaskQueue(() => {
             this.forceRelayout();
         }), Disposable.from(() => {
-            var _a;
-            (_a = this.element.parentElement) === null || _a === void 0 ? void 0 : _a.removeChild(this.element);
+            this.element.remove();
         }), this.gridview.onDidChange(() => {
             this._bufferOnDidLayoutChange.fire();
         }), Event.any(this.onDidAdd, this.onDidRemove, this.onDidActiveChange)(() => {
@@ -145,8 +144,8 @@ export class BaseGrid extends Resizable {
     hasMaximizedGroup() {
         return this.gridview.hasMaximizedView();
     }
-    doAddGroup(group, location = [0], size) {
-        this.gridview.addView(group, size !== null && size !== void 0 ? size : Sizing.Distribute, location);
+    doAddGroup(group, location = [0], size, gridview = this.gridview) {
+        gridview.addView(group, size !== null && size !== void 0 ? size : Sizing.Distribute, location);
         this._onDidAdd.fire(group);
     }
     doRemoveGroup(group, options) {
@@ -189,9 +188,7 @@ export class BaseGrid extends Resizable {
     }
     moveToNext(options) {
         var _a;
-        if (!options) {
-            options = {};
-        }
+        options !== null && options !== void 0 ? options : (options = {});
         if (!options.group) {
             if (!this.activeGroup) {
                 return;
@@ -204,9 +201,7 @@ export class BaseGrid extends Resizable {
     }
     moveToPrevious(options) {
         var _a;
-        if (!options) {
-            options = {};
-        }
+        options !== null && options !== void 0 ? options : (options = {});
         if (!options.group) {
             if (!this.activeGroup) {
                 return;

package/dist/esm/gridview/branchNode.js

@@ -65,13 +65,11 @@ export class BranchNode extends CompositeDisposable {
         if (this.children.length === 0) {
             return LayoutPriority.Normal;
         }
-        const priorities = this.children.map((c) => typeof c.priority === 'undefined'
-            ? LayoutPriority.Normal
-            : c.priority);
-        if (priorities.some((p) => p === LayoutPriority.High)) {
+        const priorities = new Set(this.children.map((c) => { var _a; return (_a = c.priority) !== null && _a !== void 0 ? _a : LayoutPriority.Normal; }));
+        if (priorities.has(LayoutPriority.High)) {
             return LayoutPriority.High;
         }
-        else if (priorities.some((p) => p === LayoutPriority.Low)) {
+        else if (priorities.has(LayoutPriority.Low)) {
             return LayoutPriority.Low;
         }
         return LayoutPriority.Normal;
@@ -108,16 +106,7 @@ export class BranchNode extends CompositeDisposable {
         this._size = size;
         this.element = document.createElement('div');
         this.element.className = 'dv-branch-node';
-        if (!childDescriptors) {
-            this.splitview = new Splitview(this.element, {
-                orientation: this.orientation,
-                proportionalLayout,
-                styles,
-                margin,
-            });
-            this.splitview.layout(this.size, this.orthogonalSize);
-        }
-        else {
+        if (childDescriptors) {
             const descriptor = {
                 views: childDescriptors.map((childDescriptor) => {
                     return {
@@ -140,6 +129,15 @@ export class BranchNode extends CompositeDisposable {
                 margin,
             });
         }
+        else {
+            this.splitview = new Splitview(this.element, {
+                orientation: this.orientation,
+                proportionalLayout,
+                styles,
+                margin,
+            });
+            this.splitview.layout(this.size, this.orthogonalSize);
+        }
         this.disabled = disabled;
         this.addDisposables(this._onDidChange, this._onDidVisibilityChange, this.splitview.onDidSashEnd(() => {
             this._onDidChange.fire({});

package/dist/esm/gridview/gridview.js

@@ -383,7 +383,7 @@ export class Gridview {
         if (oldRoot) {
             oldRoot.dispose();
             this._maximizedNode = undefined;
-            this.element.removeChild(oldRoot.element);
+            oldRoot.element.remove();
         }
         this._root = root;
         this.element.appendChild(this._root.element);
@@ -477,7 +477,7 @@ export class Gridview {
     progmaticSelect(location, reverse = false) {
         const [path, node] = this.getNode(location);
         if (!(node instanceof LeafNode)) {
-            throw new Error('invalid location');
+            throw new TypeError('invalid location');
         }
         for (let i = path.length - 1; i > -1; i--) {
             const n = path[i];
@@ -514,7 +514,7 @@ export class Gridview {
         const [rest, index] = tail(location);
         const [, parent] = this.getNode(rest);
         if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid from location');
+            throw new TypeError('Invalid from location');
         }
         return parent.isChildVisible(index);
     }
@@ -525,7 +525,7 @@ export class Gridview {
         const [rest, index] = tail(location);
         const [, parent] = this.getNode(rest);
         if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid from location');
+            throw new TypeError('Invalid from location');
         }
         this._onDidViewVisibilityChange.fire();
         parent.setChildVisible(index, visible);
@@ -536,7 +536,7 @@ export class Gridview {
         }
         const [, parent] = this.getNode(parentLocation);
         if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid location');
+            throw new TypeError('Invalid location');
         }
         parent.moveChild(from, to);
     }
@@ -582,11 +582,11 @@ export class Gridview {
         const [rest, index] = tail(location);
         const [pathToParent, parent] = this.getNode(rest);
         if (!(parent instanceof BranchNode)) {
-            throw new Error('Invalid location');
+            throw new TypeError('Invalid location');
         }
         const nodeToRemove = parent.children[index];
         if (!(nodeToRemove instanceof LeafNode)) {
-            throw new Error('Invalid location');
+            throw new TypeError('Invalid location');
         }
         parent.removeChild(index, sizing);
         nodeToRemove.dispose();
@@ -668,7 +668,7 @@ export class Gridview {
             return [path, node];
         }
         if (!(node instanceof BranchNode)) {
-            throw new Error('Invalid location');
+            throw new TypeError('Invalid location');
         }
         const [index, ...rest] = location;
         if (index < 0 || index >= node.children.length) {

package/dist/esm/gridview/gridviewComponent.d.ts

@@ -11,7 +11,7 @@ export interface SerializedGridviewComponent {
     grid: SerializedGridview<GridPanelViewState>;
     activePanel?: string;
 }
-export interface AddComponentOptions<T extends object = Parameters> extends BaseComponentOptions<T> {
+export interface AddGridviewComponentOptions<T extends object = Parameters> extends BaseComponentOptions<T> {
     minimumWidth?: number;
     maximumWidth?: number;
     minimumHeight?: number;
@@ -29,7 +29,7 @@ export interface IGridviewComponent extends IBaseGrid<GridviewPanel> {
     readonly orientation: Orientation;
     readonly onDidLayoutFromJSON: Event<void>;
     updateOptions(options: Partial<GridviewComponentOptions>): void;
-    addPanel<T extends object = Parameters>(options: AddComponentOptions<T>): IGridviewPanel;
+    addPanel<T extends object = Parameters>(options: AddGridviewComponentOptions<T>): IGridviewPanel;
     removePanel(panel: IGridviewPanel, sizing?: Sizing): void;
     focus(): void;
     fromJSON(serializedGridview: SerializedGridviewComponent): void;
@@ -80,7 +80,7 @@ export declare class GridviewComponent extends BaseGrid<GridviewPanel> implement
         reference: string;
         size?: number;
     }): void;
-    addPanel<T extends object = Parameters>(options: AddComponentOptions<T>): IGridviewPanel;
+    addPanel<T extends object = Parameters>(options: AddGridviewComponentOptions<T>): IGridviewPanel;
     private registerPanel;
     moveGroup(referenceGroup: IGridPanelComponentView, groupId: string, target: Position): void;
     removeGroup(group: GridviewPanel): void;

package/dist/esm/gridview/gridviewComponent.js

@@ -220,12 +220,7 @@ export class GridviewComponent extends BaseGrid {
             }
             this._groups.forEach((groupItem) => {
                 const group = groupItem.value;
-                if (group !== panel) {
-                    group.setActive(false);
-                }
-                else {
-                    group.setActive(true);
-                }
+                group.setActive(group === panel);
             });
         }));
         this._groups.set(panel.id, {

package/dist/esm/gridview/gridviewPanel.d.ts

@@ -6,7 +6,7 @@ import { LayoutPriority } from '../splitview/splitview';
 import { Event } from '../events';
 import { IViewSize } from './gridview';
 import { BaseGrid, IGridPanelView } from './baseComponentGridview';
-export interface Contraints {
+export interface Constraints {
     minimumWidth?: number;
     maximumWidth?: number;
     minimumHeight?: number;

package/dist/esm/index.d.ts

@@ -13,11 +13,11 @@ export * from './paneview/paneview';
 export * from './gridview/gridview';
 export { GridviewComponentOptions, GridviewOptions, GridviewFrameworkOptions, PROPERTY_KEYS_GRIDVIEW, } from './gridview/options';
 export * from './gridview/baseComponentGridview';
-export { DraggablePaneviewPanel, PaneviewDidDropEvent as PaneviewDropEvent, } from './paneview/draggablePaneviewPanel';
+export { DraggablePaneviewPanel, PaneviewDidDropEvent, } from './paneview/draggablePaneviewPanel';
 export * from './dockview/components/panel/content';
 export * from './dockview/components/tab/tab';
-export { DockviewGroupPanelModel, DockviewDidDropEvent, DockviewWillDropEvent, DockviewGroupChangeEvent, DockviewGroupLocation, } from './dockview/dockviewGroupPanelModel';
-export { DockviewWillShowOverlayLocationEvent, DockviewTabGroupChangeEvent, DockviewTabGroupCollapsedChangeEvent, DockviewTabGroupPanelChangeEvent, } from './dockview/events';
+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 * from './dockview/types';
 export * from './dockview/dockviewGroupPanel';
@@ -39,6 +39,7 @@ export * from './gridview/gridviewPanel';
 export { SplitviewPanel, 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';
@@ -46,6 +47,12 @@ export { SizeEvent, GridviewPanelApi, GridConstraintChangeEvent, } from './api/g
 export { TitleEvent, RendererChangedEvent, DockviewPanelApi, DockviewPanelMoveParams, } from './api/dockviewPanelApi';
 export { PanelSizeEvent, PanelConstraintChangeEvent, SplitviewPanelApi, } from './api/splitviewPanelApi';
 export { ExpansionEvent, PaneviewPanelApi } from './api/paneviewPanelApi';
-export { DockviewGroupPanelApi, DockviewGroupPanelFloatingChangeEvent, DockviewGroupPanelCollapsedChangeEvent, DockviewGroupMoveParams, } from './api/dockviewGroupPanelApi';
+export { DockviewGroupPanelApi, DockviewGroupPanelLocationChangeEvent, DockviewGroupPanelCollapsedChangeEvent, DockviewGroupMoveParams, } from './api/dockviewGroupPanelApi';
 export { CommonApi, SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, 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 { resolveMessages } from './dockview/accessibilityMessages';
+export { findRelativeZIndexParent } from './dom';
+export { IDragGhostSpec } from './dnd/backend';
+export { LiveRegionModule } from './dockview/liveRegionService';

package/dist/esm/index.js

@@ -38,3 +38,7 @@ export * from './dockview/types';
 export { positionToDirection, directionToPosition, } from './dnd/droptarget';
 export { SplitviewApi, PaneviewApi, GridviewApi, DockviewApi, } from './api/component.api';
 export { createDockview, createGridview, createPaneview, createSplitview, } from './api/entryPoints';
+export { registerModules, getRegisteredModules, clearRegisteredModules, markDockviewPackageLoaded, isDockviewPackageLoaded, defineModule, } from './dockview/modules';
+export { resolveMessages } from './dockview/accessibilityMessages';
+export { findRelativeZIndexParent } from './dom';
+export { LiveRegionModule } from './dockview/liveRegionService';

package/dist/esm/overlay/overlay.d.ts

@@ -1,6 +1,21 @@
 import { Event } from '../events';
 import { CompositeDisposable } from '../lifecycle';
-import { AnchoredBox } from '../types';
+import { AnchoredBox, Box } from '../types';
+/**
+ * Context handed to {@link OverlayOptions.transformDragPosition} each
+ * pointer-move frame while a floating overlay is being dragged.
+ */
+export interface OverlayDragContext {
+    /** Proposed top-left + size this frame, in container pixels (pre-clamp). */
+    readonly proposed: Box;
+    /** Size of the container the overlay is dragged within. */
+    readonly container: {
+        width: number;
+        height: number;
+    };
+    /** Bounds of the sibling overlays, snapshotted at drag start. */
+    readonly others: readonly Box[];
+}
 export declare class Overlay extends CompositeDisposable {
     private readonly options;
     private readonly _element;
@@ -22,11 +37,38 @@ export declare class Overlay extends CompositeDisposable {
     set minimumInViewportHeight(value: number | undefined);
     get element(): HTMLElement;
     get isVisible(): boolean;
+    /**
+     * Height of the optional drag-handle header, or 0 when none is present.
+     * Used to translate between the overlay's outer box and the content area
+     * available to the group beneath the header.
+     */
+    get headerHeight(): number;
     constructor(options: AnchoredBox & {
         container: HTMLElement;
         content: HTMLElement;
+        /**
+         * Optional dedicated drag handle rendered above the content (a
+         * floating window title bar). When provided the resize container
+         * lays its children out as a flex column so the content shrinks
+         * to fit beneath the handle.
+         */
+        header?: HTMLElement;
         minimumInViewportWidth?: number;
         minimumInViewportHeight?: number;
+        /**
+         * Adjust the proposed top-left each drag frame (before the
+         * container clamp). Return an adjusted position or nothing to leave
+         * it unchanged. Used to implement snapping / custom bounds.
+         */
+        transformDragPosition?: (context: OverlayDragContext) => {
+            top: number;
+            left: number;
+        } | void;
+        /**
+         * Snapshot the sibling overlays' boxes at drag start, supplied to
+         * `transformDragPosition` as `context.others`.
+         */
+        getSiblingBoxes?: () => readonly Box[];
     });
     setVisible(isVisible: boolean): void;
     bringToFront(): void;