Global styles: background UI controls #59454
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
ramonjd
added
[Type] Enhancement
|
Size Change: +523 B (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
This was referenced Feb 29, 2024
Base automatically changed from
add/background-theme-json-top-level
to
trunk
February 29, 2024 22:17
ramonjd
force-pushed
the
add/background-global-styles-panel
branch
2 times, most recently
from
8a1230d
to
847d0e5
Compare
|
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
force-pushed
the
add/background-global-styles-panel
branch
from
659bfad
to
384d0bc
Compare
ramonjd
commented
Mar 1, 2024
| style={ value } | ||
| inheritedValue={ inheritedValue } | ||
| /> | ||
| { shouldShowBackgroundSizeControls && ( |
There was a problem hiding this comment.
I think this is right... allow this panel if theme.json (and incoming block supports flag) has background.backgroundSize set to true
There was a problem hiding this comment.
Is it true by default? I can see the controls in the global styles UI without changing anything in theme.json.
There was a problem hiding this comment.
Hmm, something fishy is going on. It's true by default, but I can't see from where 🙃
There was a problem hiding this comment.
Oh face palm moment.
I forgot I added "backgroundImage" and "backgroundSize" to appearanceTools
andrewserong
reviewed
Mar 4, 2024
There was a problem hiding this comment.
Very cool, this is fun to play with! I've just added the "Needs Design Feedback" label, since it looks like there'll be a few things to figure out.
The main question for me in playing around with it is: what should the default size values be when someone first uploads or adds an image? Here's how it looks for me with a regular photo on a very tall template (it results in the image being very zoomed in):
Defaulting to Cover works nicely for the Group block, but in practice, it feels like at the root of the site, folks might rarely want to use either Cover or Contain, since it'll be pretty inconsistent depending on the height of the current page. So perhaps in the root of global styles, defaulting to Fixed might work better?
Also, in global styles, what do you think about displaying the size controls by default? It looked a bit empty to me in the initial state after adding an image:
|
Thank you for testing @andrewserong 🙇🏻
Fixed and no-repeat could work as a default - that's Agree that it would allow users to see the image they've added, regardless of size Then folks could change the settings themselves. It might also work for the theme.json side of things - Gutenberg setting the backgroundSize to
Can do. 👍🏻 I basically copied the post editor. |
I think so — worth having a play with and seeing how it feels. It'll be interesting to then think through once we've added an image, which is the first control we find we repeatedly reach for after that 🤔
Yeah, it does to me, too. It's funny how these things seem to become clearer once a PR is up. When interacting with a particular block in the post editor,
Nice one! |
ramonjd
force-pushed
the
add/background-global-styles-panel
branch
from
384d0bc
to
b6292db
Compare
@andrewserong I started a PR to test it out: 👍🏻 |
ramonjd
force-pushed
the
add/background-global-styles-panel
branch
2 times, most recently
from
ffdefdc
to
afa006d
Compare
Co-authored-by: Andrew Serong <14988353+andrewserong@users.noreply.github.com>
|
Thanks again @andrewserong
Oh, thanks for the nudge. I'd added that to my list but hadn't acknowledged it in the comments 👍🏻 It's in the works! |
No worries! Thanks again for all the detailed work here, it's such an exciting feature 😀 |
Cool cool yeah definitely let's not block this PR. Thanks for clarifying! |
5 tasks
|
Thanks again, everyone! Ongoing follow ups: |
I figured that might be the case :D
Seems a simple solution :) |
|
@ramonjd we might also consider naming this whole section "Background image" rather than just "Background", which may mislead users into believing they can set the background color here. |
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Mar 27, 2024
* Refactor global styles and refactor existing background components * Porting over existing hook code to shared, global styles component. * Move tests, move styles, remove duplicate code from block support hook * Pull over changes to background.js from WordPress#59557 * Add default control values for block supports. The default backgroundSize value for block backgrounds is 'cover' * Resetting position if it's center and size is not contain. * Add background-image to INDIRECT_PROPERTIES_METADATA because the value is "indirectly" stored in an array, at least determined by multiple values in an array. --------- Co-authored-by: ramonjd <ramonopoly@git.wordpress.org> Co-authored-by: andrewserong <andrewserong@git.wordpress.org> Co-authored-by: tellthemachines <isabel_brison@git.wordpress.org> Co-authored-by: jameskoster <jameskoster@git.wordpress.org>
|
Great (and overdue) feature, which was missing in FSE Themes from start. (And existing in Classic Themes from start.) But without the "Fixed background" option like in Cover block, the result looks ... strange. |
It's the first item on the TODO list here for WordPress 6.6: |
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
* Refactor global styles and refactor existing background components * Porting over existing hook code to shared, global styles component. * Move tests, move styles, remove duplicate code from block support hook * Pull over changes to background.js from WordPress#59557 * Add default control values for block supports. The default backgroundSize value for block backgrounds is 'cover' * Resetting position if it's center and size is not contain. * Add background-image to INDIRECT_PROPERTIES_METADATA because the value is "indirectly" stored in an array, at least determined by multiple values in an array. --------- Co-authored-by: ramonjd <ramonopoly@git.wordpress.org> Co-authored-by: andrewserong <andrewserong@git.wordpress.org> Co-authored-by: tellthemachines <isabel_brison@git.wordpress.org> Co-authored-by: jameskoster <jameskoster@git.wordpress.org>
This was referenced May 2, 2024
ramonjd
added
the
Needs Dev Note
ramonjd
added
has dev note
12 tasks
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.
Dev Note 📓
#59354 (comment)
What?
Part of:
Follow up to:
Related:
This PR add background image UI controls to top-level global styles.
TODO
Why?
Background styles can now be added to theme.json since #59354.
The styles are currently only " top-level", which means they're added to
bodyselector.This PR allows users to edit these styles in the site editor.
How?
Similar to dimensions and typography panels, this PR refactors the background block supports component so that it can be shared between the site and post editors.
It moves all relevant tests and styles to the
/global-stylesdirectory.Testing Instructions
This is a big one, so get comfortable.
Firstly, check out this branch.
At this stage it's probably good to check if there are any regressions to background block supports. So, add a group block to a post, and make sure you can:
If that's all good, head over to the site editor.
I've been using empty theme to test. Here is some test theme.json, with a relative path to the updated theme.json schema:
{ "$schema": "../../schemas/json/theme.json", "version": 2, "settings": { "appearanceTools": true, "background": { "backgroundImage": true, "backgroundSize": true } }, "styles": { "color": { "background": "tomato" }, "background": { "backgroundImage": { "url": "https://i0.wp.com/wordpress.org/files/2023/12/sotw-dotorg-drawer.png?w=1807&ssl=1", "source": "file" }, "backgroundPosition": "30% 30%", "backgroundRepeat": "repeat", "backgroundSize": "cover" } } }Ensure that:
undefinedfor site backgrounds. See table images below.Testing Instructions for Keyboard
In the global styles panel, ensure you can navigate to the "Background" item in the list to activate the background styles panel. There should be no regressions to keyboard interaction with background controls.
Screenshots or screencast
2024-03-01.14.39.23.mp4