Skip to content

Commit

Permalink
Pattern block: Ensure consistent editing of overrides in Write Mode (W…
Browse files Browse the repository at this point in the history 
…ordPress#65408)

* Move pattern block block editing state to store selector

Fix broken `getEnabledBlockParents` selector unit tests

Update test

Fix flash of content when in zoom out mode

* Combine into one selector

* Add unit tests

* Add zoom out pattern block editing mode test

----

Co-authored-by: talldan <talldanwp@git.wordpress.org>
Co-authored-by: getdave <get_dave@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Co-authored-by: draganescu <andraganescu@git.wordpress.org>
  • Loading branch information
@talldan @getdave
@youknowriad @draganescu
5 people authored Oct 8, 2024
1 parent d6a4c72 commit ace9735
Show file tree
Hide file tree
Showing 5 changed files with 175 additions and 53 deletions.
18 changes: 18 additions & 0 deletions packages/block-editor/src/store/private-selectors.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -684,3 +684,21 @@ export function getClosestAllowedInsertionPointForPattern(
export function getInsertionPoint( state ) {
return state.insertionPoint;
}

/**
* Retrieves the number of parent pattern blocks.
*
* @param {Object} state Global application state.
* @param {string} clientId The block client ID.
*
* @return {number} The number of parent pattern blocks.
*/
export function getParentPatternCount( state, clientId ) {
const parents = getBlockParents( state, clientId );
return parents.reduce( ( count, parent ) => {
if ( getBlockName( state, parent ) === 'core/block' ) {
return count + 1;
}
return count;
}, 0 );
}
38 changes: 38 additions & 0 deletions packages/block-editor/src/store/selectors.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import {
getSectionRootClientId,
isSectionBlock,
getParentSectionBlock,
getParentPatternCount,
} from './private-selectors';

/**
Expand Down Expand Up @@ -2972,6 +2973,43 @@ export const getBlockEditingMode = createRegistrySelector(
clientId = '';
}

// Handle pattern blocks (core/block) and the content of those blocks.
const parentPatternCount = getParentPatternCount( state, clientId );

// Make the outer pattern block content only mode.
if (
getBlockName( state, clientId ) === 'core/block' &&
parentPatternCount === 0
) {
return 'contentOnly';
}

if ( parentPatternCount > 0 ) {
// Disable nested patterns.
if ( parentPatternCount > 1 ) {
return 'disabled';
}

// Disable pattern content editing in zoom-out mode.
const _isZoomOut =
__unstableGetEditorMode( state ) === 'zoom-out';
if ( _isZoomOut ) {
return 'disabled';
}

// If the block has a binding of any kind, allow content only editing.
const attributes = getBlockAttributes( state, clientId );
if (
Object.keys( attributes?.metadata?.bindings ?? {} )
?.length > 0
) {
return 'contentOnly';
}

// Otherwise, the block is part of the pattern source and should not be editable.
return 'disabled';
}

// In zoom-out mode, override the behavior set by
// __unstableSetBlockEditingMode to only allow editing the top-level
// sections.
Expand Down
3 changes: 2 additions & 1 deletion packages/block-editor/src/store/test/private-selectors.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,6 @@ describe( 'private selectors', () => {
'e178812d-ce5e-48c7-a945-8ae4ffcbbb7c',
],
] ),

order: new Map( [
[
'ef45d5fd-5234-4fd5-ac4f-c3736c7f9337',
Expand All @@ -443,6 +442,7 @@ describe( 'private selectors', () => {
],
[ '', [ 'ef45d5fd-5234-4fd5-ac4f-c3736c7f9337' ] ],
] ),
byClientId: new Map( [] ),
},
blockEditingModes: new Map( [
[ '', 'disabled' ],
Expand Down Expand Up @@ -495,6 +495,7 @@ describe( 'private selectors', () => {
],
[ '', [ 'ef45d5fd-5234-4fd5-ac4f-c3736c7f9337' ] ],
] ),
byClientId: new Map( [] ),
},
blockEditingModes: new Map( [
[ '', 'disabled' ],
Expand Down
112 changes: 111 additions & 1 deletion packages/block-editor/src/store/test/selectors.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3079,7 +3079,7 @@ describe( 'selectors', () => {
byClientId: new Map(
Object.entries( {
block1: { name: 'core/test-block-ancestor' },
block2: { name: 'core/block' },
block2: { name: 'core/group' },
block3: { name: 'core/test-block-parent' },
} )
),
Expand Down Expand Up @@ -4668,4 +4668,114 @@ describe( 'getBlockEditingMode', () => {
)
).toBe( 'disabled' );
} );

describe( 'pattern blocks', () => {
const patternBlockState = {
settings: {},
blocks: {
byClientId: new Map(
Object.entries( {
'pattern-a': { name: 'core/block' },
'pattern-b': { name: 'core/block' },
'heading-a': { name: 'core/heading' },
'paragraph-a': { name: 'core/paragraph' },
'paragraph-b': { name: 'core/paragraph' },
} )
),
order: new Map(
Object.entries( {
'': [ 'pattern-a' ],
'pattern-a': [
'heading-a',
'paragraph-a',
'pattern-b',
],
'pattern-b': [ 'paragraph-b' ],
} )
),
parents: new Map(
Object.entries( {
'paragraph-b': 'pattern-b',
'pattern-b': 'pattern-a',
'paragraph-a': 'pattern-a',
'heading-a': 'pattern-a',
'pattern-a': '',
} )
),
blockListSettings: {
'pattern-a': {},
'pattern-b': {},
},
attributes: new Map(
Object.entries( {
'paragraph-a': {
metadata: {
bindings: {
__default: {
source: 'core/pattern-overrides',
},
},
},
},
'paragraph-b': {
metadata: {
bindings: {
__default: {
source: 'core/pattern-overrides',
},
},
},
},
} )
),
},
};

it( 'should return contentOnly for the outer pattern block', () => {
expect(
getBlockEditingMode( patternBlockState, 'pattern-a' )
).toBe( 'contentOnly' );
} );

it( 'should return contentOnly for blocks with bindings in the outer pattern', () => {
expect(
getBlockEditingMode( patternBlockState, 'paragraph-a' )
).toBe( 'contentOnly' );
} );

it( 'should return disabled for unbound blocks', () => {
expect(
getBlockEditingMode( patternBlockState, 'heading-a' )
).toBe( 'disabled' );
} );

it( 'should return disabled for the nested pattern', () => {
expect(
getBlockEditingMode( patternBlockState, 'pattern-a' )
).toBe( 'contentOnly' );
} );

it( 'should return disabled for blocks with bindings in the nested pattern', () => {
expect(
getBlockEditingMode( patternBlockState, 'paragraph-b' )
).toBe( 'disabled' );
} );

it( 'should disable all inner blocks of the outer pattern in zoom out mode with the outer pattern in content only mode', () => {
const state = {
...patternBlockState,
editorMode: 'zoom-out',
};
expect( getBlockEditingMode( state, 'pattern-a' ) ).toBe(
'contentOnly'
);
[ 'paragraph-a', 'paragraph-b', 'heading-a', 'pattern-b' ].forEach(
( block ) => {
expect( getBlockEditingMode( state, block ) ).toBe(
'disabled'
);
}
);
} );
} );
} );
57 changes: 6 additions & 51 deletions packages/block-library/src/block/edit.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import clsx from 'clsx';
* WordPress dependencies
*/
import { useSelect, useDispatch } from '@wordpress/data';
import { useRef, useMemo, useEffect } from '@wordpress/element';
import { useRef, useMemo } from '@wordpress/element';
import {
useEntityRecord,
store as coreStore,
Expand Down Expand Up @@ -37,12 +37,10 @@ import { getBlockBindingsSource } from '@wordpress/blocks';
/**
* Internal dependencies
*/
import { name as patternBlockName } from './index';
import { unlock } from '../lock-unlock';

const { useLayoutClasses } = unlock( blockEditorPrivateApis );
const { isOverridableBlock, hasOverridableBlocks } =
unlock( patternsPrivateApis );
const { hasOverridableBlocks } = unlock( patternsPrivateApis );

const fullAlignments = [ 'full', 'wide', 'left', 'right' ];

Expand Down Expand Up @@ -75,22 +73,6 @@ const useInferredLayout = ( blocks, parentLayout ) => {
}, [ blocks, parentLayout ] );
};

function setBlockEditMode( setEditMode, blocks, mode ) {
blocks.forEach( ( block ) => {
const editMode =
mode ||
( isOverridableBlock( block ) ? 'contentOnly' : 'disabled' );
setEditMode( block.clientId, editMode );

setBlockEditMode(
setEditMode,
block.innerBlocks,
// Disable editing for nested patterns.
block.name === patternBlockName ? 'disabled' : mode
);
} );
}

function RecursionWarning() {
const blockProps = useBlockProps();
return (
Expand Down Expand Up @@ -171,7 +153,6 @@ function ReusableBlockEdit( {
name,
attributes: { ref, content },
__unstableParentLayout: parentLayout,
clientId: patternClientId,
setAttributes,
} ) {
const { record, hasResolved } = useEntityRecord(
Expand All @@ -184,49 +165,24 @@ function ReusableBlockEdit( {
} );
const isMissing = hasResolved && ! record;

const { setBlockEditingMode, __unstableMarkLastChangeAsPersistent } =
const { __unstableMarkLastChangeAsPersistent } =
useDispatch( blockEditorStore );

const {
innerBlocks,
onNavigateToEntityRecord,
editingMode,
hasPatternOverridesSource,
} = useSelect(
const { onNavigateToEntityRecord, hasPatternOverridesSource } = useSelect(
( select ) => {
const { getBlocks, getSettings, getBlockEditingMode } =
select( blockEditorStore );
const { getSettings } = select( blockEditorStore );
// For editing link to the site editor if the theme and user permissions support it.
return {
innerBlocks: getBlocks( patternClientId ),
onNavigateToEntityRecord:
getSettings().onNavigateToEntityRecord,
editingMode: getBlockEditingMode( patternClientId ),
hasPatternOverridesSource: !! getBlockBindingsSource(
'core/pattern-overrides'
),
};
},
[ patternClientId ]
[]
);

// Sync the editing mode of the pattern block with the inner blocks.
useEffect( () => {
setBlockEditMode(
setBlockEditingMode,
innerBlocks,
// Disable editing if the pattern itself is disabled.
editingMode === 'disabled' || ! hasPatternOverridesSource
? 'disabled'
: undefined
);
}, [
editingMode,
innerBlocks,
setBlockEditingMode,
hasPatternOverridesSource,
] );

const canOverrideBlocks = useMemo(
() => hasPatternOverridesSource && hasOverridableBlocks( blocks ),
[ hasPatternOverridesSource, blocks ]
Expand All @@ -244,7 +200,6 @@ function ReusableBlockEdit( {
} );

const innerBlocksProps = useInnerBlocksProps( blockProps, {
templateLock: 'all',
layout,
value: blocks,
onInput: NOOP,
Expand Down

0 comments on commit ace9735

Please sign in to comment.