Stabilise role attribute property #65484
Open
+227
−165
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
getdave
added
[Type] Code Quality
getdave
commented
Sep 19, 2024
Comment on lines
-127
to
+130
| const __experimentalHasContentRoleAttribute = jest.fn( () => false ); | ||
| const hasContentRoleAttribute = jest.fn( () => false ); | ||
| getBlockEditingMode.registry = { | ||
| select: jest.fn( () => ( { | ||
| __experimentalHasContentRoleAttribute, | ||
| hasContentRoleAttribute, |
There was a problem hiding this comment.
Should these tests be moved to selectors tests now?
getdave
commented
Sep 19, 2024
| return true; | ||
| } | ||
| if ( __experimentalRole === 'content' ) { | ||
| deprecated( '__experimentalRole attribute', { |
There was a problem hiding this comment.
Suggested change
| deprecated( '__experimentalRole attribute', { | |
| deprecated( '__experimentalRole property', { |
Am I right?
|
Size Change: +101 B (+0.01%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
youknowriad
reviewed
Sep 19, 2024
getdave
requested review from
ellatrix,
artemiomorales,
ajitbohra and
nerrad
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
getdave
commented
Sep 20, 2024
gziolo
reviewed
Sep 20, 2024
youknowriad
added
the
Needs Dev Note
getdave
commented
Sep 20, 2024
|
Looking at the unit tests now |
I think that's a decision that's up for debate. The "Zoom Out mode" feature does make use of contentOnly but not in a way that requires us to know about which blocks are "content blocks". The recent "Select mode" work uses We might want to buy some more time for the API to stablise alongside the new modes, or alternatively we could say the API that's been around for 2yrs is probably good to stablise. Opinions welcomed. |
Anyone have any idea why this test is failing on CI but passing locally? Going to try a rebase. |
getdave
force-pushed
the
update/stabilise-content-role
branch
from
4c28c28
to
7392224
Compare
|
I would recommend we try to get this into 6.7 if possible. This would allow extenders to begin experimenting with it in custom blocks and extensions ahead of 6.8. |
As long as we have a fallback in place for the old |
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.
What?
Stablises the
_experimentalRoleproperty of block attributes andallsome related selectors and utils.Note:
__experimentalHasContentRoleAttributehas been made a private selector. Full backwards compatibility will remain until WP 6.8.Why?
This has been in use for 2 years and has not be stablised. With all the work on
contentOnlygoing on it makes sense to look to stablise the APIs in order that block authors can be confident in making use of them.How?
__experimentalHasContentRoleAttributea private selector.__experimentalprefixed versions to new versions and throwsdepreciated()warning__experimentalRoleprop.__experimentalprefixed functions and attribute props.Testing Instructions
hasContentRoleAttributeAPI__experimentalGetBlockAttributesNamesByRoleAPI:The call to the experimental method should throw a deprecated notice.
Also check Editor doesn't crash when moving in / out of Zoom Out mode or the new "Edit" mode.
Registering a Block
Content Only Test Blockto the post and type something into the inputTesting Instructions for Keyboard
Screenshots or screencast