Dockview
    Preparing search index...

    Interface IPinnedTabsService

    Pinned-tabs module service. Its presence is what DockviewComponent.setPanelPinned checks (via assertModule) before mutating pinned state; the pinned-first ordering is enforced internally and reactively as panels are pinned/unpinned, added, or moved.

    interface IPinnedTabsService {
        dispose(): void;
        enforceOrder(group: DockviewGroupPanel): void;
        isExcludedFromOverflow(panelId: string): boolean;
        resolveDropIndex(
            group: DockviewGroupPanel,
            panelId: string,
            index: number,
        ): number;
    }

    Hierarchy (View Summary)

    Index

    Methods

    dispose enforceOrder isExcludedFromOverflow resolveDropIndex

    Methods

    • Pure predicate (handed to each group's Tabs); true keeps the panel out of the overflow dropdown.

      Parameters

      • panelId: string

      Returns boolean

    • Clamp/redirect a proposed header drop index against the group's pin boundary so the dragged panel lands on the correct side. May flip the panel's pinned state instead of clamping when togglePinOnCrossBoundaryDrag is enabled.

      Parameters

      Returns number

    Settings

    Member Visibility

    On This Page

    Methods