Fix MarginVisualizer and PaddingVisualizer #59227
Merged
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
noisysocks
added
[Type] Bug
|
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: -8 B (0%) Total Size: 1.7 MB
ℹ️ View Unchanged
|
|
Thanks for the PR! Great PR description. These components always seem to be going wrong in one way or another. I tested the PR, there are some cases where it's not quite working for me. Probably easiest to show in a video: Kapture.2024-02-21.at.14.30.24.mp4Top/Bottom padding does seem to work well. Left/Right padding didn't seem to update for some steps, and also seemed to have outdated values (not sure why as it's the same code as top/bottom padding, but see when I drag back to zero). Margin seems to still have an issue with outdated values. Here I'm adjusting the size of the 'Team Member' pattern as it's what I had open. Not sure if there's something specific to that pattern that causes this issue. It would be interesting to see if you can also reproduce it or if it's just me! |
|
Aha, looks like you found a perfect example of a block that doesn't change size if the padding changes. Good catch. Looks like I can't use |
…gVisualizer showing the *last* value
ResizeObserver doesn't work in the case where an element with a fixed width has its padding changed.
noisysocks
force-pushed
the
fix/margin-padding-visualizer
branch
from
5a67442
to
77ef06c
Compare
|
OK I've updated this to use the rAF approach for both. Since |
|
Flaky tests detected in 77ef06c. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/8014279096
|
|
Awesome refactor. Things are working as described for me. The visualizer is updating according the custom or step slider value. 🍺 2024-02-26.16.49.55.mp4Not related to this PR, as it's on trunk as well, but I'm just wondering if the custom slide controller should behave similarly. It doesn't update the visualizer. Or if it's even possible? 2024-02-26.16.56.06.mp4 |
This line implies to me that it's supposed to do that. Must be bug. One thing at a time though 😀 |
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, why, how?
Fixes two bugs with
MarginVisualizerandPaddingVisualizer. These are the overlays that appear when you hover over the Margin or Padding controls in a block's settings.1. The
MarginVisualizerdoesn't appear at all.This one's easy to fix. This line needs to use the
valueprop instead ofattributes. It looks like it was missed during a recent refactor: #56783.2. Both
MarginVisualizerandPaddingVisualizershow the previous margin and padding value.The easiest way to see this bug is to increment/decrement the margin or padding slider one by one using the keyboard arrow keys. You'll note that the visualiser displays the padding of the previous value instead of the current value.
Video of bug in
trunk:Kapture.2024-02-21.at.16.10.04.mp4
This happens because the visualiser overlay uses the
marginandpaddingvalue that comes back fromgetComputedStylewhich is not updated until right before the browser paints.MarginVisualizerandPaddingVisualizercallgetComputedStylein auseEffectwhenmarginorpaddingchanges. React does not guarantee thatuseEffectwill be called after the browser paints and, in fact,useEffectcan be called before a paint when React is handling a user event (e.g. a click) or if auseLayoutEffectin the component tree updates state (e.g. callssetState). See facebook/react#20863 (comment).To fixedit: This doesn't work, see @talldan's comment below, so we have to use the rAF approach described below for both padding and margin.PaddingVisualizerwe can use aResizeObserverwith{ box: 'border-box' }since this will fire when the padding changes.To fix
MarginVisualizeris more hacky. To my knowledge there's no API likeResizeObserverthat we can use that will trigger when the computed margin changes. Instead I've used auseLayoutEffectwith two calls to rAF to ensure that we callgetComputedStyleafter the first paint but before the second paint. (This video is great if you're like me and need a refresher on how the event loop works.)Video of this branch:
Kapture.2024-02-21.at.16.24.22.mp4
Testing Instructions
Insert a block and tweak its margin and padding in the block settings. The visualiser should appear on canvas and accurately illustrate the block's margin and padding.