monaco-quick-input-service: set context key "inQuickOpen" #12377
Conversation
This file contains 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
Context Key "inQuickOpen" exists in vscode and its value (true or false) reflects whether the Quick Open, AKA Quick input, is currently open/visible or not. This context key can be useful in Theia too, e.g. it can be used in the "when" clause of commands registered by vscode extensions, or programmatically whenever it's useful to know the state of the Quick Open UI. Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
added
monaco
marcdumais-work
force-pushed
the
inQuickOpen_contextKey
branch
from
b3c87ba
to
de62015
Compare
Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
force-pushed
the
inQuickOpen_contextKey
branch
from
de62015
to
38c2e92
Compare
Comment on lines
103
to
107
| setContextKey(key: string | undefined): void { | ||
| if (key) { | ||
| this.contextKeyService.createKey<string>(key, undefined); | ||
| this.contextKey = this.contextKeyService.createKey<string>(key, undefined); | ||
| } | ||
| } |
There was a problem hiding this comment.
I believe this method is meant for callers, and it may be problematic for us to set the contextKey variable especially since we later rely on it for the inQuickOpen.
There was a problem hiding this comment.
For reference VS Code does not keep a single key stored in this case, but a map of them:
- https://github.com/microsoft/vscode/blob/34d69db22caab3d00c6752bc7a8681239bc0c5d2/src/vs/platform/quickinput/browser/quickInputService.ts#L56
- https://github.com/microsoft/vscode/blob/34d69db22caab3d00c6752bc7a8681239bc0c5d2/src/vs/platform/quickinput/browser/quickInputService.ts#L121-L147
Comment on lines
180
to
186
| private initController(): void { | ||
| this.controller = new QuickInputController(this.getOptions()); | ||
| this.setContextKey('inQuickOpen'); | ||
| this.onShow(() => { this.contextKey.set(true); }); | ||
| this.onHide(() => { this.contextKey.set(false); }); | ||
| this.updateLayout(); | ||
| } |
There was a problem hiding this comment.
In addition to the previous comment, I think we can simplify and use the following which is present in other areas of the framework, where we register listeners in the postConstruct:
+ protected inQuickOpen: ContextKey<boolean>;
@postConstruct()
protected init(): void {
this.initContainer();
this.initController();
+ this.inQuickOpen = this.contextKeyService.createKey<boolean>('inQuickOpen', false);
+ this.onShow(() => { this.inQuickOpen.set(true); });
+ this.onHide(() => { this.inQuickOpen.set(false); })
This was referenced Apr 14, 2023
|
Closing in favor of #12427 - thanks @FernandoAscencio ! |
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.
What it does
Context Key ""inQuickOpen"" exists in vscode and its value (true or false) reflects whether the Quick Open, AKA Quick Input, is currently open/visible or not.
This context key can be useful in Theia too, e.g. it can be used in the "when" clause of commands registered by vscode extensions, or set programmatically whenever it's useful to know the state of the Quick Open UI.
How to test
I have provided a test in the browser suite. Confirm that CI passes.
Review checklist
Reminder for reviewers