Dockview
    Preparing search index...

    Interface IPinnedTabsHost

    The narrow surface the pinned-tabs service reads from the host (DockviewComponent). Pinned state itself lives on the panel (panel.api.isPinned, mutated through the gated DockviewComponent.setPanelPinned); the module only observes pinned-state changes and re-orders each group's tab strip so pinned tabs render first. No layout or sizing is touched.

    interface IPinnedTabsHost {
        id: string;
        onDidAddGroup: DockviewEvent<DockviewGroupPanel>;
        onDidLayoutFromJSON: DockviewEvent<void>;
        onDidOptionsChange: DockviewEvent<void>;
        onDidPanelPinnedChange: DockviewEvent<DockviewPanelPinnedChangeEvent>;
        onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>;
        onDidRemovePanel: DockviewEvent<IDockviewPanel>;
        options: DockviewComponentOptions;
    }
    Index

    Properties

    id onDidAddGroup onDidLayoutFromJSON onDidOptionsChange onDidPanelPinnedChange onDidRemoveGroup onDidRemovePanel options

    Properties

    id: string

    The owning component's id: the viewId a within-component drag payload (PanelTransfer) carries, so the pinned second row can originate a drag the main strip's drop targets accept.

    onDidAddGroup: DockviewEvent<DockviewGroupPanel>
    onDidLayoutFromJSON: DockviewEvent<void>

    Fires after a fromJSON restore completes; the service seeds its pinned store from the restored panels' isPinned flags and re-asserts the invariant.

    onDidOptionsChange: DockviewEvent<void>

    Fires after updateOptions; the service re-applies the pinned-tabs presentation (mode / sticky) to every existing group so a runtime pinnedTabs change takes effect. New groups pick it up in onDidAddGroup; this retrofits the ones that already exist.

    onDidPanelPinnedChange: DockviewEvent<DockviewPanelPinnedChangeEvent>

    Fires after a panel's pinned flag is mutated via the gated setPanelPinned; the service's sole trigger to re-order the strip.

    onDidRemoveGroup: DockviewEvent<DockviewGroupPanel>
    onDidRemovePanel: DockviewEvent<IDockviewPanel>

    Fires when a panel is removed; the service prunes it from its pinned bookkeeping so a closed pinned panel's id can't leak.

    options: DockviewComponentOptions

    Settings

    Member Visibility

    On This Page

    Properties