Class DockviewApi

Active group object.

Active panel object.

Whether redo would do something.

Whether undo would do something. Reactive via onDidChangeHistory.

All group objects.

Height of the component.

The unique identifier for this instance. Used to manage scope of Drag'n'Drop events.

Maximum height of the component.

Maximum width of the component.

The resolved accessibility message catalog (the app's messages overrides merged over the English defaults). Used by parts that surface localisable AT strings, e.g. the default tab's close-button label.

Minimum height of the component.

Minimum width of the component.

Invoked when the active group changes. May be undefined if no group is active.

Invoked when the active panel changes. The event carries the active panel (may be undefined if no panel is active) and the DockviewOrigin ('user' vs 'api') of the change.

Invoked when a group is added. May be called multiple times when moving groups.

Invoked when a panel is added. May be called multiple times when moving panels.

Invoked when a panel is added to a tab group.

Fires when a popout group successfully opens in its own window, carrying the live Window handle. Use it to route focus or attach per-document listeners. Enumerate the current popouts at any time with getPopouts().

Fires whenever the undo/redo stacks change.

Invoked when a tab group is created in any group.

Invoked when a tab group is destroyed in any group.

Invoked when a Drag'n'Drop event occurs that the component was unable to handle. Exposed for custom Drag'n'Drop functionality.

Invoked when any layout change occures, an aggregation of many events.

Invoked after a layout is deserialzied using the fromJSON method.

Fires after each top-level structural layout mutation. See onWillMutateLayout.

Fired when a panel is pinned or unpinned (PinnedTabs module). Carries the panel and its new isPinned state.

Invoked when a group is removed. May be called multiple times when moving groups.

Invoked when a panel is removed. May be called multiple times when moving panels.

Invoked when a panel is removed from a tab group.

Fires when a popout group is removed, whether the user closed its window or it was docked back programmatically. Symmetric with onDidAddPopoutGroup; not fired during component disposal.

Fires when a dragged floating group commits an alignment snap on drop.

Fires when a dragged floating group docks/merges into another on drop.

Invoked when a tab group's properties (label, color) change.

Invoked when a tab group is collapsed or expanded.

Invoked before a group is dragged.

Calling event.nativeEvent.preventDefault() will prevent the group drag starting.

Invoked before a panel is dragged.

Calling event.nativeEvent.preventDefault() will prevent the panel drag starting.

Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and prevent the event from occuring using the standard preventDefault() syntax.

Preventing certain events may causes unexpected behaviours, use carefully.

Fires before each top-level structural layout mutation (add / remove / move / float / popout / maximize / load / clear). Compound operations (e.g. a drag) fire once. Pair with onDidMutateLayout to bracket a change, which is useful for undo/redo, autosave and dirty-tracking.

Invoked before an overlay is shown indicating a drop target.

Calling event.preventDefault() will prevent the overlay being shown and prevent the any subsequent drop event.

All panel objects.

Resolves once any in-flight popout-window restoration completes. Popout windows re-open asynchronously, so after an undo / redo (or fromJSON) that re-opens a popout, await this to know the window is ready. Already-resolved when nothing is restoring.

Total number of groups.

Whether Smart Guides snapping is active (the smartGuides option is present + enabled and the module is registered). Reactive via setSmartGuidesEnabled.

The active tab-group color palette. Reflects the configured tabGroupColors option, or the built-in defaults when unset. Useful for custom chip renderers that want to roll their own picker UI.

Total number of panels.

Width of the component.

Activate the next panel or group, moving focus programmatically. Pass { includePanel: true } to step through the panels of the active group before advancing to the next group.

Activate the previous panel or group, moving focus programmatically. Pass { includePanel: true } to step through the panels of the active group before advancing to the previous group.

Add an edge group at the given position. Returns the group panel API for the newly created group. Throws if a group already exists there.

Add a floating group

Add a group and return the created object.

Add a panel and return the created object.

Add a popout group in a new Window

The nearest grid group in a spatial direction from group, comparing group centre points, e.g. the group visually to the left. Floating and popout groups are ignored. Returns undefined when there is no group in that direction. Pair with group.api.boundingBox to build your own spatial navigation.

Auto-hide (collapse to a strip) the edge group at position.

Reset the component back to an empty and default state.

Drop both undo and redo stacks (e.g. on document switch).

Close all groups and panels.

Release resources and teardown component. Do not call when using framework versions of dockview.

Focus the component. Will try to focus an active panel if one exists.

Create a component from a serialized object.

Get the group panel API for an edge group at the given position. Returns undefined if no edge group is configured at that position.

Get a group object given a string id. May return undefined.

Get a panel object given a string id. May return undefined.

Enumerate the popout groups currently open in their own windows.

Check whether an edge group is currently visible.

Force resize the component to an exact width and height. Read about auto-resizing before using.

Peek (slide out as an overlay, without reflowing the grid) or close the collapsed edge group at position. No-op when the auto-hide module is absent or the group is not collapsed.

Pin (expand) the collapsed edge group at position. Requires the auto-hide edge groups module; no-op when it is absent.

Re-apply the next layout mutation undone via undo.

Remove an edge group and reclaim its slot in the layout. All panels inside the group are disposed. Throws if no group exists at position.

Remove a group and any panels within the group.

Remove a panel given the panel object.

Reveal (create-or-fill) the edge group at position and move the dragged item described by data into it. A newly created edge group tears down to zero footprint when later emptied. Drives the dock-to-edge groups behind the dockToEdgeGroups option; a no-op if edge groups are unavailable.

Set the visibility of an edge group.

Toggle Smart Guides snapping at runtime (no-op when the module is absent).

Create a serialized object of the current component.

Undo the previous recorded layout mutation. No-op when there is nothing to undo, when layoutHistory.enabled is not set, or when the LayoutHistory module is absent.

Merge a partial Smart Guides option override in at runtime.