[BUG] "mod" key with keyup true does not work

[victortimsit]

"mod" key with keyup true does not work but it works with keydown true.

This doesn't log anything

useHotkeys(
    "mod", // Using "mod" doesn't work here, probably a react-hotkeys-hook bug
    () => {
      console.log("mod");
    },
    { keyup: true }
  );

[mvanroon]

@victortimsit Trying using 'meta':

https://codesandbox.io/p/sandbox/determined-joji-wh6s2p?workspaceId=1ce13cfc-e681-42d0-8ecb-a0aa99f09465

[tatwater]

The mod key actually maps to the control key on MacOS instead of command like the docs say. I do not know what it maps to on Windows.

[ajani2001]

I found an interesting workaround for this bug.

If you want to listen to both keyup and keydown events for the mod alias, you can just set ignoreModifiers: true

[ajani2001]

The source problem is that MacOS has modifiers with the same key names (control and meta), but their purpose differs from the purpose of the corresponding keys on other platforms. This is why we want to use the mod alias: the purpose of command on Mac is similar to purpose of ctrl on other platforms.

This bug comes from this line:

react-hotkeys-hook/src/validators.ts

Line 96 in bc55a28

if (!metaKey && !ctrlKey) {

But it is not so easy to fix as it might seem. We cannot get information about either OS or keyboard type from the KeyboardEvent and cannot distinguish between Mac's and other platforms' controls and metas. So, this bug requires deeper change in code to be fixed properly than it might seem. I suppose, we should keep the information about pressed mod somewhere to build the required logic for this alias.