Add sizeSlug to the image inserted from Inserter. #60138
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
torounit
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @burnuser. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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: +226 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
t-hamano
reviewed
Mar 25, 2024
There was a problem hiding this comment.
Thanks for the PR!
To ideally solve this problem, I think it is necessary to match the behavior when media is inserted via the Image block. In other words, I think we need to consider the following points.
- A newly inserted image may not always be at full size. We need to consider the value of the
imageDefaultSizeoption (See). - If an image is inserted via a URL, it should always apply the size slug defined by the
imageDefaultSizeoption (See).
The approach I think is to pass this option as the third parameter to the getBlockAndPreviewFromMedia() function and derive the appropriate size slug inside the function. It would probably be written like this:
const { getSettings } = useSelect( blockEditorStore );
const { imageDefaultSize } = getSettings();
const [ block, preview ] = useMemo(
() => getBlockAndPreviewFromMedia( media, category.mediaType, imageDefaultSize ),
[ media, category.mediaType, imageDefaultSize ]
);
|
I added @ntsekouras, who implemented the media tab, as a reviewer 🙏 |
|
Thanks for the PR @torounit ! I agree with @t-hamano that we should match the image block behavior and in order to do that we need to handle Noting though that when the source is external and we select a media item, we try to upload it and only when the upload is done, we can check available sizes and set it properly(around here). We would also need some checks about the media type there too, even though in core we don't have other external sources of other media types(ex audio, video). |
torounit
force-pushed
the
fix/add-size-slug-for-image-form-inserter
branch
from
055b3db
to
b7b20e1
Compare
|
@t-hamano @ntsekouras |
ntsekouras
reviewed
Apr 19, 2024
| export function getBlockAndPreviewFromMedia( | ||
| media, | ||
| mediaType, | ||
| sizeSlug = 'full' |
There was a problem hiding this comment.
I think we shouldn't check the sizeSlug in the preview as its better to have the smaller one for performance. It also keeps things simpler without an extra param that's specific to a single media type.
There was a problem hiding this comment.
Agreed. The sizeSlug attribute value isn't important for previews.
| @@ -121,9 +121,16 @@ export function MediaPreview( { media, onClick, category } ) { | |||
| useState( false ); | |||
| const [ isHovered, setIsHovered ] = useState( false ); | |||
| const [ isInserting, setIsInserting ] = useState( false ); | |||
| const { getSettings } = useSelect( blockEditorStore ); | |||
There was a problem hiding this comment.
It's good that you extract the selector like this, because we'll call it in a callback function. We could extract the size value from setting though only if we need it, which is when the media category is 'image'.
| }, | ||
| } ); | ||
|
|
||
| if ( |
There was a problem hiding this comment.
The check would be better with category.mediaType === 'image' and we could simplify by including the extra attributes in an object and then have only one onClick.
Something like that:
const extraAttributes = {
id: img.id,
url: img.url,
};
if (type === image) {
extraAttributes.sizeSlug = ....
}
onClick( {
...clonedBlock,
attributes: {
...clonedBlock.attributes,
...extraAttributes
},
} )
Additionally and not related to this PR, we'll need to check how this behaves for other media types besides 'image'. It will most definitely need changes, for example the messages and adding the src attribute instead of the url. This happened because for a while this API wasn't public and we only had Openverse(images).
| onClick( { | ||
| ...clonedBlock, | ||
| attributes: { | ||
| ...clonedBlock.attributes, |
There was a problem hiding this comment.
Same handling (check media category and add size) should be done above, since I suggested to not set the size in the preview.
The only difference is that we will only need to add the sizeSlug attribute.
Mamaduka
reviewed
Apr 23, 2024
| @@ -121,9 +121,16 @@ export function MediaPreview( { media, onClick, category } ) { | |||
| useState( false ); | |||
| const [ isHovered, setIsHovered ] = useState( false ); | |||
| const [ isInserting, setIsInserting ] = useState( false ); | |||
| const { getSettings } = useSelect( blockEditorStore ); | |||
| const { imageDefaultSize } = getSettings(); | |||
There was a problem hiding this comment.
We shouldn't call the selector during the render. The actual setting value is only needed in the onMediaInsert callback. The sizeSlug does nothing for remote images.
P.S. I've got a small PR that improves the onMediaInsert callback and uses the same technique for the mediaUpload setting - #60983.
Mamaduka
reviewed
Apr 23, 2024
| @@ -39,15 +41,21 @@ function MediaTab( { | |||
| const mediaCategories = useMediaCategories( rootClientId ); | |||
| const isMobile = useViewportMatch( 'medium', '<' ); | |||
| const baseCssClass = 'block-editor-inserter__media-tabs'; | |||
| const { getSettings } = useSelect( blockEditorStore ); | |||
| const { imageDefaultSize } = getSettings(); | |||
There was a problem hiding this comment.
Same here. Let's move the selector call inside the onSelectMedia.
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?
The image inserted from the block inserter is full size, so add
"sizeSlug": "full"to the image block to be created.Why?
fix: #55027
How?
Add sizeSlug to the attributes of the block created by
getBlockAndPreviewFromMedia.Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
2024-03-23.5.17.15.mov