Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Site Editor: Remove synchronization of canvas mode into store #66213

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Site Editor: Remove synchronization of canvas mode into store #66213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc6aefa
Site Editor: Remove synchronization of canvas mode into store
youknowriad Oct 17, 2024
2766d7f
Fix urls
youknowriad Oct 18, 2024
1a05cba
Prevent extra rerendering
youknowriad Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions packages/edit-site/src/components/block-editor/use-editor-iframe-props.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,37 @@ import clsx from 'clsx';
/**
* WordPress dependencies
*/
import { useSelect, useDispatch } from '@wordpress/data';
import { useSelect } from '@wordpress/data';
import { ENTER, SPACE } from '@wordpress/keycodes';
import { useState, useEffect } from '@wordpress/element';
import { __ } from '@wordpress/i18n';
import { store as editorStore } from '@wordpress/editor';
import { privateApis as routerPrivateApis } from '@wordpress/router';

/**
* Internal dependencies
*/
import { unlock } from '../../lock-unlock';
import { store as editSiteStore } from '../../store';

export default function useEditorIframeProps() {
const { canvasMode, currentPostIsTrashed } = useSelect( ( select ) => {
const { getCanvasMode } = unlock( select( editSiteStore ) );
const { useLocation, useHistory } = unlock( routerPrivateApis );

return {
canvasMode: getCanvasMode(),
currentPostIsTrashed:
select( editorStore ).getCurrentPostAttribute( 'status' ) ===
'trash',
};
export default function useEditorIframeProps() {
const { params } = useLocation();
const history = useHistory();
const { canvas = 'view' } = params;
const currentPostIsTrashed = useSelect( ( select ) => {
return (
select( editorStore ).getCurrentPostAttribute( 'status' ) ===
'trash'
);
}, [] );
const { setCanvasMode } = unlock( useDispatch( editSiteStore ) );
const [ isFocused, setIsFocused ] = useState( false );

useEffect( () => {
if ( canvasMode === 'edit' ) {
if ( canvas === 'edit' ) {
setIsFocused( false );
}
}, [ canvasMode ] );
}, [ canvas ] );

// In view mode, make the canvas iframe be perceived and behave as a button
// to switch to edit mode, with a meaningful label and no title attribute.
Expand All @@ -55,11 +55,15 @@ export default function useEditorIframeProps() {
! currentPostIsTrashed
) {
event.preventDefault();
setCanvasMode( 'edit' );
history.push( { ...params, canvas: 'edit' }, undefined, {
transition: 'canvas-mode-edit-transition',
} );
}
},
onClick: () => {
setCanvasMode( 'edit' );
history.push( { ...params, canvas: 'edit' }, undefined, {
transition: 'canvas-mode-edit-transition',
} );
},
onClickCapture: ( event ) => {
if ( currentPostIsTrashed ) {
Expand All @@ -72,8 +76,8 @@ export default function useEditorIframeProps() {

return {
className: clsx( 'edit-site-visual-editor__editor-canvas', {
'is-focused': isFocused && canvasMode === 'view',
'is-focused': isFocused && canvas === 'view',
} ),
...( canvasMode === 'view' ? viewModeIframeProps : {} ),
...( canvas === 'view' ? viewModeIframeProps : {} ),
};
}
19 changes: 11 additions & 8 deletions packages/edit-site/src/components/block-editor/use-site-editor-settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,25 @@ function useNavigateToPreviousEntityRecord() {
}

export function useSpecificEditorSettings() {
const { params } = useLocation();
const { canvas = 'view' } = params;
const onNavigateToEntityRecord = useNavigateToEntityRecord();
const { canvasMode, settings, shouldUseTemplateAsDefaultRenderingMode } =
useSelect( ( select ) => {
const { getEditedPostContext, getCanvasMode, getSettings } = unlock(
const { settings, shouldUseTemplateAsDefaultRenderingMode } = useSelect(
( select ) => {
const { getEditedPostContext, getSettings } = unlock(
select( editSiteStore )
);
const _context = getEditedPostContext();
return {
canvasMode: getCanvasMode(),
settings: getSettings(),
// TODO: The `postType` check should be removed when the default rendering mode per post type is merged.
// @see https://github.com/WordPress/gutenberg/pull/62304/
shouldUseTemplateAsDefaultRenderingMode:
_context?.postId && _context?.postType !== 'post',
};
}, [] );
},
[]
);
const defaultRenderingMode = shouldUseTemplateAsDefaultRenderingMode
? 'template-locked'
: 'post-only';
Expand All @@ -65,15 +68,15 @@ export function useSpecificEditorSettings() {

richEditingEnabled: true,
supportsTemplateMode: true,
focusMode: canvasMode !== 'view',
focusMode: canvas !== 'view',
defaultRenderingMode,
onNavigateToEntityRecord,
onNavigateToPreviousEntityRecord,
__unstableIsPreviewMode: canvasMode === 'view',
__unstableIsPreviewMode: canvas === 'view',
};
}, [
settings,
canvasMode,
canvas,
defaultRenderingMode,
onNavigateToEntityRecord,
onNavigateToPreviousEntityRecord,
Expand Down
41 changes: 29 additions & 12 deletions packages/edit-site/src/components/editor/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ import SiteIcon from '../site-icon';
import useEditorIframeProps from '../block-editor/use-editor-iframe-props';
import useEditorTitle from './use-editor-title';
import { useIsSiteEditorLoading } from '../layout/hooks';
import { useAdaptEditorToCanvas } from './use-adapt-editor-to-canvas';

const { Editor, BackButton } = unlock( editorPrivateApis );
const { useHistory, useLocation } = unlock( routerPrivateApis );
Expand Down Expand Up @@ -80,13 +81,14 @@ const siteIconVariants = {
export default function EditSiteEditor( { isPostsList = false } ) {
const disableMotion = useReducedMotion();
const { params } = useLocation();
const { canvas = 'view' } = params;
const isLoading = useIsSiteEditorLoading();
useAdaptEditorToCanvas( canvas );
const {
editedPostType,
editedPostId,
contextPostType,
contextPostId,
canvasMode,
isEditingPage,
supportsGlobalStyles,
showIconLabels,
Expand All @@ -97,7 +99,6 @@ export default function EditSiteEditor( { isPostsList = false } ) {
const {
getEditorCanvasContainerView,
getEditedPostContext,
getCanvasMode,
isPage,
getEditedPostType,
getEditedPostId,
Expand All @@ -114,7 +115,6 @@ export default function EditSiteEditor( { isPostsList = false } ) {
editedPostId: getEditedPostId(),
contextPostType: _context?.postId ? _context.postType : undefined,
contextPostId: _context?.postId ? _context.postId : undefined,
canvasMode: getCanvasMode(),
isEditingPage: isPage(),
supportsGlobalStyles: getCurrentTheme()?.is_block_theme,
showIconLabels: get( 'core', 'showIconLabels' ),
Expand All @@ -129,7 +129,7 @@ export default function EditSiteEditor( { isPostsList = false } ) {
const _isPreviewingTheme = isPreviewingTheme();
const hasDefaultEditorCanvasView = ! useHasEditorCanvasContainer();
const iframeProps = useEditorIframeProps();
const isEditMode = canvasMode === 'edit';
const isEditMode = canvas === 'edit';
const postWithTemplate = !! contextPostId;
const loadingProgressId = useInstanceId(
CanvasLoader,
Expand All @@ -144,16 +144,15 @@ export default function EditSiteEditor( { isPostsList = false } ) {
// Forming a "block formatting context" to prevent margin collapsing.
// @see https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Block_formatting_context
css:
canvasMode === 'view'
canvas === 'view'
? `body{min-height: 100vh; ${
currentPostIsTrashed ? '' : 'cursor: pointer;'
}}`
: undefined,
},
],
[ settings.styles, canvasMode, currentPostIsTrashed ]
[ settings.styles, canvas, currentPostIsTrashed ]
);
const { setCanvasMode } = unlock( useDispatch( editSiteStore ) );
const { __unstableSetEditorMode, resetZoomLevel } = unlock(
useDispatch( blockEditorStore )
);
Expand Down Expand Up @@ -264,7 +263,6 @@ export default function EditSiteEditor( { isPostsList = false } ) {
showTooltip
tooltipPosition="middle right"
onClick={ () => {
setCanvasMode( 'view' );
__unstableSetEditorMode(
'edit'
);
Expand All @@ -276,10 +274,29 @@ export default function EditSiteEditor( { isPostsList = false } ) {
isPostsList &&
params?.focusMode
) {
history.push( {
page: 'gutenberg-posts-dashboard',
postType: 'post',
} );
history.push(
{
page: 'gutenberg-posts-dashboard',
postType: 'post',
},
undefined,
{
transition:
'canvas-mode-view-transition',
}
);
} else {
history.push(
{
...params,
canvas: undefined,
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Screenshot 2024-10-18 at 12 08 09 pm

I don't know if that's intentional or not.

undefined,
{
transition:
'canvas-mode-view-transition',
}
);
}
} }
>
Expand Down
53 changes: 53 additions & 0 deletions packages/edit-site/src/components/editor/use-adapt-editor-to-canvas.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/**
* WordPress dependencies
*/
import { useDispatch, useSelect, useRegistry } from '@wordpress/data';
import { store as blockEditorStore } from '@wordpress/block-editor';
import { store as editorStore } from '@wordpress/editor';
import { useLayoutEffect } from '@wordpress/element';
import { store as preferencesStore } from '@wordpress/preferences';

export function useAdaptEditorToCanvas( canvas ) {
const { clearSelectedBlock } = useDispatch( blockEditorStore );
const {
setDeviceType,
closePublishSidebar,
setIsListViewOpened,
setIsInserterOpened,
} = useDispatch( editorStore );
const { get: getPreference } = useSelect( preferencesStore );
const registry = useRegistry();
useLayoutEffect( () => {
const isMediumOrBigger =
window.matchMedia( '(min-width: 782px)' ).matches;
registry.batch( () => {
clearSelectedBlock();
setDeviceType( 'Desktop' );
closePublishSidebar();
setIsInserterOpened( false );

// Check if the block list view should be open by default.
// If `distractionFree` mode is enabled, the block list view should not be open.
// This behavior is disabled for small viewports.
if (
isMediumOrBigger &&
canvas === 'edit' &&
getPreference( 'core', 'showListViewByDefault' ) &&
! getPreference( 'core', 'distractionFree' )
) {
setIsListViewOpened( true );
} else {
setIsListViewOpened( false );
}
} );
}, [
canvas,
registry,
clearSelectedBlock,
setDeviceType,
closePublishSidebar,
setIsInserterOpened,
setIsListViewOpened,
getPreference,
] );
}
Loading
Loading