Dockview
    Preparing search index...

    Interface IDndCompassHost

    The narrow surface the DnD compass service needs from the host (DockviewComponent). The service owns the compass widget + the cell hit-test resolver; the component installs that resolver at the drop-target seam (dropPositionResolver) and surfaces the drag-over signal the widget follows. It never re-implements drop resolution or the commit path.

    interface IDndCompassHost {
        onWillShowOverlay: DockviewEvent<DockviewWillShowOverlayLocationEvent>;
        options: DockviewComponentOptions;
        canDropOnGroup(
            group: DockviewGroupPanel,
            position: Position,
            event: DragEvent | PointerEvent,
        ): boolean;
        getDropOverlayElement(group: DockviewGroupPanel): HTMLElement | undefined;
        getLayoutElement(): HTMLElement;
    }

    Implemented by

    Index

    Properties

    onWillShowOverlay options

    Methods

    canDropOnGroup getDropOverlayElement getLayoutElement

    Properties

    onWillShowOverlay: DockviewEvent<DockviewWillShowOverlayLocationEvent>

    Fires on each drag-over with the hovered group + native event; the signal the compass widget mounts/follows. The service filters for kind === 'content'.

    options: DockviewComponentOptions

    Methods

    • Whether a drop at position on group's content is actually allowed (the per-position canDisplayOverlay veto), used to gate which compass cells are shown, so only legal drops appear.

      Parameters

      Returns boolean

    • The element the content drop target measures its quadrants against (the dndPanelOverlay outline: the whole group, or just its content). The compass paints its cells in this frame so they line up with where a drop actually resolves, not a different box.

      Parameters

      Returns HTMLElement | undefined

    • The layout root element: the (positioned) surface the outer-cell landing preview is drawn over (where a whole-layout-edge dock lands).

      Returns HTMLElement

    Settings

    Member Visibility

    On This Page

    Properties
    Methods