Interface DockviewOptions

interface DockviewOptions {
    className?: string;
    debug?: boolean;
    defaultRenderer?: "onlyWhenVisible" | "always";
    disableAutoResizing?: boolean;
    disableDnd?: boolean;
    disableFloatingGroups?: boolean;
    floatingGroupBounds?: "boundedWithinViewport" | {
        minimumHeightWithinViewport?: number;
        minimumWidthWithinViewport?: number;
    };
    gap?: number;
    hideBorders?: boolean;
    locked?: boolean;
    noPanelsOverlay?: "emptyGroup" | "watermark";
    popoutUrl?: string;
    rootOverlayModel?: DroptargetOverlayModel;
    singleTabMode?: "fullwidth" | "default";
}

Hierarchy

  • DockviewOptions

    Properties

    className? debug? defaultRenderer? disableAutoResizing? disableDnd? disableFloatingGroups? floatingGroupBounds? gap? hideBorders? locked? noPanelsOverlay? popoutUrl? rootOverlayModel? singleTabMode?

    Properties

    Optional className

    className?: string

    Optional debug

    debug?: boolean

    Optional defaultRenderer

    defaultRenderer?: "onlyWhenVisible" | "always"

    Optional disableAutoResizing

    disableAutoResizing?: boolean

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

    Optional disableDnd

    disableDnd?: boolean

    Optional disableFloatingGroups

    disableFloatingGroups?: boolean

    Optional floatingGroupBounds

    floatingGroupBounds?: "boundedWithinViewport" | {
        minimumHeightWithinViewport?: number;
        minimumWidthWithinViewport?: number;
    }

    Type declaration

    • Optional minimumHeightWithinViewport?: number
    • Optional minimumWidthWithinViewport?: number

    Optional gap

    gap?: number

    Pixel gap between groups

    Optional hideBorders

    hideBorders?: boolean

    Optional locked

    locked?: boolean

    Optional noPanelsOverlay

    noPanelsOverlay?: "emptyGroup" | "watermark"

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

    Optional popoutUrl

    popoutUrl?: string

    Optional rootOverlayModel

    rootOverlayModel?: DroptargetOverlayModel

    Optional singleTabMode

    singleTabMode?: "fullwidth" | "default"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc