Update global-shortcut.md #2164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make it clear that the `global-shortcut` module should not be used until the ready event of app module gets emitted.
| @@ -3,6 +3,7 @@ | |||
| The `global-shortcut` module can register/unregister a global keyboard shortcut | |||
| in operating system, so that you can customize the operations for various shortcuts. | |||
| Note that the shortcut is global, even if the app does not get focused, it will still work. | |||
| You should not use this module until the ready event of app module gets emitted. | |||
|
|
|||
There was a problem hiding this comment.
Could you please also update the sample code in this doc?
|
@hokein Sample code updated. |
| // Register a 'ctrl+x' shortcut listener. | ||
| var ret = globalShortcut.register('ctrl+x', function() { | ||
| console.log('ctrl+x is pressed'); | ||
| }) |
There was a problem hiding this comment.
The code indention should be 2 spaces.
|
Sample code indention problem fixed. |
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make it clear that the
global-shortcutmodule should not be used until the ready event of app module gets emitted.