keymaster 文档站点
React / VueVite · VitePress · pnpm monorepo键盘快捷键体验增强
为你的应用,装上一把「键盘指挥台」。
基于 keymaster 的 React / Vue 键盘快捷键库,一行代码即可为应用增加专业级快捷键体验, 配合文档站的交互 Demo,快速设计、验证你的键盘交互方案。
功能概览
React / Vue 快捷键库
针对 React 的 @keekuun/keymaster-react 与 Vue 的 @keekuun/keymaster-vue,提供 Hook / 组合式 API 封装,专注业务逻辑而非事件细节。
交互 Demo 即看即用
文档内置可交互 Demo(支持 Ctrl+S 等快捷键),无需搭脚手架就能直观体验库的行为。
最佳实践与设计思路
围绕编辑器、列表操作等场景,逐步沉淀快捷键设计建议,帮助你打造既强大又不打扰用户的键盘交互。
核心模块架构
@keekuun/keymaster-core 提供共享的类型定义和解析器,确保 React 和 Vue 版本的类型一致性和代码复用。
搜索与源码入口
右上角内置本地搜索与 GitHub 链接,方便你快速查找 API、跳转到源码深入阅读或贡献代码。
多版本管理
文档站点始终显示最新版本。如果你使用的是旧版本,可以查看 版本管理文档 了解如何查看对应版本的文档和 API。
版本提示
💡 重要:文档站点始终显示最新版本的文档(当前:React v0.5.0 / Vue v0.5.0 / Core v0.5.0)。如果你使用的是其他版本,请:
- 查看 版本管理文档 了解版本兼容性和升级指南
- 访问 npm 包页面 查看所有已发布的版本
- 查看 GitHub Releases 获取详细的版本发布说明