chore(core): remove reactivity transform from useKeyPress
Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
@@ -1,5 +1,5 @@
|
|||||||
import type { Ref } from 'vue'
|
import type { Ref } from 'vue'
|
||||||
import type { KeyFilter, KeyPredicate, MaybeRef } from '@vueuse/core'
|
import type { KeyFilter, KeyPredicate, MaybeComputedRef } 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 {
|
||||||
@@ -18,9 +18,9 @@ function wasModifierPressed(event: KeyboardEvent) {
|
|||||||
return event.ctrlKey || event.metaKey || event.shiftKey
|
return event.ctrlKey || event.metaKey || event.shiftKey
|
||||||
}
|
}
|
||||||
|
|
||||||
function createKeyPredicate(keyFilter: KeyFilter, pressedKeys: Set<string>): KeyPredicate {
|
function createKeyPredicate(keyFilter: string[], pressedKeys: Set<string>): KeyPredicate {
|
||||||
return (event: KeyboardEvent) =>
|
return (event: KeyboardEvent) =>
|
||||||
(keyFilter as string[]).some((key) => {
|
keyFilter.some((key) => {
|
||||||
const keyCombination = key.split('+').map((k) => k.trim().toLowerCase())
|
const keyCombination = key.split('+').map((k) => k.trim().toLowerCase())
|
||||||
|
|
||||||
if (keyCombination.length === 1) {
|
if (keyCombination.length === 1) {
|
||||||
@@ -38,52 +38,50 @@ function createKeyPredicate(keyFilter: KeyFilter, pressedKeys: Set<string>): Key
|
|||||||
* @param keyFilter - Can be a boolean, a string or an array of strings. If it's a boolean, it will always return that value. If it's a string, it will return true if the key is pressed. If it's an array of strings, it will return true if any of the keys are pressed, or a combination is pressed (e.g. ['ctrl+a', 'ctrl+b'])
|
* @param keyFilter - Can be a boolean, a string or an array of strings. If it's a boolean, it will always return that value. If it's a string, it will return true if the key is pressed. If it's an array of strings, it will return true if any of the keys are pressed, or a combination is pressed (e.g. ['ctrl+a', 'ctrl+b'])
|
||||||
* @param onChange - Callback function that will be called when the key state changes
|
* @param onChange - Callback function that will be called when the key state changes
|
||||||
*/
|
*/
|
||||||
export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: boolean) => void): Ref<boolean> => {
|
export default (keyFilter: MaybeComputedRef<KeyFilter | null>, onChange?: (keyPressed: boolean) => void): Ref<boolean> => {
|
||||||
const window = useWindow()
|
const window = useWindow()
|
||||||
|
|
||||||
let isPressed = $ref(unref(keyFilter) === true)
|
const isPressed = ref(resolveUnref(keyFilter) === true)
|
||||||
|
|
||||||
let modifierPressed = $ref(false)
|
const modifierPressed = ref(false)
|
||||||
|
|
||||||
const pressedKeys = $ref<Set<string>>(new Set())
|
const pressedKeys = ref<Set<string>>(new Set())
|
||||||
|
|
||||||
watch($$(isPressed), () => {
|
watch(isPressed, () => {
|
||||||
if (onChange && typeof onChange === 'function') {
|
onChange?.(isPressed.value)
|
||||||
onChange(isPressed)
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
|
|
||||||
watchEffect(() => {
|
watchEffect(() => {
|
||||||
let unrefKeyFilter = unref(keyFilter)
|
let unrefKeyFilter = resolveUnref(keyFilter)
|
||||||
|
|
||||||
if (typeof window.addEventListener !== 'undefined') {
|
if (window && typeof window.addEventListener !== 'undefined') {
|
||||||
useEventListener(window, 'blur', () => {
|
useEventListener(window, 'blur', () => {
|
||||||
isPressed = false
|
isPressed.value = false
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isBoolean(unrefKeyFilter)) {
|
if (isBoolean(unrefKeyFilter)) {
|
||||||
isPressed = unrefKeyFilter
|
isPressed.value = unrefKeyFilter
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if (Array.isArray(unrefKeyFilter)) {
|
if (Array.isArray(unrefKeyFilter)) {
|
||||||
unrefKeyFilter = createKeyPredicate(unrefKeyFilter, pressedKeys)
|
unrefKeyFilter = createKeyPredicate(unrefKeyFilter, pressedKeys.value)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (unrefKeyFilter) {
|
if (unrefKeyFilter) {
|
||||||
onKeyStroke(
|
onKeyStroke(
|
||||||
unrefKeyFilter,
|
unrefKeyFilter,
|
||||||
(e) => {
|
(e) => {
|
||||||
modifierPressed = wasModifierPressed(e)
|
modifierPressed.value = wasModifierPressed(e)
|
||||||
|
|
||||||
if (!modifierPressed && isInputDOMNode(e)) {
|
if (!modifierPressed.value && isInputDOMNode(e)) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
e.preventDefault()
|
e.preventDefault()
|
||||||
|
|
||||||
isPressed = true
|
isPressed.value = true
|
||||||
},
|
},
|
||||||
{ eventName: 'keydown' },
|
{ eventName: 'keydown' },
|
||||||
)
|
)
|
||||||
@@ -91,16 +89,16 @@ export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: b
|
|||||||
onKeyStroke(
|
onKeyStroke(
|
||||||
unrefKeyFilter,
|
unrefKeyFilter,
|
||||||
(e) => {
|
(e) => {
|
||||||
if (isPressed) {
|
if (isPressed.value) {
|
||||||
if (!modifierPressed && isInputDOMNode(e)) {
|
if (!modifierPressed.value && isInputDOMNode(e)) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
modifierPressed = false
|
modifierPressed.value = false
|
||||||
|
|
||||||
pressedKeys.clear()
|
pressedKeys.value.clear()
|
||||||
|
|
||||||
isPressed = false
|
isPressed.value = false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{ eventName: 'keyup' },
|
{ eventName: 'keyup' },
|
||||||
@@ -108,5 +106,5 @@ export default (keyFilter: MaybeRef<KeyFilter | null>, onChange?: (keyPressed: b
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return $$(isPressed)
|
return isPressed
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user