useKeyboard / 键盘事件

用户监听多个键盘事件的钩子。

基础的

全局的键盘事件。

元素事件

只在指定元素上监听元素事件。

APIs / 接口文档

useKeyboard

type KeyboardOptions = {
  disableGlobalEvent: boolean,
  stopPropagation: boolean
  preventDefault: boolean
  capture: boolean
  event: 'keydown' | 'keypress' | 'keyup'
}

const useKeyboard = (
  handler: (event: React.KeyboardEvent) => void,
  keyBindings: Array<number> | number,
  options?: KeyboardOptions,
) => void

KeyboardOptions

参数描述类型推荐值默认
disableGlobalEvent禁止监听来自 Document 的全局事件boolean-false
stopPropagation停止事件传播boolean-false
preventDefault阻止事件的默认行为boolean-true
capture设置事件类型为捕获boolean-false
event键盘事件的类型string'keydown', 'keypress', 'keyup'keydown
Add