Keyboard shortcuts when focus is not on home.

[mathieu-fournier]

I am looking to add a keyboard shortcut using UIFramework :

The issue I am facing is that the shortcut is only active when the focus is on home.
When the focus is on something else, this is evaluated to false and my keyboard shortcut is ignored.

I want to have generic global keyboards inputs.
I will control when they should be ignored or not.
Is there a way to do that currently ?

I found a workaround by overriding the processShortcutKey function of FrameworkToolAdmin.
But this kinda defeats the whole purpose of having UIFramework handling keyboard shortcuts.

thanks (;

[GerardasB]

Hey, you could either override processShortcutKey of a FrameworkToolAdmin or just process keys in a custom hook since as long as you call UiFramework.keyboardShortcuts.processKey keyboard shortcuts should be handled correctly:

appui/docs/storybook/src/keyboard/KeyboardShortcuts.tsx

Line 103 in cc44ece

UiFramework.keyboardShortcuts.processKey(

[mathieu-fournier]

This works, but it bypasses the whole UIFramework keyboard shortcut handling code.
I would like to use the framework instead of bypassing it and rewriting the keyboard handling code myself.
Something I have in mind that would do the trick is to add a props on KeyboardShortcutProps.
Ex :

[GerardasB]

I would really like to avoid going with this flag route, i.e. what if other applications will determine that they want to process shortcuts only if a specific element is focused (or only if some of the elements are not focused). Maybe instead we need a better logic on when the shortcuts should be handled?

Feel free to extend the FrameworkToolAdmin if you want to keep framework handling and only handle keyboard shortcuts of interest by combining KeyboardShortcutContainer.generateKeyMapKey and UiFramework.keyboardShortcuts.getShortcut (fallback to FrameworkToolAdmin for all other shortcuts)

[mathieu-fournier]

Opened a issue :
#819