Module dockview-core - v1.8.5

dockview

Zero dependency layout manager supporting tabs, groups, grids and splitviews written in TypeScript

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

Features

Simple splitviews, nested splitviews (i.e. gridviews) supporting full layout managment with dockable and tabular views
Extensive API support at the component level and view level
Themable and customizable
Serialization / deserialization support
Tabular docking and Drag and Drop support
Floating groups, customized header bars and tab
Documentation and examples

Want to inspect the latest deployment? Go to https://unpkg.com/browse/dockview-core@latest/

Quick start

You can install dockview-core from npm.

npm install --save dockview-core

Within your project you must import or reference the stylesheet at dockview-core/dist/styles/dockview.css and attach a theme.

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

You should also attach a dockview theme to an element containing your components. For example:

<body classname="dockview-theme-dark"></body>

Index

Namespaces

DockviewEvent Sizing

Enumerations

DockviewDropTargets LayoutPriority Orientation SashState

Interfaces

ActiveEvent AddComponentOptions AddPaneviewComponentOptions AddSplitviewComponentOptions BaseComponentOptions BaseGridOptions CommonApi DndService DockviewComponentOptions DockviewDndOverlayEvent DockviewDropEvent DockviewEvent DockviewGroupPanelApi DockviewGroupPanelFloatingChangeEvent DockviewPanelApi DockviewRenderFunctions ExpansionEvent FocusEvent FrameworkFactory GridBranchNode GridConstraintChangeEvent GridLeafNode GridPanelViewState GridviewInitParameters GridviewPanelApi GroupDragEvent GroupOptions GroupPanelContentPartInitParameters GroupPanelFrameworkComponentFactory GroupPanelPartInitParameters GroupPanelViewState GroupviewChangeEvent GroupviewDropEvent GroupviewPanelState HeaderPartInitParameters IBaseGrid IBaseView IContentContainer IContentRenderer IDockviewComponent IDockviewDisposable IDockviewGroupPanel IDockviewGroupPanelModel IDockviewPanel IFrameworkPart IGridPanelComponentView IGridPanelView IGridView IGridviewComponent IGridviewPanel IGroupItem IGroupPanelInitParameters IHeader IHeaderActionsRenderer INodeDescriptor IPaneBodyPart IPaneHeaderPart IPanel IPanelDeserializer IPaneview IPaneviewComponent IPaneviewPanel ISerializableView ISerializedBranchNode ISerializedLeafNode ISplitViewDescriptor ISplitviewComponent ISplitviewPanel ISplitviewStyles ITab ITabRenderer IView IViewDeserializer IViewSize IWatermarkRenderer MovementOptions MovementOptions2 PanePanelComponentInitParameter PanePanelInitParameter PanePanelViewState PanelApi PanelConstraintChangeEvent PanelDimensionChangeEvent PanelInitParameters PanelOptions PanelReference PanelSizeEvent PanelUpdateEvent PanelViewInitParameters PaneviewComponentOptions PaneviewDndOverlayEvent PaneviewDropEvent PaneviewPanelApi Parameters SerializedDockview SerializedFloatingGroup SerializedGridObject SerializedGridview SerializedGridviewComponent SerializedPaneview SerializedPaneviewPanel SerializedSplitview SerializedSplitviewPanel SerializedSplitviewPanelData SizeEvent SplitViewOptions SplitviewComponentOptions SplitviewPanelApi TabContextMenuEvent TabDragEvent TitleEvent ViewFactoryData VisibilityEvent WatermarkConstructor WatermarkPartInitParameters WatermarkRendererInitParameters

Type Aliases

AddGroupOptions AddPanelOptions AddPanelPositionOptions ComponentConstructor Direction DistributeSizing DockviewComponentUpdateOptions DockviewGroupPanelLocked GridNode GridviewComponentUpdateOptions IDockviewGroupPanelPublic ISerializedNode InvisibleSizing Position Sizing SplitSizing SplitviewComponentUpdateOptions

Functions

createComponent directionToPosition getDirectionOrientation getGridLocation getLocationOrientation getPaneData getPanelData getRelativeLocation indexInParent isGridBranchNode isGroupOptionsWithGroup isGroupOptionsWithPanel isPanelOptionsWithGroup isPanelOptionsWithPanel orthogonal positionToDirection toTarget

Generated using TypeDoc