Editor: Optimize the 'PostSlug' component #60422
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
Mamaduka
added
[Type] Code Quality
|
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. |
|
Size Change: -128 B (0%) Total Size: 1.73 MB
ℹ️ View Unchanged
|
tyxla
approved these changes
Apr 3, 2024
There was a problem hiding this comment.
Great work @Mamaduka! 🚀
This is a really cool improvement and I see a few positive improvements to the UX 🌟 :
- Slug is currently being kept up to date with the one in the store. We still allow custom non-saved slug to be kept in the meantime. ✅
- Non-slug characters are cleaned up earlier (on change), instead of staying there in the field forever. ✅
- Clearing the field and blurring it will reset to the current slug, which reflects the current state better than before. ✅
One thing that could be improved in the future (not for this PR):
- If we use an existing slug that's already taken by another post, we'll get no indication that this is happening. Once we save, and refresh, we'll see our slug (say
hello-world) but suffixed by-2:hello-world-2, which is the default mechanism of WordPress to deal with duplicate slugs. That's fine, of course, but ideally we should get an indication that it's happening earlier than after refreshing the page.
Side note: I was surprised this used a different component than what Pages are using for managing their slug:
| spellCheck="false" | ||
| value={ forceEmptyField ? '' : postSlug } | ||
| onChange={ ( newValue ) => { | ||
| editPost( { slug: newValue } ); |
There was a problem hiding this comment.
I wonder if we could clean the new slug earlier, so it wouldn't show in the preview:
But I guess that could cause weird behavior for users if we don't use a separate state field for maintaining the current unsaved slug.
There was a problem hiding this comment.
The PostURL component maintains the same logic. I'm guessing this is to avoid validation while the user is typing.
There was a problem hiding this comment.
Right. Plus it's definitely not a good user experience if you start typing special characters from an empty field.
| export default function PostSlug() { | ||
| return ( | ||
| <PostSlugCheck> | ||
| <PostSlugControl /> |
There was a problem hiding this comment.
Good call to separate the functionality in a subcomponent so we wouldn't have extra unnecessary store subscriptions when the slug is disabled 👏
|
Thanks for testing and review, @tyxla! Right, the duplicated post suffix can be "surprise." Validating for it can be expensive, requiring pinging the server. I'm sure there's some old issue, or PR is explaining the decision behind the current logic 😄 |
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org>
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?
PR contains the following updates and optimizations for the
PostSlugcomponent:Note
We have to maintain this component for backward compatibility.
Why?
While
core/editorisn't as active a store ascore/block-editor, there's no need to create unnecessary store subscriptions.Testing Instructions
add_post_type_support( 'post', 'slug' );Testing Instructions for Keyboard
Same.
Screenshots or screencast
CleanShot.2024-04-03.at.16.37.48.mp4