Overview
The Vertical Tabs API enables other Obsidian plugins to integrate with and extend Vertical Tabs functionality. You can customize tabs and groups, listen to workspace events, and add custom menu items.
Notice
The Vertical Tabs API is currently in beta and requires a subscription to the Beta Program.
Plugin developers: If you want to use the API and integrate your plugin with Vertical Tabs, please complete this form to request free access.
Users: If you want to try out the API features, please subscribe to the Beta Program. All users will receive a free update at a later date. For more information, please refer to the Beta Program documentation and the Roadmap.
Getting started
Start with the Getting Started guide to learn how to access and use the API in your plugin.
Documentation
- Getting Started - Installation and basic usage
- Safe API Access - Robust patterns for accessing the API
- Customization - Customize tabs and groups
- Events - Subscribe to workspace events
- Menus - Add custom menu items
- Utilities - Work with tabs and groups
Requirements
- Obsidian 1.10.0 or later
- Vertical Tabs plugin 0.20.0 or later installed and enabled
- TypeScript knowledge for plugin development
API versioning
The API follows semantic versioning. Check the current version:
const version = api.getVersion();
console.log("API version:", version);Type definitions
Install type definitions for TypeScript development:
npm install obsidian-vertical-tabs-apiSupport
If you encounter issues or have questions about the API: