Skip to content

Background images: add defaults for background size #62046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ramonjd merged 9 commits into from
May 30, 2024
Merged

Background images: add defaults for background size #62046

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3a60214
This commit experiments with setting a default background size of 50%…
ramonjd May 28, 2024
7d4520c
Checking for default value when uploading/selecting an image
ramonjd May 28, 2024
c44cdab
Rolling back setting the default to 50% - the UX is not clear. Should…
ramonjd May 28, 2024
5e6f385
Check for an id, which indicates that the image has been uploaded to …
ramonjd May 28, 2024
3e1e3a2
When switching to "Tile" in the background size toggle, roll back def…
ramonjd May 30, 2024
ebfb30e
Check for existing backgroundPosition
ramonjd May 30, 2024
32a2e6c
Clear position values between toggling
ramonjd May 30, 2024
aa0019b
Don't need value check as it's always reset
ramonjd May 30, 2024
f2c6e31
Ensure that the default position 50% 0 is set when changing/uploading…
ramonjd May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions packages/block-editor/src/components/global-styles/background-panel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,12 +245,22 @@ function BackgroundImageToolsPanelItem( {
return;
}

const sizeValue = style?.background?.backgroundSize;
const positionValue = style?.background?.backgroundPosition;

onChange(
setImmutably( style, [ 'background', 'backgroundImage' ], {
url: media.url,
id: media.id,
source: 'file',
title: media.title || undefined,
setImmutably( style, [ 'background' ], {
...style?.background,
backgroundImage: {
url: media.url,
id: media.id,
source: 'file',
title: media.title || undefined,
},
backgroundPosition:
! positionValue && ( 'auto' === sizeValue || ! sizeValue )
? '50% 0'
: positionValue,
} )
);
};
Expand Down Expand Up @@ -426,13 +436,16 @@ function BackgroundSizeToolsPanelItem( {
const updateBackgroundSize = ( next ) => {
// When switching to 'contain' toggle the repeat off.
let nextRepeat = repeatValue;
let nextPosition = positionValue;

if ( next === 'contain' ) {
nextRepeat = 'no-repeat';
nextPosition = undefined;

@ramonjd ramonjd May 30, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setting to undefined between toggles so that "50% 0" doesn't persist.

This means however, that any user-defined position values are lost as well.

I'm wondering if we should save the value in local state and only reset when a default value is detected, e.g, "50% 0"

@andrewserong andrewserong May 30, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it's fine to reset the position when switching between sizes as you're kind of resetting how the image will appear anyway. Could be a follow-up PR if we think it's needed after all?

}

if ( next === 'cover' ) {
nextRepeat = undefined;
nextPosition = undefined;
}

if (
Expand All @@ -441,6 +454,15 @@ function BackgroundSizeToolsPanelItem( {
next === 'auto'
) {
nextRepeat = undefined;
/*
* A background image uploaded and set in the editor (an image with a record id),
* receives a default background position of '50% 0',
* when the toggle switches to "Tile". This is to increase the chance that
* the image's focus point is visible.
*/
if ( !! style?.background?.backgroundImage?.id ) {
nextPosition = '50% 0';
}
}

/*
Expand All @@ -454,6 +476,7 @@ function BackgroundSizeToolsPanelItem( {
onChange(
setImmutably( style, [ 'background' ], {
...style?.background,
backgroundPosition: nextPosition,
backgroundRepeat: nextRepeat,
backgroundSize: next,
} )
Expand Down Expand Up @@ -545,6 +568,7 @@ function BackgroundSizeToolsPanelItem( {
size="__unstable-large"
__unstableInputWidth="100px"
min={ 0 }
placeholder={ __( 'Auto' ) }
/>
) : null }
{ currentValueForToggle !== 'cover' && (
Expand Down