Enable shortcut while CommandPalette is open #8586

ghost · 2020-12-14T19:59:50Z

This commit introduces direct shortcut dispatch to TerminalPage, which
allows it to respond to key bindings before the command palette.

This allows the user to use shortcuts from the command palette while
it's open.

Closes #6679

DHowett · 2020-12-14T20:02:02Z

You may need @Don-Vito's help since he removed _dispatch from the command palette!

Don-Vito · 2020-12-14T22:36:14Z

@Hegunumo - please let me know if I can be useful 😊

zadjii-msft

ghost · 2020-12-16T07:56:51Z

@Don-Vito I'm trying to include AppLogic.h into CommandPalette.cpp, but I keep getting error. I know this might be a trivial thing.

Don-Vito · 2020-12-16T08:35:56Z

@Don-Vito I'm trying to include AppLogic.h into CommandPalette.cpp, but I keep getting error. I know this might be a trivial thing.

@Hegunumo -
* Currently the dispatching logic has moved to TerminalPage - please see TerminalPage::_OnDispatchCommandRequested and TerminalPage::_OnCommandLineExecutionRequested for example.
* The idea behind this is that CommandPalette is becoming a control stripped of business logic
* One of the benefits if this approach is that TerminalPage already has _settings and you don't need to load it.
* I believe that what we can do is to register another event to CommandPalette in TerminalPage::Create

UPDATE: please see comment below for what I believe is much better approach

Don-Vito · 2020-12-16T08:57:42Z

@Hegunumo - I reviewed the solution and did a small PoC. Since key down sends RoutedEvent we can handle it at the relevant element in the hierarchy. Which means we can apply the following logic:

As today, CommandPalette intercepts the key down events to see if the key was intended to it (e.g., navigation within palette)
CommandPalette does not handle events that are not intended to it
TerminalPage catches the event and handles if it has a relevant KeyBinding.

This approach will also solve the problems like:

KeyBindings are not working when search control is open.
KeyBindings are not working when menu is open.

So my suggested approach is:

Register KeyDownHandler in TerminalPage that does the logic that you have written
Remove the _bindings completely from the Palette
Enjoy viewing how the bindings work from every place in UI

And the handling in the TerminalPage::_KeyDownHandler will be quite straightforward. Something like:

const auto actionAndArgs = _settings.KeyMap().TryLookup(kc);
if (actionAndArgs)
{
   if (CommandPalette().Visibility() == Visibility::Visible && actionAndArgs.Action() != ShortcutAction::ToggleCommandPalette)
   {
            CommandPalette().Visibility(Visibility::Collapsed);
   }
   _actionDispatch->DoAction(actionAndArgs);
   e.Handled(true);
}

@zadjii-msft - FYI. This will extend this contribution into "Make key bindings universally available" 💪

ghost · 2020-12-17T08:19:50Z

@Don-Vito It wored! Please review.

Don-Vito

Besides the small nit, looks great. But might be a bit confusing, since in the tabswitcher mode the binding is still handled by Palette.

If possible, I would suggest to remove the _bindings entirely from CommandPaltte (I mean delete _bindings attribute from palette and its usages in CommandPaltte::SetKeyBindings and CommandPaltte::_keyDownHandler)

Don-Vito · 2020-12-17T13:14:15Z

src/cascadia/TerminalApp/TerminalPage.cpp

+    // - e: the KeyRoutedEventArgs containing info about the keystroke.
+    // Return Value:
+    // - <none>
+    void TerminalPage::_CommandPaletteKeyDownHandler(Windows::Foundation::IInspectable const& /*sender*/, Windows::UI::Xaml::Input::KeyRoutedEventArgs const& e)


Consider renaming this into _KeyDownHandler because it now serves the TerminalPage in general: it runs the bindings no matter where you are. It does have a specific logic for CommandPalette, but tomorrow we will probably want to do more stuff.

zadjii-msft · 2020-12-17T13:48:54Z

Just playing with this, it feels really good. I'm a little shocked that this doesn't work for the new tab dropdown. Maybe that's not technically a child of the TerminalPage - I think flyouts might technically have some other crazy XAML root that lets them escape the window confines.

I'll double check the code now, but from a UX perspective this seems good to me

zadjii-msft

Okay yea I only have the same nit as Don-Vito. Thanks for doing this!

DHowett

I am concerned. Does this break preview mode? The tab switcher UI that Ctrl-Tab activates relies on commands to be dispatched without the palette being hidden. Will this force the command palette to be hidden when it should not be?

Otherwise, this is exactly what I wanted. I have always wanted us to move the key binding handler into TerminalPage!!

Don-Vito · 2020-12-18T09:13:38Z

