feat: creates a new way to add shortcut key mappings #6122
Merged
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.
The basics
npm run format
andnpm run lint
The details
Resolves
While I was writing a document talking about the different ways to customize Blockly I really wanted to say, "for the shortcut and context menu registries you simply create an object with all the necessary information and then register it." But that was not true for keyboard shortcuts because developers have to call
addKeyMapping
after registering their object. This was very annoying and since the fix is completely backwards compatible, this fixes that.Proposed Changes
addKeyMapping
.Behavior Before Change
In order to add a key code for a shortcut, developers would have to do:
Behavior After Change
Now developers can do:
Reason for Changes
This is cleaner in most situations.
Note: This does not cover the keyboard navigation use case where developers will want to update and change key mappings based on user input. In that case they would still need to use
addKeyMapping
in that situation.Additional Information