onKeyStroke

聆听键盘击键。

¥Listen for keyboard keystrokes.

示例

Use the arrow keys or w a s d keys to control the movement of the ball.

Repeated events are ignored on the key `d` or `->`.

用法

¥Usage

import { onKeyStroke
 } from '@vueuse/core'

onKeyStroke
('ArrowDown', (e
) => {
  e
.preventDefault
()
})

请参阅此表格了解所有关键代码。

¥See this table for all key codes.

聆听多个键

¥Listen To Multiple Keys

import { onKeyStroke
 } from '@vueuse/core'

onKeyStroke
(['s', 'S', 'ArrowDown'], (e
) => {
  e
.preventDefault
()
})

// listen to all keys by [true / skip the keyDefine]
onKeyStroke
(true, (e
) => {
  e
.preventDefault
()
})
onKeyStroke
((e
) => {
  e
.preventDefault
()
})

自定义事件目标

¥Custom Event Target

onKeyStroke
('A', (e
) => {
  console
.log
('Key A pressed on document')
}, { target
: document
 })

忽略重复事件

¥Ignore Repeated Events

回调仅在按住 A 时触发一次。

¥The callback will trigger only once when pressing A and hold down.

// use `autoRepeat` option
onKeyStroke
('A', (e
) => {
  console
.log
('Key A pressed')
}, { dedupe
: true })

参考：KeyboardEvent.repeat

¥Reference: KeyboardEvent.repeat

指令用法

¥Directive Usage

vue

<script setup lang="ts">
import { vOnKeyStroke
 } from '@vueuse/components'

function onUpdate
(e
: KeyboardEvent) {
  // impl...
}
</script>

<template>
  <input
 v-on-key-str
oke:c,v
="onUpdate
" type
="text">
  <!-- with options -->
  <input
 v-on-key-str
oke:c,v
="[
onUpdate
, { 
eventName
: 'keyup' }]
" type
="text">
</template>

自定义键盘事件

¥Custom Keyboard Event

onKeyStroke
('Shift', (e
) => {
  console
.log
('Shift key up')
}, { eventName
: 'keyup' })

或者

¥Or

onKeyUp
('Shift', () => console
.log
('Shift key up'))

速记

¥Shorthands

onKeyDown - onKeyStroke(key, handler, {eventName: 'keydown'}) 的别名
¥onKeyDown - alias for onKeyStroke(key, handler, {eventName: 'keydown'})
onKeyPressed - onKeyStroke(key, handler, {eventName: 'keypress'}) 的别名
¥onKeyPressed - alias for onKeyStroke(key, handler, {eventName: 'keypress'})
onKeyUp - onKeyStroke(key, handler, {eventName: 'keyup'}) 的别名
¥onKeyUp - alias for onKeyStroke(key, handler, {eventName: 'keyup'})

onKeyStroke ​

示例 ​

用法 ​

聆听多个键 ​

自定义事件目标 ​

忽略重复事件 ​

指令用法 ​

自定义键盘事件 ​

速记 ​