Welcome to electron-hotkey-menu 👋
Does your Electron app use hotkeys? Do you want your users to configure these hotkeys themselves? This package will create a customisable key-binding menu for you, with simple, non-boilerplate code.
Homepage
🏠Install
npm install electron-hotkey-menu
Usage
// Hotkey added laterhotkeys.addHotkeynew Hotkey"Hotkey 3", "Shift+c", // Register hotkeys before showing menuhotkeys.registerHotkeysGlobal // Load menu on a button pressdocument.getElementById"hotkeys".onclick =hotkeys.displayMenu
Hotkeys are saved between program launches and stored in hotkeys.json
where the application was launched.
Author
👤 Jakob Hansen
- Github: @jakobkhansen
- LinkedIn: @jakob-hansen-b1a9a5174
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Show your support
Give a ⭐️ if this project helped you!
📝 License
Copyright © 2020 Jakob Hansen.
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator