Document the useBlockWrapper hook in the block registration docs #26592
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
youknowriad
added
the
[Type] Developer Documentation
youknowriad
requested review from
ajitbohra,
chrisvanpatten and
mkaz
as code owners
|
Size Change: 0 B Total Size: 1.21 MB ℹ️ View Unchanged
|
mkaz
approved these changes
Oct 30, 2020
There was a problem hiding this comment.
This is fine for documenting useBlockProps
However, I'm wondering if we should include either as part of this or a new PR an example on how to implement for a block to support backward compatibility. Since useBlockProps is only available in WP 5.6, any blocks using it will not work on WP 5.5 or older without coding around it.
Even now on the cusp of WP 5.6 release, 60% of sites are still running WP 5.4 or older.
https://wordpress.org/about/stats/
annezazu
reviewed
Oct 30, 2020
|
|
||
| ### attributes | ||
| The first thing to notice here is the use of the `useBlockProps` React hook on the block wrapper element. In the example above, the block wrapper renders a "div" in the editor, but in order for the Gutenberg editor to know how to manipulate the block, add any extra classNames that are needed for the block... the block wrapper element should apply props retrieved from the `useBlockProps` react hook call. |
There was a problem hiding this comment.
This phrasing feels a bit confusing to me but it could be a lack of technical knowledge. Specifically, this part: "but in order for the Gutenberg editor to know how to manipulate the block, add any extra classNames that are needed for the block...".
There was a problem hiding this comment.
I believe going into details might create even more confusion :P
At this point in the learning curve of Gutenberg, people just need to know that this is important for Gutenberg to work well with their block. I'm not sure how I can express it better than that.
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 to #26100
This PR explains the use of useBlockWrapper hook for edit and save functions.
This PR along all the PRs attached to #26100 need to be merged right before WP 5.6