Skip to content

Add a control to reset pattern overrides #57845

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

Merged
kevin940726 merged 4 commits into from
Jan 17, 2024
Merged

Add a control to reset pattern overrides #57845

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9462711
Add a control to reset pattern overrides
kevin940726 Jan 15, 2024
6b4c307
Address code reviews
kevin940726 Jan 16, 2024
ab97ea5
Don't render reset button when there is no binding blocks
kevin940726 Jan 16, 2024
5e93c42
Set the `__experimentalIsFocusable` prop on the Reset to original too…
talldan Jan 17, 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
45 changes: 40 additions & 5 deletions packages/block-library/src/block/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,13 @@ function setBlockEditMode( setEditMode, blocks, mode ) {
} );
}

function getHasOverridableBlocks( blocks ) {
return blocks.some( ( block ) => {
if ( isPartiallySynced( block ) ) return true;
return getHasOverridableBlocks( block.innerBlocks );
} );
}

export default function ReusableBlockEdit( {
name,
attributes: { ref, overrides },
Expand Down Expand Up @@ -208,15 +215,23 @@ export default function ReusableBlockEdit( {
[ innerBlocks, setBlockEditingMode ]
);

// Apply the initial overrides from the pattern block to the inner blocks.
useEffect( () => {
const initialBlocks =
const hasOverridableBlocks = useMemo(
() => getHasOverridableBlocks( innerBlocks ),
[ innerBlocks ]
);

const initialBlocks = useMemo(
() =>
// Clone the blocks to generate new client IDs.
editedRecord.blocks?.map( ( block ) => cloneBlock( block ) ) ??
( editedRecord.content && typeof editedRecord.content !== 'function'
? parse( editedRecord.content )
: [] );
: [] ),
[ editedRecord.blocks, editedRecord.content ]
);

// Apply the initial overrides from the pattern block to the inner blocks.
useEffect( () => {
defaultValuesRef.current = {};
const editingMode = getBlockEditingMode( patternClientId );
// Replace the contents of the blocks with the overrides.
Expand All @@ -237,7 +252,7 @@ export default function ReusableBlockEdit( {
}, [
__unstableMarkNextChangeAsNotPersistent,
patternClientId,
editedRecord,
initialBlocks,
replaceInnerBlocks,
registry,
getBlockEditingMode,
Expand Down Expand Up @@ -293,6 +308,12 @@ export default function ReusableBlockEdit( {
editOriginalProps.onClick( event );
};

const resetOverrides = () => {
if ( overrides ) {
replaceInnerBlocks( patternClientId, initialBlocks );
}
};

let children = null;

if ( hasAlreadyRendered ) {
Expand Down Expand Up @@ -333,6 +354,20 @@ export default function ReusableBlockEdit( {
</ToolbarGroup>
</BlockControls>
) }

{ hasOverridableBlocks && (
<BlockControls>
<ToolbarGroup>
<ToolbarButton
onClick={ resetOverrides }
aria-disabled={ overrides ? 'false' : 'true' }
Copy link
Contributor

@talldan talldan Jan 17, 2024

Choose a reason for hiding this comment

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

I remember that Buttons are a bit unusual in that you have to pass disabled and __experimentalIsFocusable in order for it to retain focus.

Pushed a commit that does that.

>
{ __( 'Reset to original' ) }
</ToolbarButton>
</ToolbarGroup>
</BlockControls>
) }

{ children === null ? (
<div { ...innerBlocksProps } />
) : (
Expand Down