Interface DockviewOptions

interface DockviewOptions {
    className?: string;
    debug?: boolean;
    defaultRenderer?: "onlyWhenVisible" | "always";
    disableAutoResizing?: boolean;
    disableDnd?: boolean;
    disableFloatingGroups?: boolean;
    disableTabsOverflowList?: boolean;
    dndEdges?: false | DroptargetOverlayModel;
    floatingGroupBounds?: "boundedWithinViewport" | {
        minimumHeightWithinViewport?: number;
        minimumWidthWithinViewport?: number;
    };
    hideBorders?: boolean;
    locked?: boolean;
    noPanelsOverlay?: "emptyGroup" | "watermark";
    popoutUrl?: string;
    rootOverlayModel?: DroptargetOverlayModel;
    scrollbars?: "native" | "custom";
    singleTabMode?: "fullwidth" | "default";
    theme?: DockviewTheme;
}

Hierarchy

  • DockviewOptions

    Properties

    className?: string
    debug?: boolean
    defaultRenderer?: "onlyWhenVisible" | "always"
    disableAutoResizing?: boolean

    Disable the auto-resizing which is controlled through a ResizeObserver. Call .layout(width, height) to manually resize the container.

    disableDnd?: boolean
    disableFloatingGroups?: boolean
    disableTabsOverflowList?: boolean
    dndEdges?: false | DroptargetOverlayModel
    floatingGroupBounds?: "boundedWithinViewport" | {
        minimumHeightWithinViewport?: number;
        minimumWidthWithinViewport?: number;
    }

    Type declaration

    • Optional minimumHeightWithinViewport?: number
    • Optional minimumWidthWithinViewport?: number
    hideBorders?: boolean
    locked?: boolean
    noPanelsOverlay?: "emptyGroup" | "watermark"

    Define the behaviour of the dock when there are no panels to display. Defaults to watermark.

    popoutUrl?: string
    rootOverlayModel?: DroptargetOverlayModel

    Deprecated

    use dndEdges instead. To be removed in a future version.

    scrollbars?: "native" | "custom"

    Select native to use built-in scrollbar behaviours and custom to use an internal implementation that allows for improved scrollbar overlay UX.

    This is only applied to the tab header section. Defaults to custom.

    singleTabMode?: "fullwidth" | "default"

    Generated using TypeDoc