Dockview
    Preparing search index...

    Interface IAutoHideEdgeGroupHost

    The narrow surface the auto-hide service needs from the host (DockviewComponent). Collapse/expand is delegated to the existing free edge-group machinery (setEdgeGroupCollapsed → shell); the module owns interaction + presentation, never layout/sizing.

    interface IAutoHideEdgeGroupHost {
        onDidAddGroup: DockviewEvent<DockviewGroupPanel>;
        onDidEdgeGroupAutoHideChange: DockviewEvent<DockviewGroupPanel>;
        onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>;
        options: DockviewComponentOptions;
        overlayRoot: HTMLElement;
        announce(message: string): void;
        getEdgeGroupExpandedSize(position: EdgeGroupPosition): number;
        getEdgeGroupPanel(
            position: EdgeGroupPosition,
        ): DockviewGroupPanel | undefined;
        isEdgeGroupAutoHide(group: DockviewGroupPanel): boolean;
        repositionPanelOverlay(
            panel: IDockviewPanel,
            forceVisible: boolean,
            clip?: DOMRect,
        ): void;
        setEdgeGroupCollapsed(group: DockviewGroupPanel, collapsed: boolean): void;
        setEdgeGroupPeeking(group: DockviewGroupPanel, peeking: boolean): void;
    }

    Implemented by

    Index

    Properties

    onDidAddGroup onDidEdgeGroupAutoHideChange onDidRemoveGroup options overlayRoot

    Methods

    announce getEdgeGroupExpandedSize getEdgeGroupPanel isEdgeGroupAutoHide repositionPanelOverlay setEdgeGroupCollapsed setEdgeGroupPeeking

    Properties

    onDidAddGroup: DockviewEvent<DockviewGroupPanel>

    Fires when any group is added; the service filters for location.type === 'edge'.

    onDidEdgeGroupAutoHideChange: DockviewEvent<DockviewGroupPanel>

    Fires when a group's resolved auto-hide state changes at runtime (per-group setAutoHide), so a controller can dock/undock retroactively.

    onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>
    options: DockviewComponentOptions
    overlayRoot: HTMLElement

    The element the slide-out peek mounts on: the shell, which is also the OverlayRenderContainer root, so always-rendered content anchors in the same coordinate space as the peek.

    Methods

    • Announce a message to assistive technology via the shared live region (no-op when no live-region service / announcements: false).

      Parameters

      • message: string

      Returns void

    • Whether this edge group should behave as an auto-hide (pinnable) tool window: the per-group flag resolved against the global autoHideEdgeGroups option. Lets static and auto-hiding edge groups co-exist.

      Parameters

      Returns boolean

    • Reposition a single renderer:'always' panel's overlay over its reference container, optionally forcing it visible. The peek reparents a group's content container into the slide-out overlay; the always-rendered content is not reparented (its parent stays constant); it's re-anchored over the moving container and force-shown for the duration of the peek. clip (viewport rect) clips the overlay to the peek's reveal window so an always panel emerges from the strip's inner edge instead of sliding in from the screen edge; omit it to clear any clip.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods