Gradient: Fix clearing a custom gradient from throwing a React warning #37051
Conversation
This file contains hidden or 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
andrewserong
added
[Type] Bug
andrewserong
added
the
Backport to WP 6.9 Beta/RC
2 tasks
…icit undefined color styles to blockProps
andrewserong
force-pushed
the
fix/gradients-react-warning-when-clearing-custom-gradient
branch
from
d423a9a to
9219762
Compare
|
Size Change: +7 B (0%) Total Size: 1.1 MB
ℹ️ View Unchanged
|
oandregal
reviewed
Dec 3, 2021
| const extraStyles = {}; | ||
|
|
||
| if ( textColor ) { | ||
| extraStyles.color = getColorObjectByAttributeValues( |
Member
There was a problem hiding this comment.
This is a good fix.
However, inspecting getColorObjectByAttributeValues there's a path in which the resulting color value still can be undefined: when passing a textColor that is not present in the list of colors. This can happen upon switching themes, for example. Specific steps:
- Use TwentyTwentyTwo.
- Add a paragraph and select a preset text color from the theme.
- Switch to EmptyTheme.
At this point, the text color is undefined. I wonder if getColorObjectByAttributeValues should return null instead of undefined for such a case.
Though at the moment this is not reproducible because we have a bug in trunk by which the preset colors are serialized as inline styles and not as classes. Going to follow up #36770
oandregal
approved these changes
Dec 3, 2021
Member
|
The failing test ( |
oandregal
deleted the
fix/gradients-react-warning-when-clearing-custom-gradient
branch
ntsekouras
reviewed
Dec 3, 2021
| </BlockEditorProvider> | ||
| ); | ||
|
|
||
| expect( getStyleObj ).toHaveBeenLastCalledWith( { |
Contributor
There was a problem hiding this comment.
This test is failing on trunk right now. I'm looking at it, but if you have quick thoughts, please share to fix them 😄
Contributor
Author
There was a problem hiding this comment.
Thanks Nik! I think this one might potentially be resolved as of #37108, which has just been merged in. I'll keep an eye on trunk just in case, and happy to follow-up if there are more issues.
noisysocks
removed
the
Backport to WP 6.9 Beta/RC
noisysocks
pushed a commit
that referenced
this pull request
Dec 6, 2021
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.
Description
Fixes #36899
This PR updates the
withColorPaletteStylesfunction in the Color block support to not return emptycolorandbackgroundColorkeys. This fixes a React warning that gets thrown when clearing a custom gradient used on a block's background color. To provide extra context:The color gradient gets stored using the
backgroundshorthand. When we clear a gradient, thebackgroundstyle gets cleared, however inwithColorPaletteStylesthebackgroundColoris also being set toundefined. Unfortunately for us, React treats this undefined value as us updating the style for the component, even though it has no visual effect. We receive the following warning in the console:By explicitly ensuring that we don't set the
backgroundColorproperty, we avoid throwing the React warning. Note: this fix is preferable to updating how we store the gradient value, so that we don't have to change how the gradient is saved in post content.How has this been tested?
Screenshots
Types of changes
Bug fix (non-breaking change which fixes an issue)
Checklist:
*.native.jsfiles for terms that need renaming or removal).