Interface IKeyboardNavigationHost

interface IKeyboardNavigationHost {
    activeGroup: DockviewGroupPanel | undefined;
    activePanel: IDockviewPanel | undefined;
    groups: DockviewGroupPanel[];
    onDidChangePopouts: DockviewEvent<void>;
    onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
    onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>;
    options: DockviewComponentOptions;
    rootElement: HTMLElement;
    adjacentGroup(
        group: DockviewGroupPanel,
        reverse: boolean,
    ): DockviewGroupPanel | undefined;
    adjacentGroupInDirection(
        group: DockviewGroupPanel,
        direction: GroupNavigationDirection,
    ): DockviewGroupPanel | undefined;
    announce(message: string): void;
    dockPanel(
        panel: IDockviewPanel,
        group: DockviewGroupPanel,
        position: Position,
    ): void;
    floatPanel(panel: IDockviewPanel): void;
    getPopoutWindows(): Window[];
    ownsElement(node: Node): boolean;
    showDropPreview(
        group: DockviewGroupPanel,
        position: Position,
    ): DockviewIDisposable;
}

Implemented by

DockviewComponent

Index

Properties

activeGroup activePanel groups onDidChangePopouts onDidMutateLayout onWillMutateLayout options rootElement

Methods

adjacentGroup adjacentGroupInDirection announce dockPanel floatPanel getPopoutWindows ownsElement showDropPreview

Properties

`Readonly`activeGroup

activeGroup: DockviewGroupPanel | undefined

`Readonly`activePanel

activePanel: IDockviewPanel | undefined

`Readonly`groups

groups: DockviewGroupPanel[]

`Readonly`onDidChangePopouts

onDidChangePopouts: DockviewEvent<void>

`Readonly`onDidMutateLayout

onDidMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>

`Readonly`onWillMutateLayout

onWillMutateLayout: DockviewEvent<DockviewLayoutMutationEvent>

Fires before / after a structural layout change; used to restore focus on close.

`Readonly`options

options: DockviewComponentOptions

`Readonly`rootElement

rootElement: HTMLElement

The outermost dockview element (the shell, which also contains edge groups). A getter: it must resolve to the shell once that exists, not the inner gridview, or keydowns from edge groups are missed.

Methods

adjacentGroup

adjacentGroup(
group: DockviewGroupPanel,
reverse: boolean,
): DockviewGroupPanel | undefined
The next / previous group in gridview (spatial) order, wrapping round. This is the one piece of navigation that needs the grid internals. All other focus logic lives in the service, using the public group API.
Parameters
- group: DockviewGroupPanel
- reverse: boolean
Returns DockviewGroupPanel | undefined
- Defined in dockview/moduleContracts.ts:142

adjacentGroupInDirection

adjacentGroupInDirection(
group: DockviewGroupPanel,
direction: GroupNavigationDirection,
): DockviewGroupPanel | undefined
The nearest grid group in a spatial direction; drives Alt+Arrow nav.
Parameters
- group: DockviewGroupPanel
- direction: GroupNavigationDirection
Returns DockviewGroupPanel | undefined
- Defined in dockview/moduleContracts.ts:147

announce

announce(message: string): void
Parameters
- message: string
Returns void
- Defined in dockview/moduleContracts.ts:155

dockPanel

dockPanel(
    panel: IDockviewPanel,
    group: DockviewGroupPanel,
    position: Position,
): void
Parameters
- panel: IDockviewPanel
- group: DockviewGroupPanel
- position: Position
Returns void
- Defined in dockview/moduleContracts.ts:156

floatPanel

floatPanel(panel: IDockviewPanel): void
Float the panel into a new floating group: the keyboard-move "float" terminal action.
Parameters
- panel: IDockviewPanel
Returns void
- Defined in dockview/moduleContracts.ts:162

getPopoutWindows

getPopoutWindows(): Window[]
Live popout Window handles + a signal when that set changes. Keyboard services attach their document listeners to each popout document too, so the keys work inside a popped-out window (a separate document).

Returns Window[]
- Defined in dockview/moduleContracts.ts:128

ownsElement

ownsElement(node: Node): boolean
Does this dock own node, in any of its windows? True when the node is inside the main shell, or inside one of this component's popout documents. Replaces a single-document rootElement.contains so keyboard handling and focus gating recognise events/elements that live in a popout window.
Parameters
- node: Node
Returns boolean
- Defined in dockview/moduleContracts.ts:136

showDropPreview

showDropPreview(
group: DockviewGroupPanel,
position: Position,
): DockviewIDisposable
Parameters
- group: DockviewGroupPanel
- position: Position
Returns DockviewIDisposable
- Defined in dockview/moduleContracts.ts:154