Dockview
    Preparing search index...

    Interface PinnedTabsOptions

    interface PinnedTabsOptions {
        compact?: boolean;
        contextMenuItem?: boolean;
        enabled?: boolean;
        mode?: "inline" | "separate-row";
        stickyScroll?: boolean;
        togglePinOnCrossBoundaryDrag?: boolean;
    }
    Index

    Properties

    compact? contextMenuItem? enabled? mode? stickyScroll? togglePinOnCrossBoundaryDrag?

    Properties

    compact?: boolean

    Render pinned tabs icon-only (title + close button hidden), VS-Code / Chrome style. Default false; dockview's default tab has no favicon, so pinned tabs stay labelled (with a pin glyph) unless you opt in. Best enabled alongside a custom tab renderer that shows an icon.

    contextMenuItem?: boolean

    Add a Pin/Unpin item to the tab context menu (requires ContextMenuModule). Default true.

    enabled?: boolean

    Master switch. Default: undefined (dormant; pinning is a no-op).

    mode?: "inline" | "separate-row"

    'inline' (default) keeps pinned tabs first within the existing strip; 'separate-row' renders them on their own VS-Code-style row.

    stickyScroll?: boolean

    In 'inline' mode, keep pinned tabs frozen to the left edge when the tab strip scrolls horizontally (Chrome-style sticky columns); each pinned tab sits at the cumulative width of the pinned tabs before it. Default true; set false to let pinned tabs scroll away with the rest. Ignored in 'separate-row' mode, where the pinned row is always visible.

    togglePinOnCrossBoundaryDrag?: boolean

    Drag a tab across the pin boundary to toggle its pinned state (VS-Code-style). Default false; dragging across the boundary is clamped back, matching Chrome, where pinning is an explicit action only.

    Settings

    Member Visibility

    On This Page

    Properties