@ gentleduck/vim (英语)
键盘命令引擎带有热键解析,序列,录音,和回放钩.
麻省理工学院 - 说吧 更改日志 - 说吧 捐款 - 说吧 文档
React 的键盘命令引擎.
捆绑出热键,记录出密钥序列,并处理有平台意识的修改键. 包含有反应钩子的框架不可知核.
为什么
- 多步键序列( E)
g接下来d) 带有可配置的超时 - 用户自定义绑定的设置 UI 的密钥记录
- 平台意识
Mod键: 决定Cmd在macOS上,Ctrl到处都是
快开始
npm install @gentleduck/vim
import { KeyProvider, useKeyBind } from '@gentleduck/vim/react'
function App() {
useKeyBind('ctrl+k', () => console.log('open palette'), {
preventDefault: true,
})
return <div>Press Ctrl+K</div>
}
export default function Root() {
return (
<KeyProvider>
<App />
</KeyProvider>
)
}
特征
- 密钥解析 -- 解析、正常化并验证绑定字符串(
Mod+Shift+S到结构化描述符) - 顺序 -- 有超时和进展跟踪的多步骤关键链
- 记录 -- 从用户输入中获取密钥组合以重新绑定 UI
- 反应钩 - 说吧
useKeyBind, (中文(简体) ),useKeySequence, (中文(简体) ),useKeyRecorder, (中文(简体) ),useKeyCommands - 平台检测 -- 自动检测macOS/Windows/Linux并解决修改标签
- 冲突探测 -- 警告、出错或静音替换重复绑定
- 具有约束力的备选方案 - 说吧
preventDefault, (中文(简体) ),stopPropagation, (中文(简体) ),ignoreInputs, (中文(简体) ),requireReset
模块
每个模块是一个单独的子路径导出,可以独立使用:
| 模块 | 导入 | 目的 |
|---|---|---|
platform | @gentleduck/vim/platform | OS检测, Mod 决议 |
parser | @gentleduck/vim/parser | 解析/规范/验证约束 |
matcher | @gentleduck/vim/matcher | 匹配键盘事件 |
format | @gentleduck/vim/format | 平台意识显示格式 |
command | @gentleduck/vim/command | 书记官处和钥匙处理员 |
sequence | @gentleduck/vim/sequence | 多键序列匹配 |
recorder | @gentleduck/vim/recorder | 密钥组合记录 |
react | @gentleduck/vim/react | 反应上下文,钩子 |
套装
- 0 运行时依赖性( React 是一个对等的 dep)
- 可树动子路径导出
"sideEffects": false