SuperAPI AI 工具集

tanstack-hotkeys-guide

通用与其它

查看项目

更新于 10-16 08:11

技能介绍

用途:TanStack Hotkeys 用于在 React 或原生 JS 中处理键盘快捷键,适合需要多个快捷键、跨平台 Mod 处理、按键序列、快捷键录制或按键状态跟踪的场景。单一快捷键监听用原生 addEventListener 即可。

主要能力:提供 useHotkey 注册快捷键、useHotkeySequence 注册 Vim 风格多键序列、useHotkeyRecorder 录制自定义快捷键、useHeldKeys/useHeldKeyCodes/useKeyHold 跟踪按键状态,以及 formatForDisplay 等跨平台显示格式化函数。核心工具包括 parseHotkey、normalizeHotkey、validateHotkey、createHotkeyHandler、createSequenceMatcher 等。

使用方式:React 项目安装 npm install @tanstack/react-hotkeys,原生 JS 安装 @tanstack/hotkeys。用 Mod 表示跨平台修饰键(Mac 为 Cmd,Windows/Linux 为 Ctrl),如 useHotkey('Mod+S', callback)。作为 target 的元素需加 tabIndex={0} 以接收键盘事件。可用 HotkeysProvider 设置全局默认选项。

限制:库处于 alpha,API 可能变化,生产使用需谨慎。默认 preventDefault 和 stopPropagation 为 true。不要组合 Mod 与 Control 或 Meta。避免 Alt+字母、Shift+数字和 Shift+标点等跨平台问题组合。SSR 时 detectPlatform 默认 linux。冲突行为默认 warn。