/shortcuts

A powerful keyboard shortcuts library implemented in TypeScript, enabling flexible and configurable keyboard shortcut functionality.

Primary LanguageTypeScriptMIT LicenseMIT

shortcuts

Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. CodeQL Test Codacy Badge Codacy Badge code style: prettier

A powerful keyboard shortcuts library implemented in TypeScript, enabling flexible and configurable keyboard shortcut functionality.

@vgerbot/shortcuts is an open-source project written in TypeScript that aims to simplify the implementation of flexible and configurable keyboard shortcuts for your applications. Whether you are developing web apps, desktop apps, this library provides a simple yet powerful way to manage and handle user input for keyboard shortcuts.

⚡️ Key Features:

  • Configurable Shortcut Keys: 🔨 Your app can now support custom shortcut keys with ease.
  • Context Management: 🔒 Your shortcut keys will only fire in the correct context, ensuring smooth operation.
  • Matching Function: 💡 Quickly solve the shortcut key matching problem with ease.
  • Key Combinations: 🎹 Supports key combinations like Ctrl + K, V and Ctrl + K, Ctrl + P.
  • Custom Locale: 🌎 Supports different keyboard types and allows you to customize key names to better match your needs.
  • Framework/Library Integration: 🔗 Provides multiple libraries for quick integration, such as @vgerbot/shortcuts-angular, @vgerbot/shortcuts-react, @vgerbot/shortcuts-rxjs, @vgerbot/shortcuts-vue2, and @vgerbot/shortcuts-vue.

📚 Documentation:

Check out the library's official documentation at https://vgerbot-libraries.github.io/shortcuts/.

💬 Found a bug? Missing a specific feature?

Feel free to file a new issue with a respective title and description on the vgerbot-libraries/shortcuts repository. If you have already found a solution to your problem, we would be happy to review your pull request! 🤝

📖 License:

The @vgerbot/shortcuts library is released under the terms of the MIT License.