Repository navigation
Bug: (Macos) pressing cmd+c or any shortcut that has cmd in it will break any registered shortcuts unless the window goes blur #576
Description
Suppose we have a sample app like below. Assume <App /> is wrapped with <ShortcutProvider>
Sample application. Please click me!
import { useState, useEffect } from 'react'
import { useShortcut } from 'react-keybind'
import './App.css'
function App() {
const [show, setShow] = useState(false)
const { registerShortcut, unregisterShortcut } = useShortcut()
console.log('hello')
const handleShortcut = (e) => {
console.log(e)
setShow((prev) => !prev)
}
useEffect(() => {
registerShortcut(handleShortcut, ['k'], 'show', 'show')
return () => {
unregisterShortcut(['k'])
}
// eslint-disable-next-line
}, [])
return show ? (
<h1>Shown</h1>
) : (
<h1>Not shown</h1>
)
}
export default AppIf I press the cmd key or press cmd+c, the registered shortcut 'k' stops working. This is not the case in Windows though.
Activity
tlackemann commentedon Oct 7, 2024
Thanks for filing an issue.
Taking a quick look at the sample app attached, there's an issue that could possibly be related.
handleShortcutshould be auseCallbackand passed as a dependency to theuseEffectPast that, the test suite of this library should encompass any edge-cases and they currently pass. If there's an issue with unsetting shortcuts, you're welcome to submit a PR with a failing test case and fix.
whoami-amrit commentedon Oct 8, 2024
I don't mean to
brag orbe rude but not wrapping it in useCallback and not putting it in the dependency array is only a bad practise but it definitely is not the cause of the issue. I am well aware that not putting the callback in the dep array can potentially cause issues (stale functional reference) but that's precisely why I am passing a callback tosetShowinstead of usingshowstate value.The problem might be related to this https://stackoverflow.com/questions/27380018/when-cmd-key-is-kept-pressed-keyup-is-not-triggered-for-any-other-key
To demonstrate this when I am pressing & holding the
cmdkey followed by pressing and holding thekkey. So now I have bothcmd&kon hold. The keydown fired for both. But if I now releasekthere won't be a keyup event for k sincecmdis pressed. So to get the keyup event forkI need to release thecmdkey before releasingk.Looking at the code it seems that you are not clearing the keyDowns array since there is no keyup for
kwhencmdis being held. A simple solution would be to reset the keyDowns ref array after a slight delay irrespective of the keyup event was found or not.This can't be replicated through a testing library because you are firing the events yourself. While irl behaviour is out of the ordinary.
tlackemann commentedon Oct 10, 2024
It's certainly not bragging to be wrong about how to use hooks properly. Regardless, as stated in the original reply, you're welcome to submit a PR with a new test case and fix to address the problem.
whoami-amrit commentedon Oct 14, 2024
Hi ! @tlackemann . I opened a little PR for this issue. Thanks.
algonzale commentedon Oct 17, 2024
Bump. I am experiencing this as well.
tapegram commentedon Nov 20, 2024
Also experiencing this!