Dockview
    Preparing search index...

    Module dockview-core - v7.0.3

    dockview-core

    Framework-agnostic core layout engine — zero dependencies, JavaScript. Supports tabs, groups, grids and splitviews


    npm version npm CI Build Coverage Quality Gate Status Bundle Phobia

    Please see the website: https://dockview.dev

    dockview-core is an internal package. Install dockview instead — the JavaScript JavaScript / TypeScript package that ships the full feature set out of the box. Using a framework? Install the bindings: dockview-react, dockview-vue or dockview-angular.

    • Serialization / deserialization with full layout management
    • Support for split-views, grid-views and 'dockable' views
    • Themeable and customizable
    • Tab and Group docking / Drag n' Drop
    • Touch & mobile support
    • Popout Windows
    • Floating Groups
    • Edge Groups
    • Tab Groups
    • Extensive API
    • Supports Shadow DOMs
    • High test coverage
    • Documentation website with live examples
    • Transparent builds and Code Analysis
    • Security at mind - verified publishing and builds through GitHub Actions

    Install from npm:

    npm install dockview-core
    

    Import the stylesheet:

    @import 'dockview-core/dist/styles/dockview.css';
    

    Create a dockview instance:

    import { DockviewComponent } from 'dockview-core';

    const element = document.getElementById('app');

    const dockview = new DockviewComponent(element, {
    createComponent: (options) => {
    switch (options.name) {
    case 'my-component':
    return {
    init: (params) => {
    params.containerElement.textContent = 'Hello World';
    },
    };
    }
    },
    });

    dockview.addPanel({
    id: 'panel_1',
    component: 'my-component',
    });

    Apply a theme to a parent element:

    <div id="app" class="dockview-theme-dark" style="height: 400px;"></div>
    

    See the documentation for full examples.

    Want to verify our builds? Go here.

    Namespaces

    DockviewDisposable
    DockviewEvent
    Sizing

    Enumerations

    LayoutPriority
    Orientation
    SashState

    Classes

    BaseGrid
    ContentContainer
    DefaultDockviewDeserialzier
    DefaultTab
    DockviewApi
    DockviewComponent
    DockviewCompositeDisposable
    DockviewDidDropEvent
    DockviewEmitter
    DockviewGroupPanel
    DockviewGroupPanelModel
    DockviewMutableDisposable
    DockviewPanel
    DockviewUnhandledDragOverEvent
    DockviewWillDropEvent
    DockviewWillShowOverlayLocationEvent
    DraggablePaneviewPanel
    Gridview
    GridviewApi
    GridviewComponent
    GridviewPanel
    PaneFramework
    PanelTransfer
    PaneTransfer
    Paneview
    PaneviewApi
    PaneviewComponent
    PaneviewPanel
    PaneviewUnhandledDragOverEvent
    Splitview
    SplitviewApi
    SplitviewComponent
    SplitviewPanel
    Tab
    TabGroupColorPalette

    Interfaces

    ActiveEvent
    AddGridviewComponentOptions
    AddPaneviewComponentOptions
    AddSplitviewComponentOptions
    AnnouncementEvent
    BaseComponentOptions
    BaseGridOptions
    Box
    CommonApi
    Constraints
    ContextMenuItemConfig
    CreateComponentOptions
    CreateContextMenuItemComponentOptions
    DockviewActivePanelChangeEvent
    DockviewDndOverlayEvent
    DockviewEvent
    DockviewFrameworkOptions
    DockviewGetTabGroupsOptions
    DockviewGroupActivePanelChangeEvent
    DockviewGroupChangeEvent
    DockviewGroupMoveParams
    DockviewGroupPanelApi
    DockviewGroupPanelCollapsedChangeEvent
    DockviewGroupPanelLocationChangeEvent
    DockviewIDisposable
    DockviewKeybindings
    DockviewLayoutMutationEvent
    DockviewMaximizedGroupChangeEvent
    DockviewMessages
    DockviewModule
    DockviewOptions
    DockviewPanelApi
    DockviewPopoutGroupOptions
    DockviewReadyEvent
    DockviewTabGroupChangeEvent
    DockviewTabGroupColorEntry
    DockviewTabGroupPanelChangeEvent
    DockviewTheme
    DropOverlayModelParams
    EdgeGroupOptions
    ExpansionEvent
    FloatingGroupDragContext
    FloatingGroupOptions
    FocusEvent
    GetTabContextMenuItemsParams
    GetTabGroupChipContextMenuItemsParams
    GridBranchNode
    GridConstraintChangeEvent
    GridLeafNode
    GridPanelViewState
    GridviewFrameworkOptions
    GridviewInitParameters
    GridviewOptions
    GridviewPanelApi
    GroupDragEvent
    GroupPanelPartInitParameters
    GroupviewPanelState
    HeaderPartInitParameters
    IAccessibilityHost
    IAccessibilityService
    IAdvancedDnDHost
    IAdvancedDnDService
    IBaseGrid
    IBaseView
    IContentContainer
    IContentRenderer
    IContextMenuHost
    IContextMenuItemComponentProps
    IContextMenuItemRenderer
    IContextMenuService
    IDockviewComponent
    IDockviewGroupPanel
    IDockviewHeaderActionsProps
    IDockviewPanel
    IDragGhostSpec
    IFrameworkPart
    IGridPanelComponentView
    IGridPanelView
    IGridView
    IGridviewComponent
    IGridviewPanel
    IGroupDragGhostRenderer
    IGroupHeaderProps
    IGroupPanelBaseProps
    IGroupPanelInitParameters
    IHeaderActionsRenderer
    IKeyboardDockingService
    INodeDescriptor
    IPanel
    IPanelDeserializer
    IPanePart
    IPaneview
    IPaneviewComponent
    IPaneviewPanel
    ISerializedBranchNode
    ISerializedLeafNode
    ISplitviewComponent
    ISplitViewDescriptor
    ISplitviewPanel
    ISplitviewStyles
    ITabGroup
    ITabGroupChipRenderer
    ITabGroupChipsHost
    ITabGroupChipsService
    ITabRenderer
    IView
    IViewDeserializer
    IViewSize
    IWatermarkPanelProps
    IWatermarkRenderer
    KeyboardNavigationOptions
    LiveRegionEvent
    MaximizedChanged
    MaximizedViewChanged
    MovementOptions
    MovementOptions2
    MovePanelEvent
    PanelApi
    PanelConstraintChangeEvent
    PanelDimensionChangeEvent
    PanelInitParameters
    PanelOptions
    PanelReference
    PanelSizeEvent
    PanelUpdateEvent
    PanelViewInitParameters
    PanePanelComponentInitParameter
    PanePanelInitParameter
    PanePanelViewState
    PaneviewDidDropEvent
    PaneviewDndOverlayEvent
    PaneviewFrameworkOptions
    PaneviewOptions
    PaneviewPanelApi
    Parameters
    PopoutGroup
    PopoutGroupChangePositionEvent
    PopoutGroupChangeSizeEvent
    RendererChangedEvent
    SerializedDockview
    SerializedEdgeGroups
    SerializedFloatingGroup
    SerializedGridObject
    SerializedGridview
    SerializedGridviewComponent
    SerializedNodeDescriptor
    SerializedPaneview
    SerializedPaneviewPanel
    SerializedPopoutGroup
    SerializedSplitview
    SerializedSplitviewPanel
    SerializedSplitviewPanelData
    SerializedTabGroup
    ServiceCollection
    SizeEvent
    SplitviewFrameworkOptions
    SplitviewOptions
    SplitViewOptions
    SplitviewPanelApi
    TabDragEvent
    TabGroupOptions
    TabPartInitParameters
    TitleEvent
    ViewFactoryData
    VisibilityEvent
    WatermarkRendererInitParameters

    Type Aliases

    AddGroupOptions
    AddPanelOptions
    AddPanelPositionOptions
    AnchoredBox
    AnchorPosition
    BuiltInChipContextMenuItem
    BuiltInContextMenuItem
    ContextMenuItem
    CspNonceProvider
    Direction
    DistributeSizing
    DockviewComponentOptions
    DockviewDndStrategy
    DockviewGroupDropLocation
    DockviewGroupLocation
    DockviewHeaderDirection
    DockviewHeaderPosition
    DockviewLayoutMutationKind
    DockviewOrigin
    DockviewPanelMoveParams
    DockviewPanelRenderer
    DockviewTabGroupCollapsedChangeEvent
    DockviewTabGroupColor
    DockviewTabGroupIndicator
    DroptargetOverlayModel
    EdgeGroupPosition
    GridNode
    GridviewComponentOptions
    GroupNavigationDirection
    IDockviewPanelHeaderProps
    IDockviewPanelProps
    InvisibleSizing
    ISerializedNode
    MeasuredValue
    PaneviewComponentOptions
    Position
    Sizing
    SplitSizing
    SplitviewComponentOptions
    TabAnimation

    Variables

    DEFAULT_TAB_GROUP_COLORS
    LiveRegionModule
    PROPERTY_KEYS_DOCKVIEW
    PROPERTY_KEYS_GRIDVIEW
    PROPERTY_KEYS_PANEVIEW
    PROPERTY_KEYS_SPLITVIEW
    themeAbyss
    themeAbyssSpaced
    themeCatppuccinMocha
    themeCatppuccinMochaSpaced
    themeDark
    themeDracula
    themeGithubDark
    themeGithubDarkSpaced
    themeGithubLight
    themeGithubLightSpaced
    themeLight
    themeLightSpaced
    themeMonokai
    themeNord
    themeNordSpaced
    themeSolarizedLight
    themeSolarizedLightSpaced
    themeVisualStudio

    Functions

    applyTabGroupAccent
    clearRegisteredModules
    createDockview
    createGridview
    createPaneview
    createSplitview
    defineModule
    directionToPosition
    findRelativeZIndexParent
    getDirectionOrientation
    getGridLocation
    getLocationOrientation
    getPaneData
    getPanelData
    getRegisteredModules
    getRelativeLocation
    indexInParent
    isDockviewPackageLoaded
    isGridBranchNode
    isGroupOptionsWithGroup
    isGroupOptionsWithPanel
    isPanelOptionsWithGroup
    isPanelOptionsWithPanel
    markDockviewPackageLoaded
    orthogonal
    positionToDirection
    registerModules
    resolveMessages
    resolveTabGroupAccent
    toTarget