Site editor routes: add docs for areas and prevent edit area from rendering when canvas is edit
#66309
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. |
oandregal
added
[Type] Developer Documentation
youknowriad
reviewed
Oct 22, 2024
| ) } | ||
| { ! isMobileViewport && | ||
| areas.edit && | ||
| canvasMode !== 'edit' && ( |
There was a problem hiding this comment.
What's the reasoning for this. I mean, it's ok, but feels like maybe it's the responsibility of the route no?
There was a problem hiding this comment.
The logic is the same as any other area: for example, content, sidebar, or mobile also have this check.
There was a problem hiding this comment.
maybe it's the responsibility of the route no?
The way the routes work as of now is that the "layout" is controlled by the site editor component, not the routes. We could change this so it's more flexible for 3rd parties (con: also less coherent), but it's about how we handle all areas, not just edit.
There was a problem hiding this comment.
Let's go for consistency then for now.
There was a problem hiding this comment.
This is triggering an ESLint error since canvasMode is undefined.
There was a problem hiding this comment.
Oh, interesting. I wonder why the tests didn't report any issue for this PR? I see it was fixed at #66316
There was a problem hiding this comment.
I think a follow-up PR (#66213) removed the variable, but the conflict wasn't caught until it was merged.
youknowriad
reviewed
Oct 22, 2024
|
|
||
| ## Areas | ||
|
|
||
| When `canvasMode` is not `edit`, the areas avaliable to use are: |
There was a problem hiding this comment.
Oh I see, for me I see things differently :)
I see things like that:
the available areas are always "all of them" but when the canvas mode is "edit", the "preview" area is "focused/zoomed".
There was a problem hiding this comment.
Actually, I think we should document that the areas are different based on viewport, not based on canvasMode.
In mobile: the "mobile" area is used or otherwise "preview" (fallback)
In desktop: All the areas are used.
or something like that.
There was a problem hiding this comment.
the available areas are always "all of them" but when the canvas mode is "edit", the "preview" area is "focused/zoomed".
But they are not really available because they are not rendered :)
Actually, I think we should document that the areas are different based on viewport, not based on canvasMode.
That's already documented as well.
There was a problem hiding this comment.
But they are not really available because they are not rendered :)
That's not really important to me. I see them as there but hidden because I'm just focused on the preview. Again, it's just a mental model and probably both make sense.
youknowriad
approved these changes
Oct 22, 2024
|
Size Change: 0 B Total Size: 1.81 MB ℹ️ View Unchanged
|
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
…endering when canvas is `edit` (WordPress#66309) Co-authored-by: oandregal <[email protected]> Co-authored-by: youknowriad <[email protected]>
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.
Follow-up to #66030
What?
editarea to be rendered when canvas mode isedit, as it's not used.Testing Instructions
Smoke test the site editor navigation.