Navigation: Add an experimental label #54946
Open
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
scruffian
added
[Type] Enhancement
|
Size Change: +1.28 kB (0%) Total Size: 1.65 MB
ℹ️ View Unchanged
|
getdave
reviewed
Oct 4, 2023
getdave
reviewed
Oct 5, 2023
Comment on lines
+57
to
+61
| return buildNavigationLabel( | ||
| navigationMenu?.title, | ||
| 1, // This has to be 1 because in this context there is only one Navigation shown. | ||
| navigationMenu?.status | ||
| ); |
There was a problem hiding this comment.
Given this function signature is a little opaque (especially the 2nd argument) I wonder whether it's better just to pass the entire navigationMenu and have the function grab the bit it needs.
I feel perhaps the consumer needs to know too much.
What do you think?
There was a problem hiding this comment.
Just passing the entire thing won't be enough, as we still need to know the index. We could ditch the third argument though.
There was a problem hiding this comment.
In that case maybe make the function accept an object with named arguments? It might be easier to understand.
Not a blocker though. Just a code quality idea.
|
Flaky tests detected in 546f365. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6419324118
|
Co-authored-by: Dave Smith <getdavemail@gmail.com>
Co-authored-by: Dave Smith <getdavemail@gmail.com>
scruffian
force-pushed
the
add/experimental-label-for-navigation
branch
from
546f365 to
47f2d01
Compare
scruffian
commented
Oct 12, 2023
| @@ -72,7 +55,7 @@ function NavigationMenuSelector( { | |||
| const menuChoices = useMemo( () => { | |||
| return ( | |||
| navigationMenus?.map( ( { id, title, status }, index ) => { | |||
| const label = buildMenuLabel( | |||
| const label = buildNavigationLabel( | |||
There was a problem hiding this comment.
The destructuring of the navigationMenu object in here means we need to make more changes to the code to pass the whole object. I'm not sure it's worth it. By only passing the properties we need we keep the function clearer and less susceptible to side effects.
getdave
reviewed
Oct 13, 2023
There was a problem hiding this comment.
I think there could be a danger of consuming a hook inside what is basically a util function. I saw a order of hooks error when inserting a Nav into a Post:
It might be you'll need to handle this more like we do for reusable blocks:
packages/block-editor/src/components/block-title/use-block-display-title.js
But that's hardcoding WP specific blocks into the block editor which isn't great. So we'd need a way to abstract the concept.
| } | ||
|
|
||
| if ( status === 'publish' ) { | ||
| return decodeEntities( title ); |
There was a problem hiding this comment.
Nit: can we do decodeEntities( title ) once before the if ( status === 'publish' ) {. That way we don't have any chance of refactoring loosing the decoding.
draganescu
reviewed
Oct 17, 2023
draganescu
reviewed
Oct 17, 2023
| import { __, sprintf } from '@wordpress/i18n'; | ||
| import { decodeEntities } from '@wordpress/html-entities'; | ||
|
|
||
| function buildNavigationLabel( title, id, status ) { |
There was a problem hiding this comment.
let's add a docblock to this function?
Yes, this feature crashes the editor - just insert a navigation block and you'll see it - because of the order of hooks issue. What I thought would be a quick fix ended up being far from simple :) |
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?
This PR requires #54426.
This adds a label to the list view is the name of the navigation in the database.
Why?
This will make the connection between the block and the data within the block clearer.
How?
Add an __experimentalLabel function to the Navigation block, and reuse the buildNavigationLabel function do display the name of the navigation in the list view.
Testing Instructions
Screenshots or screencast