Editor Settings: Rename the getPostLinkProps setting #58416
Merged
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
glendaviesnz
added
[Type] Code Quality
glendaviesnz
commented
Jan 29, 2024
| */ | ||
| export default function usePostHistory( initialPostId, initialPostType ) { | ||
| export default function useLoadEntityRecord( initialPostId, initialPostType ) { |
There was a problem hiding this comment.
I did initially have this called useSelectEntityRecord but it caused a linting error about needing to pass in a callback - the linter was confusing it with useSelect I think, and likely that naming would be confusing to others as well.
|
Flaky tests detected in 28d82f7. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7703660591
|
|
Size Change: +281 B (0%) Total Size: 1.69 MB
ℹ️ View Unchanged
|
|
Yes, I prefer this personally but curious about what others think as well. |
|
Left this feedback before, and it's still a strong opinion (though loosely held, I won't be upset if you merge this 😄 ) I still think it's too close to the naming of data APIs, especially the
|
|
but I could also go with something like
my main grudge was the |
|
@talldan, @youknowriad, I have renamed to |
glendaviesnz
force-pushed
the
refactor/get-post-link-props-setting
branch
from
522a27a
to
c95e2d0
Compare
|
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 Core SVNCore Committers: Use this line as a base for the props when committing in SVN: GitHub Merge commitsIf 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. |
|
@youknowriad are you happy with this rename now? |
glendaviesnz
force-pushed
the
refactor/get-post-link-props-setting
branch
from
c95e2d0
to
76b3e8a
Compare
|
@ramonjd, @noisysocks this affects the changes made in #58528 and #58534 - it all still seems to work as expected, but you may want to double check. @talldan, @youknowriad it would be good to get a ✅ on this soon if possible please. It touches a few areas so needing to do a bit of rebasing to keep it current. And we also went to get this in for the 6.5 beta. |
noisysocks
reviewed
Feb 7, 2024
packages/edit-site/src/components/block-editor/use-site-editor-settings.js
Outdated
Show resolved
Hide resolved
talldan
approved these changes
Feb 7, 2024
There was a problem hiding this comment.
Looks good!
I noticed a two bugs, it doesn't look like they were caused by this PR, but would be good things to track and fix for 6.5.
-
In the post editor when selecting 'Preview Template', there's a trailing block appender after the template that shouldn't be there (you can't edit the template in this mode):
-
When editing a pattern in the post editor, there's a lot of empty white space underneath the pattern and a scrollbar. This doesn't happen in the site editor. I think this is the post editor's "click below" area that shouldn't be present in the focused mode:
And finally, I noticed the template-part-edit hook (that adds the 'edit' button to the template part's toolbar) could potentially be changed to use this new API. Though some care would need to be taken about the post editor experience (currently it doesn't support editing template parts):
https://github.com/WordPress/gutenberg/blob/trunk/packages/edit-site/src/hooks/template-part-edit.js
| @@ -472,7 +472,7 @@ test.describe( 'Pattern Overrides', () => { | |||
| await editor.showBlockToolbar(); | |||
| await page | |||
| .getByRole( 'toolbar', { name: 'Block tools' } ) | |||
| .getByRole( 'link', { name: 'Edit original' } ) | |||
| .getByRole( 'button', { name: 'Edit original' } ) | |||
There was a problem hiding this comment.
This is perhaps a little controversial, as I think a link is generally considered more semantic and provides better info for screenreaders. 🤔
There was a problem hiding this comment.
Yeh, unfortunately until we get proper routing set up in the post editor we can't use a link here, but it would be good to switch it back when/if we have routing in the post editor.
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?
Renames the
getPostLinkPropsandgoBackeditor setting toonNavigateToEntityRecordonNavigateToPreviousEntityRecordand removes the href property from the return value in line with feedback here.Why?
The current naming doesn't work well for the wider usage of this setting outside the pattern focused editing it was originally added for. Also, the
hrefprop does not work in the post editor so shouldn't be included.How?
Renamed all the relevant hooks, settings, and usages.
Testing Instructions
Template - Edit Templateoption in the right post panelTemplate - Create new templateoption in right post panel and check it worksTemplate - Edit templateoption again and this time make sure theGo backoption in the success snackbar worksGo backbutton will not appear in the notification, this is because the routing works differently in the site editor, and the top back link is more prominent