Add required-only modal mode for editor overlays#302290
Open
joshspicer wants to merge 4 commits intomainfrom
Open
Add required-only modal mode for editor overlays#302290joshspicer wants to merge 4 commits intomainfrom
joshspicer wants to merge 4 commits intomainfrom
Conversation
…nd update capabilities for specific editors
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
📬 CODENOTIFYThe following users are being notified based on files changed in this PR: @bpaseroMatched files:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “required-only” modal overlay mode to the workbench editor opening logic, allowing only explicitly-marked editor inputs to open in the modal editor part. This is used to ensure specific editors (e.g. Chat Customizations) can still open modally while reducing modal usage by default.
Changes:
- Introduces
workbench.editor.useModal = 'required-only'and sets it as the stable default (with migration fromessential-only). - Adds
EditorInputCapabilities.RequiresModaland gatesMODAL_GROUPcreation/usage underrequired-only. - Marks the Chat Customizations management editor input as
RequiresModal.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/vs/workbench/services/editor/common/editorGroupFinder.ts | Gates MODAL_GROUP creation under required-only based on a new editor input capability. |
| src/vs/workbench/contrib/chat/browser/aiCustomization/aiCustomizationManagementEditorInput.ts | Flags the Chat Customizations management editor as requiring modal. |
| src/vs/workbench/common/editor.ts | Adds EditorInputCapabilities.RequiresModal capability bit. |
| src/vs/workbench/browser/workbench.contribution.ts | Extends setting schema, updates default, and adds config migration to required-only. |
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+128
to
141
| else if (preferredGroup === MODAL_GROUP) { | ||
| const modalMode = configurationService.getValue<string>('workbench.editor.useModal'); | ||
| if (modalMode === 'required-only') { | ||
| // Only allow modal for editors that explicitly require it | ||
| const editorInput = isEditorInputWithOptions(input) ? input.editor : input; | ||
| if (isEditorInput(editorInput) && editorInput.hasCapability(EditorInputCapabilities.RequiresModal)) { | ||
| group = editorGroupService.createModalEditorPart(options?.modal) | ||
| .then(part => part.activeGroup); | ||
| } | ||
| } else if (modalMode !== 'off') { | ||
| group = editorGroupService.createModalEditorPart(options?.modal) | ||
| .then(part => part.activeGroup); | ||
| } | ||
| } |
Comment on lines
+128
to
+140
| else if (preferredGroup === MODAL_GROUP) { | ||
| const modalMode = configurationService.getValue<string>('workbench.editor.useModal'); | ||
| if (modalMode === 'required-only') { | ||
| // Only allow modal for editors that explicitly require it | ||
| const editorInput = isEditorInputWithOptions(input) ? input.editor : input; | ||
| if (isEditorInput(editorInput) && editorInput.hasCapability(EditorInputCapabilities.RequiresModal)) { | ||
| group = editorGroupService.createModalEditorPart(options?.modal) | ||
| .then(part => part.activeGroup); | ||
| } | ||
| } else if (modalMode !== 'off') { | ||
| group = editorGroupService.createModalEditorPart(options?.modal) | ||
| .then(part => part.activeGroup); | ||
| } |
Collaborator
|
@joshspicer I am moving this to 1.113 since it is targeting main. Please bring it in as a candidate if needed |
bpasero
requested changes
Mar 17, 2026
Member
bpasero
left a comment
bpasero
left a comment
There was a problem hiding this comment.
I do not see the advantage of this over using MODAL_GROUP when opening the editor. What problem is this trying to solve?
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
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.
Lets us use modal for Chat Customizations while it may not be ready for other, existing editors.
Summary
workbench.editor.useModalmode:required-onlyproduct.quality !== 'stable' ? 'some' : 'required-only'EditorInputCapabilities.RequiresModaland gateMODAL_GROUPusage inrequired-onlyRequiresModalsome/allbehavior as supersets and add config migration fromessential-onlytorequired-onlyValidation
npm run compile-check-ts-native