Fix inner block block crash when rendering Template Part "Replace" UI during click-through #59988
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. |
|
|
|
Size Change: 0 B Total Size: 1.71 MB ℹ️ View Unchanged
|
This comment was marked as outdated.
This comment was marked as outdated.
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.
What?
Fixes a block crash in the Template Part blocks that can be "Replaced".
by accounting for possible
nullvalue ofdocument.defaultViewwhen cleaning up event listeners.Why?
To avoid block crash when "clicking-through" these blocks to inner blocks that are commonly inside them.
How?
Some Template Parts are "replaceable" with other patterns. Users are shown a list of possible pattern options under the
Replacepanel in the block sidebar.These patterns use the
BlockPreviewcomponent. Ultimately this ends up in theIframecomponent.gutenberg/packages/block-editor/src/components/iframe/index.js
Line 103 in dbfed70
Each iframe has it's own
document.defaultViewwhich according to MDN...Currently we have event listener cleanup that always expects
defaultViewnot to benull. Unfortunately when "clicking through" the Template Part, it seems that the previews get briefly rendered and then quickly removed when the user ends up selecting an inner block of the template part.From testing, I can see that it is possible for
defaultViewto benulland thus attemptingremoveEventListeneron it will throw an error.This PR fixes that by conditionalising the
removeEventListenerhere...gutenberg/packages/block-editor/src/components/iframe/index.js
Lines 218 to 221 in dbfed70
Testing Instructions
On Trunk
HeaderTemplate Part to do this.On this PR
HeaderTemplate Part to do this.Testing Instructions for Keyboard
Screenshots or screencast
Before (On Trunk)
Screen.Capture.on.2024-03-19.at.11-00-50.mp4
After (this PR)
Screen.Capture.on.2024-03-19.at.11-01-40.mp4