fix(core): release key combination presses (#1696)

* fix(core): release key combination presses

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>

* chore(changeset): add

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>

---------

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
Braks
2024-11-13 20:20:43 +01:00
parent 2e2fa9a93c
commit 4b8139da66
2 changed files with 24 additions and 19 deletions
+5
View File
@@ -0,0 +1,5 @@
---
"@vue-flow/core": patch
---
Properly release key combinations when one of the keys is unpressed
+19 -19
View File
@@ -3,6 +3,9 @@ import { onMounted, ref, toRef, toValue, watch } from 'vue'
import type { KeyFilter, KeyPredicate } from '@vueuse/core' import type { KeyFilter, KeyPredicate } from '@vueuse/core'
import { onKeyStroke, useEventListener } from '@vueuse/core' import { onKeyStroke, useEventListener } from '@vueuse/core'
type PressedKeys = Set<string>
type KeyOrCode = 'key' | 'code'
export interface UseKeyPressOptions { export interface UseKeyPressOptions {
actInsideInputWithModifier?: MaybeRefOrGetter<boolean> actInsideInputWithModifier?: MaybeRefOrGetter<boolean>
target?: MaybeRefOrGetter<EventTarget | null | undefined> target?: MaybeRefOrGetter<EventTarget | null | undefined>
@@ -35,18 +38,23 @@ function isKeyMatch(pressedKey: string, keyToMatch: string, pressedKeys: Set<str
return pressedKey.toLowerCase() === keyToMatch.toLowerCase() return pressedKey.toLowerCase() === keyToMatch.toLowerCase()
} }
if (isKeyUp) { // we need to remove the key *after* checking for a match otherwise a combination like 'shift+a' would never get unmatched/reset
pressedKeys.delete(pressedKey.toLowerCase()) if (!isKeyUp) {
} else {
pressedKeys.add(pressedKey.toLowerCase()) pressedKeys.add(pressedKey.toLowerCase())
} }
return keyCombination.every( const isMatch = keyCombination.every(
(key, index) => pressedKeys.has(key) && Array.from(pressedKeys.values())[index] === keyCombination[index], (key, index) => pressedKeys.has(key) && Array.from(pressedKeys.values())[index] === keyCombination[index],
) )
if (isKeyUp) {
pressedKeys.delete(pressedKey.toLowerCase())
}
return isMatch
} }
function createKeyPredicate(keyFilter: string | string[], pressedKeys: Set<string>): KeyPredicate { function createKeyPredicate(keyFilter: string | string[], pressedKeys: PressedKeys): KeyPredicate {
return (event: KeyboardEvent) => { return (event: KeyboardEvent) => {
if (!event.code && !event.key) { if (!event.code && !event.key) {
return false return false
@@ -54,24 +62,17 @@ function createKeyPredicate(keyFilter: string | string[], pressedKeys: Set<strin
const keyOrCode = useKeyOrCode(event.code, keyFilter) const keyOrCode = useKeyOrCode(event.code, keyFilter)
const isKeyUp = event.type === 'keyup'
const pressedKey = event[keyOrCode]
// if the keyFilter is an array of multiple keys, we need to check each possible key combination // if the keyFilter is an array of multiple keys, we need to check each possible key combination
if (Array.isArray(keyFilter)) { if (Array.isArray(keyFilter)) {
return keyFilter.some((key) => isKeyMatch(pressedKey, key, pressedKeys, isKeyUp)) return keyFilter.some((key) => isKeyMatch(event[keyOrCode], key, pressedKeys, event.type === 'keyup'))
} }
// if the keyFilter is a string, we need to check if the key matches the string // if the keyFilter is a string, we need to check if the key matches the string
return isKeyMatch(pressedKey, keyFilter, pressedKeys, isKeyUp) return isKeyMatch(event[keyOrCode], keyFilter, pressedKeys, event.type === 'keyup')
} }
} }
function useKeyOrCode(code: string, keysToWatch: string | string[]) { function useKeyOrCode(code: string, keysToWatch: string | string[]): KeyOrCode {
if (typeof keysToWatch === 'string') {
return code === keysToWatch ? 'code' : 'key'
}
return keysToWatch.includes(code) ? 'code' : 'key' return keysToWatch.includes(code) ? 'code' : 'key'
} }
@@ -133,9 +134,7 @@ export function useKeyPress(keyFilter: MaybeRefOrGetter<KeyFilter | boolean | nu
) )
onKeyStroke( onKeyStroke(
(...args) => { (...args) => currentFilter(...args),
return currentFilter(...args)
},
(e) => { (e) => {
if (isPressed.value) { if (isPressed.value) {
const preventAction = (!modifierPressed || (modifierPressed && !actInsideInputWithModifier.value)) && isInputDOMNode(e) const preventAction = (!modifierPressed || (modifierPressed && !actInsideInputWithModifier.value)) && isInputDOMNode(e)
@@ -144,7 +143,8 @@ export function useKeyPress(keyFilter: MaybeRefOrGetter<KeyFilter | boolean | nu
return return
} }
reset() modifierPressed = false
isPressed.value = false
} }
}, },
{ eventName: 'keyup', target }, { eventName: 'keyup', target },