Module dockview-core - v3.0.2

dockview

Zero dependency layout manager supporting tabs, groups, grids and splitviews. Supports React, Vue and Vanilla TypeScript

npm version npm CI Build Coverage Quality Gate Status Bundle Phobia

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

Features

  • 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
  • Popout Windows
  • Floating Groups
  • Extensive API
  • Supports Shadow DOMs
  • High test coverage
  • Documentation website with live examples
  • Transparent builds and Code Analysis
  • Security at mind - verifed publishing and builds through GitHub Actions

Want to verify our builds? Go here.

Index

Namespaces

DockviewDisposable DockviewEvent Sizing

Enumerations

LayoutPriority Orientation SashState

Classes

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

Interfaces

ActiveEvent AddComponentOptions AddPaneviewComponentOptions AddSplitviewComponentOptions BaseComponentOptions BaseGridOptions CommonApi Contraints CreateComponentOptions DockviewDndOverlayEvent DockviewEvent DockviewFrameworkOptions DockviewGroupChangeEvent DockviewGroupMoveParams DockviewGroupPanelApi DockviewGroupPanelFloatingChangeEvent DockviewIDisposable DockviewMaximizedGroupChanged DockviewOptions DockviewPanelApi DockviewPopoutGroupOptions DockviewReadyEvent ExpansionEvent FloatingGroupOptions FloatingGroupOptionsInternal FocusEvent GridBranchNode GridConstraintChangeEvent GridLeafNode GridPanelViewState GridviewFrameworkOptions GridviewInitParameters GridviewOptions GridviewPanelApi GroupDragEvent GroupOptions GroupPanelPartInitParameters GroupPanelViewState GroupviewPanelState HeaderPartInitParameters IBaseGrid IBaseView IContentContainer IContentRenderer IDockviewComponent IDockviewGroupPanel IDockviewGroupPanelModel IDockviewHeaderActionsProps IDockviewPanel IFrameworkPart IGridPanelComponentView IGridPanelView IGridView IGridviewComponent IGridviewPanel IGroupHeaderProps IGroupPanelBaseProps IGroupPanelInitParameters IHeader IHeaderActionsRenderer INodeDescriptor IPanePart IPanel IPanelDeserializer IPaneview IPaneviewComponent IPaneviewPanel ISerializedBranchNode ISerializedLeafNode ISplitViewDescriptor ISplitviewComponent ISplitviewPanel ISplitviewStyles ITabRenderer IView IViewDeserializer IViewSize IWatermarkPanelProps IWatermarkRenderer MaximizedChanged MaximizedViewChanged MovePanelEvent MovementOptions MovementOptions2 PanePanelComponentInitParameter PanePanelInitParameter PanePanelViewState PanelApi PanelConstraintChangeEvent PanelDimensionChangeEvent PanelInitParameters PanelOptions PanelReference PanelSizeEvent PanelUpdateEvent PanelViewInitParameters PaneviewDndOverlayEvent PaneviewDropEvent PaneviewFrameworkOptions PaneviewOptions PaneviewPanelApi Parameters RendererChangedEvent SerializedDockview SerializedFloatingGroup SerializedGridObject SerializedGridview SerializedGridviewComponent SerializedNodeDescriptor SerializedPaneview SerializedPaneviewPanel SerializedPopoutGroup SerializedSplitview SerializedSplitviewPanel SerializedSplitviewPanelData SizeEvent SplitViewOptions SplitviewFrameworkOptions SplitviewOptions SplitviewPanelApi TabContextMenuEvent TabDragEvent TitleEvent ViewFactoryData VisibilityEvent WatermarkRendererInitParameters

Type Aliases

AddGroupOptions AddPanelOptions AddPanelPositionOptions Direction DistributeSizing DockviewComponentOptions DockviewGroupDropLocation DockviewGroupLocation DockviewGroupPanelLocked DockviewPanelMoveParams DockviewPanelRenderer DroptargetOverlayModel GridNode GridviewComponentOptions IDockviewGroupPanelPublic IDockviewPanelHeaderProps IDockviewPanelProps ISerializedNode InvisibleSizing MeasuredValue PaneviewComponentOptions Position Sizing SplitSizing SplitviewComponentOptions

Variables

PROPERTY_KEYS_DOCKVIEW PROPERTY_KEYS_GRIDVIEW PROPERTY_KEYS_PANEVIEW PROPERTY_KEYS_SPLITVIEW

Functions

createDockview createGridview createPaneview createSplitview directionToPosition getDirectionOrientation getGridLocation getLocationOrientation getPaneData getPanelData getRelativeLocation indexInParent isGridBranchNode isGroupOptionsWithGroup isGroupOptionsWithPanel isPanelOptionsWithGroup isPanelOptionsWithPanel orthogonal positionToDirection toTarget

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc