Navigation block: Try using a templated page list when there are no menus or inner blocks #44596
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
talldan
added
[Type] Code Quality
|
Size Change: +51 B (0%) Total Size: 1.27 MB
ℹ️ View Unchanged
|
…ks, replacing the current effect
talldan
force-pushed
the
try/using-a-template-for-default-page-list
branch
from
bd7e49e to
bcdeea8
Compare
draganescu
requested changes
Oct 3, 2022
There was a problem hiding this comment.
Yes, this is great except that - the same as when I tried it - it will create an undo item. Can we use this approach which is much cleaner and nicer but also __unstableMarkNextChangeAsNotPersistent?
The other effect is that immediately on selecting the page list a new navigation is created.
The intent of the original PR is to make the page list a plaeholder, which acts like a placeholder (does not create undo levels), and also to avoid surprising interaction (automagically creating nav menus).
|
I have been AFK so apologies for being behind in reviews. Thanks for raising this PR - the declarative approach seems much nicer on first glance.
We should definitely avoid this as we agreed previously that we needed user interaction in order to go from uncontrolled -> controlled inner blocks. Is it possible to make it clear that user must modify the inner blocks template in order to trigger creation of a sync'd Nav menu. Unrelated: @scruffian this is also a great example of where missing test causes previous decisions made about the functionality of the block to be vulnerable to regression. If these expectations were encoded in the tests we wouldn't need to rely on contributor's spotting potential problems. |
Thanks for raising those problems. I think it's worth looking at why that happens. Those both may be additional bugs to solve. |
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?
See #44594.
Replaces the code that runs
replaceInnerBlocksto create a default page list with an inner blockstemplateprop.Why?
The result should hopefully be exactly the same, but this makes the code more declarative. Effects that run on mount are considered a code quality issue, and it's very easy to cause bugs (see the recent issue with the group block - #44176). If there's an option to replace them, it's good to do that.
How?
The code in
trunkresults in the following:replaceInnerBlocks( clientId, [ createBlock( 'core/page-list' ) ] );UncontrolledInnerBlocksis conditionally rendered becausehasUncontrolledInnerBlocksis nowtrueandisEntityAvailableis stillfalse. It shows the new Page List block.In this PR that switches to:
UncontrolledInnerBlocksconditionally renders wheneverisEntityAvailableis false.Testing Instructions
I also tested a couple of other things: