feat!: deprecate scopeType and include focusedNode in context menu options #8882
Conversation
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
maribethb
commented
Apr 14, 2025
| if (item.scopeType === ScopeType.COMMENT && !scope.comment) continue; | ||
| if (item.scopeType === ScopeType.WORKSPACE && !scope.workspace) | ||
| continue; | ||
| } |
Contributor
Author
There was a problem hiding this comment.
github is not showing a good diff, the only difference from this point on is that the if statement ends here and everything else is unindented correspondingly
Collaborator
There was a problem hiding this comment.
Much better with Hide Whitespace on:
maribethb
added
breaking change
gonfunko
approved these changes
Apr 15, 2025
maribethb
merged commit acca9ea
into
RaspberryPiFoundation:rc/v12.0.0
7 of 12 checks passed
1 task
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The basics
The details
Resolves
Fixes #8838 and works on #8839 - the latter can be closed once the work on
IFocusableNodehas settled a bit more and we can removeanyfrom the type inScopehere. Currently it can't be removed becauseBlockSvgand friends don't actually implement that interface yet (Ben has a PR in progress).Proposed Changes
scopeTypeoptional inContextMenuItemAPIgetContextMenuOptionsto no longer accept ascopeTypeparameterfocusedNodetoScopetypeReason for Changes
Breaking Changes
This is only a breaking change if you call
ContextMenuRegistry.registry.getContextMenuOptions. The other changes in this PR are backwards-compatible with your existing registered context menu items, though you may wish to read the documentation and update them to the new API.If you do call
getContextMenuOptions, update your usage to no longer pass thescopeTypeparam, and include the object that is having its menu opened in thescope.focusedNodeproperty. See the implementations in this PR for examples.