@Hegunumo - wait 😊. The palette should collapse (it is ephemeral, if we don't collapse it might show invalid data). What @DHowett means is to make sure that the Palette is not collapsed in the tab switcher mode (especially when custom keybindings are used).

Don-Vito · 2020-12-18T09:51:09Z

To @DHowett's initial concern - Control+Tab is handled explicitly in CommandPalette::_previewKeyDownHandler - so it will work.

And for my concern it appears that custom bindings are not triggering TabSwitcher.

So @Hegunumo's original solution works (before he removed the collapsing of the palette).

I still strongly recommend removing the _bindings from Palette - but we can do it in a follow-up PR.

DHowett

Thank you for testing it and for explaining it. @Hegunumo, good work!

ghost · 2020-12-18T17:09:11Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

This reverts commit 01a0490.

Following up #8586 by @Hegunumo, fully remove the command dispatching logic from Command Palette. Currently Command Palette might dispatch command in Tab Switcher mode. This leads to several inconsistencies: * Only the commands with the same key modifier as an ATS anchor will be issued * This command will not close the TabSwitcher (while commands issued from TerminalPage do). Implementation details: * Pass KeyMapping rather than binding to CommandPalette * Use this mapping inside previewKeyDownHandler of ATS to detect if previous tab or next tab bindings were engaged. No need to handle Ctrl+Tab explicitly anymore - it is handled as any other binding. * Cleanup the logic in TerminalPage::_SelectNextTab that checks if CommandPalette is visible. It is not required anymore, as visible palette would intercept the call. * Remove dependency of TerminalPage on AppLogic that was introduced lately .

This commit introduces direct shortcut dispatch to TerminalPage, which allows it to respond to key bindings before the command palette. This allows the user to use shortcuts from the command palette while it's open. Closes microsoft#6679

…8628) Following up microsoft#8586 by @Hegunumo, fully remove the command dispatching logic from Command Palette. Currently Command Palette might dispatch command in Tab Switcher mode. This leads to several inconsistencies: * Only the commands with the same key modifier as an ATS anchor will be issued * This command will not close the TabSwitcher (while commands issued from TerminalPage do). Implementation details: * Pass KeyMapping rather than binding to CommandPalette * Use this mapping inside previewKeyDownHandler of ATS to detect if previous tab or next tab bindings were engaged. No need to handle Ctrl+Tab explicitly anymore - it is handled as any other binding. * Cleanup the logic in TerminalPage::_SelectNextTab that checks if CommandPalette is visible. It is not required anymore, as visible palette would intercept the call. * Remove dependency of TerminalPage on AppLogic that was introduced lately .

zadjii-msft assigned ghost Dec 15, 2020

zadjii-msft requested changes Dec 15, 2020

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 15, 2020

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 16, 2020

Handles keyBindings from TerminalPage instead of CommandPalette

f0bfe96

Don-Vito reviewed Dec 17, 2020

View reviewed changes

zadjii-msft approved these changes Dec 17, 2020

View reviewed changes

zadjii-msft added the Needs-Second It's a PR that needs another sign-off label Dec 17, 2020

ghost requested review from miniksa, carlos-zamora, DHowett, leonMSFT and PankajBhojwani December 17, 2020 13:57

change name

ca70f0b

DHowett requested changes Dec 18, 2020

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 18, 2020

palette won't collapse

99f4b66

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Dec 18, 2020

reverting

24cf0ff

DHowett approved these changes Dec 18, 2020

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Dec 18, 2020

ghost merged commit 01a0490 into microsoft:main Dec 18, 2020

Don-Vito mentioned this pull request Dec 20, 2020

Completely remove action dispatching from Command Palette #8628

Merged

MycroftKang added a commit to MycroftKang/terminal that referenced this pull request Dec 27, 2020

Revert "Enable shortcut while CommandPalette is open (microsoft#8586)"

c126d2e

This reverts commit 01a0490.

Don-Vito mentioned this pull request Jan 3, 2021

Find command doesn't reset search text if Find box is open #8671

Closed

zadjii-msft mentioned this pull request Aug 19, 2021

[Functional-Command Palette]- User is not able to perform action using shortcuts when command palette is open. #7914

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable shortcut while CommandPalette is open #8586

Enable shortcut while CommandPalette is open #8586

ghost commented Dec 14, 2020 •

edited by DHowett

DHowett commented Dec 14, 2020

Don-Vito commented Dec 14, 2020

zadjii-msft left a comment

ghost commented Dec 16, 2020

Don-Vito commented Dec 16, 2020 •

edited

Don-Vito commented Dec 16, 2020 •

edited

ghost commented Dec 17, 2020

Don-Vito left a comment •

edited

Don-Vito Dec 17, 2020

zadjii-msft commented Dec 17, 2020

zadjii-msft left a comment

DHowett left a comment

Don-Vito commented Dec 18, 2020 •

edited

Don-Vito commented Dec 18, 2020

DHowett left a comment

ghost commented Dec 18, 2020

Enable shortcut while CommandPalette is open #8586

Enable shortcut while CommandPalette is open #8586

Conversation

ghost commented Dec 14, 2020 • edited by DHowett

DHowett commented Dec 14, 2020

Don-Vito commented Dec 14, 2020

zadjii-msft left a comment

Choose a reason for hiding this comment

ghost commented Dec 16, 2020

Don-Vito commented Dec 16, 2020 • edited

Don-Vito commented Dec 16, 2020 • edited

ghost commented Dec 17, 2020

Don-Vito left a comment • edited

Choose a reason for hiding this comment

Don-Vito Dec 17, 2020

Choose a reason for hiding this comment

zadjii-msft commented Dec 17, 2020

zadjii-msft left a comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

Don-Vito commented Dec 18, 2020 • edited

Don-Vito commented Dec 18, 2020

DHowett left a comment

Choose a reason for hiding this comment

ghost commented Dec 18, 2020

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented Dec 14, 2020 •

edited by DHowett

Don-Vito commented Dec 16, 2020 •

edited

Don-Vito commented Dec 16, 2020 •

edited

Don-Vito left a comment •

edited

Don-Vito commented Dec 18, 2020 •

edited

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.