docs: add dedicated Context menus page#1424
Merged
Merged
Conversation
Add packages/docs/docs/core/panels/contextMenus.mdx covering the enterprise tab and chip context menu APIs (getTabContextMenuItems and getTabGroupChipContextMenuItems): built-in item shortcuts, custom label/component/element items, disabled items, and per-case suppression. The whole ContextMenuModule lives in dockview-enterprise, so the page is marked enterprise and the previously-free "Tab context menus" row in the feature comparison is corrected to enterprise-only. Link the new page from features.mdx and editions.mdx. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VgsaWoFVNNt4XKX864aDVD
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The docs had no dedicated page for the context menu feature, despite it shipping runnable example templates for all four frameworks and being registered on the examples page. It was only mentioned in passing in
features.mdx,editions.mdx, and the tab-groups page.This adds a dedicated Context menus page and corrects the feature-comparison table. The entire
ContextMenuModuleis defined only indockview-enterprise(packages/dockview-enterprise/src/contextMenu.ts), so bothgetTabContextMenuItemsandgetTabGroupChipContextMenuItemsare no-ops without the enterprise package. The comparison table previously (incorrectly) listed "Tab context menus" as a free feature.Changes:
packages/docs/docs/core/panels/contextMenus.mdx(enterprise: true), covering:<CodeRunner id="dockview/context-menu" />examplegetTabContextMenuItems): params, all built-in shortcuts (close,closeOthers,closeAll,closeLeft/Right,maximize,float,popout,pin,separator), custom label/action items, disabled items, custom component items (IContextMenuItemComponentPropswithclose()), and rawelementitems, with React/Vue/Angular/JS variantsgetTabGroupChipContextMenuItems): built-in items (rename,colorPicker,collapse,close,separator), cross-linked to Tab groups[])DocRefAPI tables across all four frameworks, following the existingtabGroups.mdxconventionsfeatures.mdx: "Tab context menus" is now enterprise-only, and both context-menu rows link to the new pageeditions.mdxenterprise listType of change
Affected packages
docsHow to test
DocRefAPI tables populate for React/Vue/Angular/JavaScript.Checklist
docspackage is deliberately excluded from Prettier/format checks)🤖 Generated with Claude Code
Generated by Claude Code