Skip to content
On this page

useKeyPress

监听键盘按键,支持组合键,支持按键别名的 Hook

基础用法

监听组合按键

精确匹配

API

const state = useKeyPress(target?: Target);
const state = useKeyPress(target?: Target);

Params

参数说明类型
keyFilter键盘输入的当前键Number | String | Number[]| String[] |(event: KeyboardEvent) => boolean
eventHandler事件处理(event: KeyboardEvent) => void
option额外的配置项Options

Options

参数说明类型默认值
events当所监听的事件类型触发时,接收到的一个事件通知对象EventListenerOrEventListenerObject-
targetDOM 节点或者 RefHTMLElement | Document | Window-
exactMatch是否准确匹配Boolean-

Source

源码文档示例