keymaster Documentation
Give your app a "keyboard command center".
A React / Vue keyboard shortcut library based on keymaster. Add professional-grade shortcut experience to your app with just one line of code, and quickly design and validate your keyboard interaction solutions with interactive demos.
Feature Overview
React / Vue Shortcut Libraries
@keekuun/keymaster-react for React and @keekuun/keymaster-vue for Vue provide Hook / Composition API wrappers, focusing on business logic rather than event details.
Interactive Demos
Built-in interactive demos (supporting shortcuts like Ctrl+S) allow you to experience the library's behavior without setting up a project.
Best Practices & Design Guidelines
Design recommendations for editor, list operations, and other scenarios to help you create powerful yet unobtrusive keyboard interactions.
Core Module Architecture
@keekuun/keymaster-core provides shared type definitions and parsers, ensuring type consistency and code reuse across React and Vue versions.
Search & Source Links
Built-in local search and GitHub links in the top-right corner for quick API lookup, source code browsing, and contributions.
Multi-Version Management
The documentation site always displays the latest version. If you're using an older version, check the version management documentation to learn how to view documentation and APIs for specific versions.
Version Notice
💡 Important: The documentation site always displays the latest version (Current:
React v0.5.0 / Vue v0.5.0 / Core v0.5.0). If you're using a different version, please:
- Check the Version Management documentation for version compatibility and upgrade guides
- Visit the npm package page to view all published versions
- Check GitHub Releases for detailed version release notes