Editor: Unify the sidebar between the post and site editors #61507
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
|
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. |
youknowriad
commented
May 8, 2024
| @@ -287,6 +288,57 @@ function Layout( { initialPost } ) { | |||
| ); | |||
| } | |||
|
|
|||
| const { createSuccessNotice } = useDispatch( noticesStore ); | |||
|
|
|||
| const onActionPerformed = useCallback( | |||
There was a problem hiding this comment.
This callback is specific per editor at the moment. So I moved it into a prop to the "Sidebar" component. Ideally this should be the same between editors to be honest.
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
d75b491 to
661e171
Compare
youknowriad
commented
May 8, 2024
| }; | ||
| }, [] ); | ||
| return { | ||
| blockPatterns: getSettings().__experimentalBlockPatterns, |
There was a problem hiding this comment.
I'm not entirely sure that the way I'm retrieving the patterns here is similar to what we had before. Also not sure how to test this panel properly yet.
There was a problem hiding this comment.
Also I'm guessing this PR brings this panel to the post editor (where it was not present)
There was a problem hiding this comment.
There should be a simple way to get the patterns. Each similar implementation in the core has to deal with extra logic, increasing the chances of missing something.
@ellatrix, you recently worked on refactoring pattern fetching logic. Is there a better way to get all the patterns?
There was a problem hiding this comment.
For now, I just restored the code that we had in the site editor to avoid impact but I agree that overall, we need to have a better story about retrieving patterns.
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
661e171 to
04058d5
Compare
youknowriad
commented
May 8, 2024
| onActionPerformed={ onActionPerformed } | ||
| extraPanels={ | ||
| ! isEditingPage && ( | ||
| <PluginTemplateSettingPanel.Slot /> |
There was a problem hiding this comment.
The position of this slot has changed in the DOM. This slot is also deprecated, so I'm not sure we should make the effort to keep the previous position or not.
| { renderingMode !== 'post-only' && ( | ||
| <TemplateContentPanel /> | ||
| ) } | ||
| <PostTransformPanel /> |
There was a problem hiding this comment.
Both of these panels were site editor specific and I'm guessing they can show up in the post editor as well now.
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
04058d5 to
fcab8e0
Compare
|
Size Change: -1.43 kB (-0.08%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
PagesFor pages this adds the 'Move to trash' button to the Inspector in the Site Editor. Not a big deal, but noting since we'll want to remove that button as part of the Inspector work. Trashing/deleting should be consistently accessed from the ellipsis menu: 
Template partsTemplate parts receive the same Summary and trash button, plus a slug input: 
In this case the trash button is problematic because it appears for theme-supplied template parts (which cannot be deleted). The same is true for the slug. Once template parts and patterns are more unified (#57011) we'll want to include the Summary panel, but until then I think ideally it would be omitted in this context (as it is on trunk). PatternsThe Summary panel appears here too. Probably fine, but it's very short which highlights the need to move away from the collapsible panel component soon. NavigationAlso receives the Summary panel. It's not very useful here at all, containing only the 'last edited...' message and the 'Move to trash' button (which we want to remove anyway). Similar to template parts, if possible I think it's worth omitting this panel. |
|
@jameskoster, I think we should also remove the "Rename" action for normal post-types. The title is available in canvas and probably more accessible than a renaming in a modal. |
|
Do you mean posts and pages? It's not always the case that the title is on the canvas, for instance if you have template preview on, and the template doesn't include a Title block. I don't think it hurts to include it as a fallback, though perhaps "Edit title" would make more sense than "Rename" for posts and pages. |
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
19c6e44 to
f0f85ea
Compare
|
@jameskoster feedback addressed. |
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
b94561f to
b995c53
Compare
youknowriad
commented
May 10, 2024
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
fb6c61c to
8436924
Compare
Mamaduka
reviewed
May 13, 2024
Mamaduka
reviewed
May 13, 2024
Comment on lines
+282
to
+289
| case 'move-to-trash': | ||
| { | ||
| const postType = items[ 0 ].type; | ||
| document.location.href = addQueryArgs( 'edit.php', { | ||
| post_type: postType, | ||
| } ); | ||
| } | ||
| break; |
There was a problem hiding this comment.
Side note: The move-to-trash action doesn't display a notice in the post table list view after trashing the post. We'll need to match the main "Move to Trash" button behavior.
Screenshot
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
c9349cd to
b80f5c6
Compare
Mamaduka
reviewed
May 13, 2024
| @@ -33,30 +35,16 @@ import { store as editorStore } from '../../store'; | |||
| const PANEL_NAME = 'post-status'; | |||
|
|
|||
| export default function PostSummary() { | |||
| const { isOpened, isRemoved, showPostContentPanels } = useSelect( | |||
There was a problem hiding this comment.
We need to keep the showPostContentPanels check. The current logic doesn't render the Summary panel for the patterns when editing with a classic theme.
| trunk | this branch |
|---|---|
 |
 |
There was a problem hiding this comment.
It was suggested above that it's not very helpful #61507 (comment)
There was a problem hiding this comment.
To minimize changes, I restored it but kept only the "sync status"
There was a problem hiding this comment.
I think we still want to display Sync status somewhere. The header has a purple accent color, but that's not very accessible.
I don't think it's a blocker here as long as we quickly ship a follow-up for it (same Gutenberg release). cc @jameskoster
There was a problem hiding this comment.
Agree sync status is useful, also (down the road) category.
Just for reference, for patterns, this is what we're aiming at:
There was a problem hiding this comment.
@jameskoster, is there an issue for that?
There was a problem hiding this comment.
Not for patterns specifically. It's a part of #59689.
youknowriad
force-pushed
the
unify/sidebar-edit-post-edit-site
branch
from
b80f5c6 to
22e2ed0
Compare
Mamaduka
approved these changes
May 13, 2024
There was a problem hiding this comment.
Thanks, @youknowriad!
This tests well for me, and I couldn't spot any regression.
It would be nice to get another testing review in case I missed something. There's a lot of nuance to panel rendering logic.
|
Happy to address any follow-ups that appear. |
@jameskoster, the "Post Actions" are disabled when viewing the template in the post editor. Screenshot
|
|
I believe that occurs when actions (in this case 'Reset') cannot be applied. It's the same in the site editor. It may be better to hide the ellipsis button in these cases. |
|
I thought the action would be simply omitted or disabled when it's not eligible for the current entity. |
|
Yup, that's another option – keep the ellipsis active, but the Reset action in the menu disabled. |
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.
Related #52632
Follow-up to #61497
closes #29407
What?
We're in a middle of an effort to merge the post and site editors under the @wordpress/editor abstraction. As part of this, this PR unifies the Sidebar component used in both post and site editors.
The structure of the two components was a bit different so there's a possibility for this changing the output a bit. So we need to test the sidebar of all post types (post, page, template, template part, navigation, pattern) properly to ensure the result is as we expect it to be.
Testing Instructions
Please test the sidebar (block and document) of the post and site editors.
There are some subtle changes to be expected but overall it should be similar to trunk.