Add a document explaining the different block API versions #26277
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
youknowriad
force-pushed
the
add/block-api-versions
branch
from
3d67ae4 to
2a5488a
Compare
|
Size Change: 0 B Total Size: 1.21 MB ℹ️ View Unchanged
|
mkaz
reviewed
Oct 19, 2020
Comment on lines
7
to
8
| - Moves the responsibility to render the block element wrapper in the editor to the block author using the `useBlockProps()` hook. | ||
| - Generates classnames and styles are not added automatically to the saved markup for static blocks, block authors are required to explicitely use `useBlockProps.save()` in their `save` functions to retrieve the generated classes and styles to apply on the block wrapper. |
There was a problem hiding this comment.
Suggested change
| - Moves the responsibility to render the block element wrapper in the editor to the block author using the `useBlockProps()` hook. | |
| - Generates classnames and styles are not added automatically to the saved markup for static blocks, block authors are required to explicitely use `useBlockProps.save()` in their `save` functions to retrieve the generated classes and styles to apply on the block wrapper. | |
| - The generated classnames and styles are no longer added automatically to the saved markup for static blocks. | |
| - To render the block element wrapper, the block author must use the `useBlockProps()` hook. | |
| - To retrieve the generated classes and styles, the block author must explicitly use `useBlockProps.save()` and add to their block wrapper. |
Rewording a little. I think we could also link or reference a simple block that illustrates the change.
There was a problem hiding this comment.
The first point and the last point are the same for me. I think we should put them together because both are about the save function.
I think we should clarify that the second point is about the edit function (or the editor representation of the block)
There was a problem hiding this comment.
What about:
- To render the block element wrapper for the block's `edit` implementation, the block author must use the `useBlockProps()` hook.
- The generated class names and styles are no longer added automatically to the saved markup for static blocks when `save` is processed. To include them, the block author must explicitly use `useBlockProps.save()` and add to their block wrapper.
gziolo
reviewed
Dec 10, 2020
Comment on lines
7
to
8
| - Moves the responsibility to render the block element wrapper in the editor to the block author using the `useBlockProps()` hook. | ||
| - Generates classnames and styles are not added automatically to the saved markup for static blocks, block authors are required to explicitely use `useBlockProps.save()` in their `save` functions to retrieve the generated classes and styles to apply on the block wrapper. |
There was a problem hiding this comment.
What about:
- To render the block element wrapper for the block's `edit` implementation, the block author must use the `useBlockProps()` hook.
- The generated class names and styles are no longer added automatically to the saved markup for static blocks when `save` is processed. To include them, the block author must explicitly use `useBlockProps.save()` and add to their block wrapper.
gziolo
approved these changes
Dec 10, 2020
youknowriad
force-pushed
the
add/block-api-versions
branch
from
22f1b82 to
f7ab9dc
Compare
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 adds a "changelog" for block API versions.