Site Editor: Remove synchronization of canvas mode into store #66213
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
youknowriad
added
[Type] Enhancement
|
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
Oct 17, 2024
| import { useLayoutEffect } from '@wordpress/element'; | ||
| import { store as preferencesStore } from '@wordpress/preferences'; | ||
|
|
||
| export function useAdaptEditorToCanvas( canvasMode ) { |
There was a problem hiding this comment.
This was previously in the setCanvasMode action. But these are all "editor specific" changes, they should happen when the editor is rendered.
youknowriad
commented
Oct 17, 2024
| function push( | ||
| params: Record< string, any >, | ||
| state: Record< string, any >, | ||
| options: PushOptions = {} |
There was a problem hiding this comment.
This change basically adds support for view transitions to our "private" router.
|
Size Change: -6 B (0%) Total Size: 1.81 MB
ℹ️ View Unchanged
|
ramonjd
reviewed
Oct 18, 2024
| ...params, | ||
| canvasMode: | ||
| undefined, | ||
| }, |
There was a problem hiding this comment.
If I don't remove the canvas param from the URL like this:
Suggested change
| }, | |
| canvas: undefined, | |
| }, |
Clicking the WP logo when editing a template or pattern returns me to this page:
I don't know if that's intentional or not.
| history.push( | ||
| { | ||
| ...params, | ||
| canvasMode: 'edit', |
There was a problem hiding this comment.
Do the links for patterns and templates also need canvasMode: 'edit',?
E.g.,
const { onClick } = useLink( {
postType: item.type,
postId: isUserPattern || isTemplatePart ? item.id : item.name,
canvas: 'edit',
canvasMode: 'edit',
} );Otherwise, clicking on individual patterns and templates lead to the list + preview mix, similar to the screenshot above.
| @@ -55,11 +55,15 @@ export default function useEditorIframeProps() { | |||
| ! currentPostIsTrashed | |||
| ) { | |||
| event.preventDefault(); | |||
| setCanvasMode( 'edit' ); | |||
| history.push( { ...params, canvasMode: 'edit' }, undefined, { | |||
There was a problem hiding this comment.
Are we missing canvas: 'edit'?
There is functionality that requires it.
For example, the param is checked to allow navigation between editing a page's template to work, useNavigateToPreviousEntityRecord.
Speaking of which, when editing a page's template I think we also need to add canvasMode: 'edit' to the route now:
diff --git a/packages/edit-site/src/components/block-editor/use-navigate-to-entity-record.js b/packages/edit-site/src/components/block-editor/use-navigate-to-entity-record.js
index 120b15b8551..cf44b2ae0cd 100644
--- a/packages/edit-site/src/components/block-editor/use-navigate-to-entity-record.js
+++ b/packages/edit-site/src/components/block-editor/use-navigate-to-entity-record.js
@@ -16,7 +16,9 @@ export default function useNavigateToEntityRecord() {
const onNavigateToEntityRecord = useCallback(
( params ) => {
- history.push( { ...params, focusMode: true, canvas: 'edit' } );
+ history.push( { ...params, focusMode: true, canvas: 'edit', canvasMode: 'edit' }, undefined, {
+ transition: 'canvas-mode-edit-transition',
+ } );
},
[ history ]
);
| } | ||
| }, | ||
| onClick: () => { | ||
| setCanvasMode( 'edit' ); | ||
| history.push( { ...params, canvasMode: 'edit' }, undefined, { |
Actually this is a mistake that I made in this PR, all these links should be "canvas" :) |
ramonjd
approved these changes
Oct 21, 2024
ntsekouras
reviewed
Oct 22, 2024
|
Great to see this and have a single source of truth. Thanks! |
youknowriad
force-pushed
the
update/remove-canvas-from-state
branch
from
b40d4b3 to
2766d7f
Compare
jsnajdr
approved these changes
Oct 22, 2024
|
Flaky tests detected in 2766d7f. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11456342079
|
|
Looks like we forgot to rename a var, fixing in #66316. |
|
Interesting that tests didn't pick it up 🤔 |
Yeah, same thought. This is what I see:
My understanding is that GitHub 1) doesn't retrigger CI builds for PRs every time the base branch ( |
2 tasks
This was referenced Oct 31, 2024
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
…ess#66213) Co-authored-by: youknowriad <[email protected]> Co-authored-by: ramonjd <[email protected]> Co-authored-by: ntsekouras <[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?
The canvasMode in edit-site is duplicated between edit site store and url which creates some very small and unfortunate side effects:
This PR removes the canvasMode state and always relies on the location from the url to solve that.
Testing Instructions
1- notice that when you go to "pages", the canvas animates to the right
2- notice that entering and exiting the canvas animates properly.