New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Register the block editor keyboard shortcuts automatically when using BlockEditorProvider #53910
Merged
youknowriad
merged 1 commit into
trunk
from
update/bundle-keyboard-shortcuts-registration
Aug 25, 2023
Merged
Register the block editor keyboard shortcuts automatically when using BlockEditorProvider #53910
youknowriad
merged 1 commit into
trunk
from
update/bundle-keyboard-shortcuts-registration
Aug 25, 2023
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
… BlockEditorProvider
youknowriad
requested review from
noisysocks,
draganescu,
talldan,
tellthemachines,
adamziel,
kevin940726 and
ellatrix
as code owners
August 24, 2023 13:41
25 tasks
Size Change: +9 B (0%) Total Size: 1.51 MB
ℹ️ View Unchanged
|
jorgefilipecosta
approved these changes
Aug 24, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code change make sense, in the smoke testing I did everything was ok 👍
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.
Related #53874
What and why?
Gutenberg can be used as a platform/framework to build block editors. Mainly thanks to the @wordpress/block-editor package. That said, the experience today is not as straightforward as it can be. There can be a lot of small gotchas and hacks you need to do in order to achieve the desired result. One of these small things is the need to manually render
BlockEditorKeyboardShortcuts.Register
component, this PR bundles this behavior within the BlockEditorProvider component, that way custom block editors don't have to render this extra component.There's potentially a small impact here, if the "BlockEditorProvider" is not rendered, the keyboard shortcuts are not registered, so they're not visible in the "keyboard shortcuts" modal. This is why I kept rendering that component within edit-post for the moment. That decision is arguable though, should we show these shortcuts if the user is in the code editor for instance). At least though, third-party block editors don't have to render these manually.
Testing Instructions
1- Nothing really, there shouldn't be any impact.