Obsidian Plugin Workspace

This skill covers the Obsidian workspace API: how panes are organized into splits and tabs, how to create and manage WorkspaceLeaf instances, how to build custom views, and how to react to workspace-level events. It is the reference for anything related to layout, views, and pane lifecycle.

When to Use This Skill

• Creating a custom view (sidebar panel, modal-like pane, or editor replacement)
• Managing where panes open (root split, left/right sidebar, pop-out windows)
• Understanding the relationship between WorkspaceLeaf, WorkspaceSplit, and WorkspaceTabs
• Reacting to focus changes (active-leaf-change), file opens (file-open), or layout changes (layout-change)
• Implementing linked panes that scroll together
• Working with deferred tabs (Obsidian v1.7.2+)
• Opening files in specific locations with getLeaf(), getLeftLeaf(), getRightLeaf(), or createLeafInParent()

Overview

Obsidian's UI is a tree of workspace items. At the root is a WorkspaceRoot (or a WorkspaceWindow for pop-outs). It contains WorkspaceSplit nodes that recursively divide the screen vertically or horizontally. The leaves of this tree are WorkspaceTabs containers, each of which holds one or more WorkspaceLeaf instances. Every leaf hosts exactly one View.