Dockview
    Preparing search index...

    Interface IAutoEdgeGroupHost

    The narrow surface the two-band drag-reveal affordance needs from the host (DockviewComponent). It reuses the existing onWillShowOverlay / onWillDrop seams (no new core overlay code): on a layout-edge drag it classifies the pointer into an outer "dock as edge group" band and an inner "split the grid" band, drawing its own outer-band highlight and routing an outer-band drop to revealEdgeGroupWithData. The inner band falls through to core's default grid split.

    This service is what makes dockToEdgeGroups do anything: core implements no part of it, and gates the widened activation band on this service's presence.

    interface IAutoEdgeGroupHost {
        onWillDrop: DockviewEvent<DockviewWillDropEvent>;
        onWillShowOverlay: DockviewEvent<DockviewWillShowOverlayLocationEvent>;
        options: DockviewComponentOptions;
        overlayRoot: HTMLElement;
        getDropZoneRect(): DOMRect;
        revealEdgeGroupWithData(
            position: EdgeGroupPosition,
            data: { groupId: string; panelId?: string | null },
            options?: { autoHide?: boolean },
        ): void;
    }
    Index

    Properties

    onWillDrop onWillShowOverlay options overlayRoot

    Methods

    getDropZoneRect revealEdgeGroupWithData

    Properties

    onWillDrop: DockviewEvent<DockviewWillDropEvent>

    Fires before a layout-edge drop commits; the affordance preempts the outer band and reveals an edge group.

    onWillShowOverlay: DockviewEvent<DockviewWillShowOverlayLocationEvent>

    Fires before an edge drop overlay is shown; the affordance draws its outer-band highlight (or lets the inner band render the core overlay).

    options: DockviewComponentOptions
    overlayRoot: HTMLElement

    The element the outer-band highlight mounts on (the shell / overlay root).

    Methods

    • Viewport rect of the docked content area (the drop-target element), to classify a pointer's edge band and position the highlight.

      Returns DOMRect

    • Reveal (create-or-fill) the edge group at position and drop the dragged item into it. The primitive behind drag-revealed edges.

      Parameters

      • position: EdgeGroupPosition
      • data: { groupId: string; panelId?: string | null }
      • Optionaloptions: { autoHide?: boolean }

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods