Background image: explicitly set background repeat value in user styles #61526
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
Fix edge case in which theme.json defines a backgroundSize value of 'cover' and a backgroundRepeat value. If a user backgroundSize is set, ignore the inherited backgroundRepeat value as style?.background?.backgroundRepeat is deliberately set to undefined in updateBackgroundSize().
Roll back previous fix, and explicitly set backgroundRepeat to "repeat", because it seems as if it's being overwritten by merging styles (undefined values are stripped)
ramonjd
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. |
ramonjd
commented
May 9, 2024
| @@ -439,7 +439,7 @@ function BackgroundSizeToolsPanelItem( { | |||
| setImmutably( | |||
| style, | |||
| [ 'background', 'backgroundRepeat' ], | |||
| repeatCheckedValue === true ? 'no-repeat' : undefined | |||
| repeatCheckedValue === true ? 'no-repeat' : 'repeat' | |||
| @@ -51,6 +51,11 @@ export const __EXPERIMENTAL_STYLE_PROPERTY = { | |||
| support: [ 'background', 'backgroundSize' ], | |||
| useEngine: true, | |||
| }, | |||
| backgroundPosition: { | |||
There was a problem hiding this comment.
Just adding this here for completeness
| @@ -39,7 +39,7 @@ const backgroundImage = { | |||
| }; | |||
|
|
|||
| const backgroundPosition = { | |||
| name: 'backgroundRepeat', | |||
| name: 'backgroundPosition', | |||
There was a problem hiding this comment.
I think this might have just been a typo from #58592
71 tasks
|
Size Change: +19 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
andrewserong
approved these changes
May 10, 2024
There was a problem hiding this comment.
Great catch, thanks for the detailed testing instructions and for fixing up the typo, too!
This is nesting nicely for each of the different permutations in site wide background images, while not causing any issues at the block level when adjusting for a Group block.
LGTM! 🚀
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?
Explicitly sets a "repeat" value for user background repeat styles.
Also adds/fixes some missing styles properties.
Why?
This mainly fixes an edge case where theme.json defines background size of "cover" and "no-repeat".
Now, these two properties don't really work together visually, but they're valid CSS.
When setting
backgroundRepeattoundefinedin user styles, it seems as if the theme.json value will take precedence during the global styles config merge of the two styles objects (theme.json and user).This is of course undesirable as the user styles should take precedence, but since it we set it to undefined Gutenberg will go for the truthy value when merging.
How?
The only fix I could come up with was setting the string value of "repeat" to ensure the user styles take precedence.
Testing Instructions
Check that the global styles background image controls are still usable in the site editor with the follow theme.json.
{ "$schema": "https://schemas.wp.org/trunk/theme.json", "version": 3, "settings": { "appearanceTools": true }, "styles": { "color": { "text": "green" }, "background": { "backgroundImage": { "url": "https://images.pexels.com/photos/20111605/pexels-photo-20111605/free-photo-of-surf-in-ericeira.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2" }, "backgroundPosition": "center center", "backgroundRepeat": "no-repeat", "backgroundSize": "cover" } } }All other manifestations should work as expected, and their values should show up in the global styles background image controls, e.g.,
Screenshots or screencast
Before
2024-05-09.22.27.49.mp4
After
2024-05-09.22.15.35.mp4