refactor(core): support key combinations for key codes
Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
@@ -1,13 +1,10 @@
|
|||||||
import type { Ref } from 'vue'
|
import type { Ref } from 'vue'
|
||||||
import type { KeyFilter, MaybeRef } from '@vueuse/core'
|
import type { KeyFilter, KeyPredicate, MaybeRef } from '@vueuse/core'
|
||||||
import { isBoolean, isFunction } from '@vueuse/core'
|
import { isBoolean, isFunction } from '@vueuse/core'
|
||||||
|
|
||||||
export function isInputDOMNode(event: KeyboardEvent): boolean {
|
export function isInputDOMNode(event: KeyboardEvent): boolean {
|
||||||
const target = (event.composedPath?.()?.[0] || event.target) as HTMLElement
|
const target = (event.composedPath?.()?.[0] || event.target) as HTMLElement
|
||||||
|
|
||||||
// we want to be able to do a multi selection event if we are in an input field
|
|
||||||
if (event.ctrlKey || event.metaKey || event.shiftKey) return false
|
|
||||||
|
|
||||||
const hasAttribute = isFunction(target.hasAttribute) ? target.hasAttribute('contenteditable') : false
|
const hasAttribute = isFunction(target.hasAttribute) ? target.hasAttribute('contenteditable') : false
|
||||||
|
|
||||||
const closest = isFunction(target.closest) ? target.closest('.nokey') : null
|
const closest = isFunction(target.closest) ? target.closest('.nokey') : null
|
||||||
@@ -16,17 +13,40 @@ export function isInputDOMNode(event: KeyboardEvent): boolean {
|
|||||||
return ['INPUT', 'SELECT', 'TEXTAREA'].includes(target?.nodeName) || hasAttribute || !!closest
|
return ['INPUT', 'SELECT', 'TEXTAREA'].includes(target?.nodeName) || hasAttribute || !!closest
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// we want to be able to do a multi selection event if we are in an input field
|
||||||
|
function wasModifierPressed(event: KeyboardEvent) {
|
||||||
|
return event.ctrlKey || event.metaKey || event.shiftKey
|
||||||
|
}
|
||||||
|
|
||||||
|
function createKeyPredicate(keyFilter: KeyFilter, pressedKeys: Set<string>): KeyPredicate {
|
||||||
|
return (event: KeyboardEvent) =>
|
||||||
|
(keyFilter as string[]).some((key) => {
|
||||||
|
const keyCombination = key.split('+').map((k) => k.trim().toLowerCase())
|
||||||
|
|
||||||
|
if (keyCombination.length === 1) {
|
||||||
|
return event.key === key
|
||||||
|
} else {
|
||||||
|
pressedKeys.add(event.key.toLowerCase())
|
||||||
|
return keyCombination.every((key) => pressedKeys.has(key))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: boolean) => void): Ref<boolean> => {
|
export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: boolean) => void): Ref<boolean> => {
|
||||||
const window = useWindow()
|
const window = useWindow()
|
||||||
|
|
||||||
let isPressed = $ref(unref(keyFilter) === true)
|
let isPressed = $ref(unref(keyFilter) === true)
|
||||||
|
|
||||||
|
let modifierPressed = $ref(false)
|
||||||
|
|
||||||
|
const pressedKeys = $ref<Set<string>>(new Set())
|
||||||
|
|
||||||
watch($$(isPressed), () => {
|
watch($$(isPressed), () => {
|
||||||
if (onChange && typeof onChange === 'function') onChange(isPressed)
|
if (onChange && typeof onChange === 'function') onChange(isPressed)
|
||||||
})
|
})
|
||||||
|
|
||||||
watchEffect(() => {
|
watchEffect(() => {
|
||||||
const unrefKeyFilter = unref(keyFilter)
|
let unrefKeyFilter = unref(keyFilter)
|
||||||
|
|
||||||
if (typeof window.addEventListener !== 'undefined') {
|
if (typeof window.addEventListener !== 'undefined') {
|
||||||
useEventListener(window, 'blur', () => {
|
useEventListener(window, 'blur', () => {
|
||||||
@@ -39,11 +59,17 @@ export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: b
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(unrefKeyFilter)) {
|
||||||
|
unrefKeyFilter = createKeyPredicate(unrefKeyFilter, pressedKeys)
|
||||||
|
}
|
||||||
|
|
||||||
if (unrefKeyFilter) {
|
if (unrefKeyFilter) {
|
||||||
onKeyStroke(
|
onKeyStroke(
|
||||||
unrefKeyFilter,
|
unrefKeyFilter,
|
||||||
(e) => {
|
(e) => {
|
||||||
if (isInputDOMNode(e)) return
|
modifierPressed = wasModifierPressed(e)
|
||||||
|
|
||||||
|
if (!modifierPressed && isInputDOMNode(e)) return
|
||||||
|
|
||||||
e.preventDefault()
|
e.preventDefault()
|
||||||
|
|
||||||
@@ -54,8 +80,16 @@ export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: b
|
|||||||
|
|
||||||
onKeyStroke(
|
onKeyStroke(
|
||||||
unrefKeyFilter,
|
unrefKeyFilter,
|
||||||
() => {
|
(e) => {
|
||||||
isPressed = false
|
if (isPressed) {
|
||||||
|
if (!modifierPressed && isInputDOMNode(e)) return
|
||||||
|
|
||||||
|
modifierPressed = false
|
||||||
|
|
||||||
|
pressedKeys.clear()
|
||||||
|
|
||||||
|
isPressed = false
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{ eventName: 'keyup' },
|
{ eventName: 'keyup' },
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user