Fix visibility of the template Welcome Guide in the Site Editor #64789
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
stokesman
added
[Type] Bug
|
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: +1.46 kB (+0.08%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
ramonjd
reviewed
Aug 26, 2024
There was a problem hiding this comment.
Thanks for the PR!
This is working as described for me. The Edit Template welcome guide now appears when I edit a page template in the site editor, and there's no flash from Page > Edit.
For other entities however I'm now seeing the "flash". For example,
- Open the site editor and edit the default template
- Create a pattern and then click "Edit original" to edit the pattern
- See our flashy friend appear
Kapture.2024-08-26.at.15.13.48.mp4
It doesn't happen when I create a template part in situ.
I'm not 100% on all the possible conditions, so it'd be good to get a second pair of eyes on it cc @noisysocks
Thanks for catching that! I’ve tinkered around more and have yet to find a set of conditions that work cleanly. I thought of a hackish solution that seems to work and pushed that 6a2bb80. I'd be keen to see if anyone can figure out a better way. |
|
Flaky tests detected in 29bfbc0. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10691145052
|
|
I put this on the 6.7 board as the template welcome guide has had these issues since 6.6 it seems. |
ramonjd
reviewed
Aug 30, 2024
stokesman
commented
Sep 2, 2024
| const isVisible = | ||
| postId !== priorPostId && | ||
| isTemplateActive && | ||
| ! isEditorActive && |
There was a problem hiding this comment.
I’ve removed the ! isEditorActive condition because hasPreviousEntity makes it redundant. The editor welcome guide can’t be visible when editing an entity that was arrived at through another entity.
ramonjd
approved these changes
Sep 3, 2024
| getCurrentPostType() === 'wp_template' | ||
| ); | ||
| const edited = useEditedEntityRecord(); | ||
| const isPostTypeTemplate = edited.record.type === 'wp_template'; |
There was a problem hiding this comment.
Suggested change
| const isPostTypeTemplate = edited.record.type === 'wp_template'; | |
| const isPostTypeTemplate = edited.record?.type === 'wp_template'; |
edited.record can be false on the first load.
There was a problem hiding this comment.
Aw, good catch. Yet in this case the optional chaining operator isn’t truly suited. Still, I’m not against trying to make this more explicit. I decided to leverage the isLoaded property in the return value 29bfbc0. Once that becomes true then record won’t be false.
Thanks for sticking it out with me Ramon! |
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?
Makes the Welcome guide for page templates actually show up when editing a page template.
Why?
To fix that the Welcome guide for a page template does not show up when expected as it was originally implemented in #52014. Also, to fix #62525, that describes how the Welcome guide flashes briefly at an unexpected moment.
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast