Skip to content

useHotkeys

@astryxdesign/core v0.7.1 · useHotkeys

参数 ​

名称类型默认值说明
hotkeysMaybeRefOrGetter<readonly Hotkey[]>—快捷键登记表。普通数组、ref、getter 都行,每次按键时重新读。必填。
hotkeys[].keysstring—用 "+" 串起来的组合,例如 "mod+k"、"shift+/"、"escape"。mod 在 macOS 上是 ⌘,其他平台是 Ctrl。别名有 esc、space、up、down、left、right、return,字面量 + 写成 plus。组合里不写 shift 时忽略 shift 状态,所以单个字母不区分大小写。
hotkeys[].onPress(event: KeyboardEvent) => void—命中组合时调用,调用前已经 preventDefault()。
hotkeys[].allowInInputsbooleanfalse焦点在输入框、文本域、下拉框或可编辑区域里时也触发这条快捷键。
hotkeys[].isDisabledbooleanfalse暂时停用这一条,不需要摘掉监听。

返回值 ​

名称类型说明
—void没有返回值。组件卸载时 window 上的监听会被摘掉。