Skip to content
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

Add align support to the image block #55346

Closed
wants to merge 7 commits into from
Closed

Add align support to the image block #55346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3eafa16
only remove the alignment control
draganescu Nov 2, 2023
3a5aaac
use an effect to reset width, height, aspect ratio and cover when ali…
draganescu Nov 2, 2023
d88c9c3
try a filter on block attributes when align control updates attributes
draganescu Nov 2, 2023
19c37f2
new fixtures for the default align attribute of core/image
draganescu Nov 6, 2023
ba39269
updated snapshots
draganescu Nov 6, 2023
184dde9
modify the filter to always return the same shape of object, update n…
draganescu Nov 7, 2023
c65c738
update the react native component
draganescu Nov 8, 2023
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
2 changes: 1 addition & 1 deletion docs/reference-guides/core-blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ Insert an image to make a visual statement. ([Source](https://github.com/WordPre

- **Name:** core/image
- **Category:** media
- **Supports:** anchor, color (~~background~~, ~~text~~), filter (duotone)
- **Supports:** align (center, full, left, right, wide), anchor, color (~~background~~, ~~text~~), filter (duotone)
- **Attributes:** align, alt, aspectRatio, caption, height, href, id, lightbox, linkClass, linkDestination, linkTarget, rel, scale, sizeSlug, title, url, width

## Latest Comments
Expand Down
15 changes: 13 additions & 2 deletions packages/block-editor/src/hooks/align.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import classnames from 'classnames';
* WordPress dependencies
*/
import { createHigherOrderComponent } from '@wordpress/compose';
import { addFilter } from '@wordpress/hooks';
import { addFilter, applyFilters } from '@wordpress/hooks';
import {
getBlockSupport,
getBlockType,
Expand Down Expand Up @@ -138,7 +138,18 @@ function BlockEditAlignmentToolbarControls( {
nextAlign = '';
}
}
setAttributes( { align: nextAlign } );
/**
* This filter exists so that the image block can reset
* its aspect ratio and custom size when the alignment is set
* to either wide or full.
*/
const filteredAttributes = applyFilters(
'block-library.image.alignmentUpdate',
draganescu marked this conversation as resolved.
Show resolved Hide resolved
blockName,
{ ...attributes, align: nextAlign }
Copy link
Contributor

@talldan talldan Nov 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Looking at the way the UPDATE_BLOCK_ATTRIBUTES reducer works, I think it might be best to keep the object here restricted to only the attributes that are being modified rather than all attributes.

Passing all causes an unnecessary performance hit, as the code loops through the attributes one by one.

Could still provide all attributes as a separate param as it was before, so that the filter function can make decisions based on the values.

);

setAttributes( filteredAttributes );
};

return (
Expand Down
20 changes: 10 additions & 10 deletions packages/block-library/src/embed/test/__snapshots__/index.native.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Embed block alignment options sets Align center option 1`] = `
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true,"align":"center"} -->
<figure class="wp-block-embed aligncenter is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true} -->
<figure class="wp-block-embed is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
https://twitter.com/notnownikki
</div></figure>
<!-- /wp:embed -->"
`;

exports[`Embed block alignment options sets Align left option 1`] = `
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true,"align":"left"} -->
<figure class="wp-block-embed alignleft is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true} -->
<figure class="wp-block-embed is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
https://twitter.com/notnownikki
</div></figure>
<!-- /wp:embed -->"
`;

exports[`Embed block alignment options sets Align right option 1`] = `
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true,"align":"right"} -->
<figure class="wp-block-embed alignright is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true} -->
<figure class="wp-block-embed is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
https://twitter.com/notnownikki
</div></figure>
<!-- /wp:embed -->"
`;

exports[`Embed block alignment options sets Full width option 1`] = `
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true,"align":"full"} -->
<figure class="wp-block-embed alignfull is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true} -->
<figure class="wp-block-embed is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
https://twitter.com/notnownikki
</div></figure>
<!-- /wp:embed -->"
`;

exports[`Embed block alignment options sets Wide width option 1`] = `
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true,"align":"wide"} -->
<figure class="wp-block-embed alignwide is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
"<!-- wp:embed {"url":"https://twitter.com/notnownikki","type":"rich","providerNameSlug":"twitter","responsive":true} -->
<figure class="wp-block-embed is-type-rich is-provider-twitter wp-block-embed-twitter"><div class="wp-block-embed__wrapper">
https://twitter.com/notnownikki
</div></figure>
<!-- /wp:embed -->"
Expand Down
4 changes: 3 additions & 1 deletion packages/block-library/src/image/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"textdomain": "default",
"attributes": {
"align": {
"type": "string"
"type": "string",
"default": ""
},
"url": {
"type": "string",
Expand Down Expand Up @@ -95,6 +96,7 @@
}
},
"supports": {
"align": [ "left", "center", "right", "wide", "full" ],
"anchor": true,
"color": {
"text": false,
Expand Down
21 changes: 0 additions & 21 deletions packages/block-library/src/image/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ import { getBlobByURL, isBlobURL, revokeBlobURL } from '@wordpress/blob';
import { Placeholder } from '@wordpress/components';
import { useDispatch, useSelect } from '@wordpress/data';
import {
BlockAlignmentControl,
BlockControls,
BlockIcon,
MediaPlaceholder,
useBlockProps,
Expand Down Expand Up @@ -106,7 +104,6 @@ export function ImageEdit( {
url = '',
alt,
caption,
align,
id,
width,
height,
Expand Down Expand Up @@ -255,16 +252,6 @@ export function ImageEdit( {
}
}

function updateAlignment( nextAlign ) {
const extraUpdatedAttributes = [ 'wide', 'full' ].includes( nextAlign )
? { width: undefined, height: undefined }
: {};
setAttributes( {
...extraUpdatedAttributes,
align: nextAlign,
} );
}

let isTemp = isTemporaryImage( id, url );

// Upload a temporary image on mount.
Expand Down Expand Up @@ -375,14 +362,6 @@ export function ImageEdit( {
clientId={ clientId }
blockEditingMode={ blockEditingMode }
/>
{ ! url && blockEditingMode === 'default' && (
<BlockControls group="block">
<BlockAlignmentControl
value={ align }
onChange={ updateAlignment }
/>
</BlockControls>
) }
<MediaPlaceholder
icon={ <BlockIcon icon={ icon } /> }
onSelect={ onSelectImage }
Expand Down
18 changes: 0 additions & 18 deletions packages/block-library/src/image/edit.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ import {
MEDIA_TYPE_IMAGE,
BlockControls,
InspectorControls,
BlockAlignmentToolbar,
BlockStyles,
store as blockEditorStore,
blockSettingsScreens,
Expand Down Expand Up @@ -212,7 +211,6 @@ export class ImageEdit extends Component {
this.onSetFeatured = this.onSetFeatured.bind( this );
this.onFocusCaption = this.onFocusCaption.bind( this );
this.onSelectURL = this.onSelectURL.bind( this );
this.updateAlignment = this.updateAlignment.bind( this );
this.accessibilityLabelCreator =
this.accessibilityLabelCreator.bind( this );
this.setMappedAttributes = this.setMappedAttributes.bind( this );
Expand Down Expand Up @@ -391,18 +389,6 @@ export class ImageEdit extends Component {
} );
}

updateAlignment( nextAlign ) {
const extraUpdatedAttributes = Object.values(
WIDE_ALIGNMENTS.alignments
).includes( nextAlign )
? { width: undefined, height: undefined }
: {};
this.props.setAttributes( {
...extraUpdatedAttributes,
align: nextAlign,
} );
}

onSetNewTab( value ) {
const updatedLinkTarget = getUpdatedLinkTargetSettings(
value,
Expand Down Expand Up @@ -711,10 +697,6 @@ export class ImageEdit extends Component {
onClick={ open }
/>
</ToolbarGroup>
<BlockAlignmentToolbar
value={ align }
onChange={ this.updateAlignment }
/>
</BlockControls>
);

Expand Down
22 changes: 0 additions & 22 deletions packages/block-library/src/image/image.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import {
MediaReplaceFlow,
store as blockEditorStore,
useSettings,
BlockAlignmentControl,
__experimentalImageEditor as ImageEditor,
__experimentalGetElementClassName,
__experimentalUseBorderProps as useBorderProps,
Expand Down Expand Up @@ -333,21 +332,6 @@ export default function Image( {
} );
}

function updateAlignment( nextAlign ) {
const extraUpdatedAttributes = [ 'wide', 'full' ].includes( nextAlign )
? {
width: undefined,
height: undefined,
aspectRatio: undefined,
scale: undefined,
}
: {};
Comment on lines -337 to -344
Copy link
Contributor

@talldan talldan Nov 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

As @fabiankaegy mentioned, resetting these values seems to be the one custom thing the image block did when changing alignments, and it should probably be retained.

An effect would be one way to handle it, the downside being modifying alignment and resetting the size become two separate changes on the undo stack.

Quietly whispered: Filtering alignment attribute changes could also work to avoid the undo issue.

Not sure if there are any other options, would be good to hear some ideas.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The "Quietly whispered" means maybe adding a new filter to where alignment is updated by the block support?

Copy link
Member

Choose a reason for hiding this comment

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

Would it work to still handle it in an effect but using the markNextChangeAsNonPersistent method to not create anything in the undo stack for the change?

Not sure whether the change would properly get reverted when someone does go back one step at that point. I just know we have something for that

setAttributes( {
...extraUpdatedAttributes,
align: nextAlign,
} );
}

useEffect( () => {
if ( ! isSelected ) {
setIsEditingImage( false );
Expand Down Expand Up @@ -435,12 +419,6 @@ export default function Image( {
const controls = (
<>
<BlockControls group="block">
{ hasNonContentControls && (
<BlockAlignmentControl
value={ align }
onChange={ updateAlignment }
/>
) }
{ hasNonContentControls && (
<ToolbarButton
onClick={ () => {
Expand Down
26 changes: 25 additions & 1 deletion packages/block-library/src/image/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import edit from './edit';
import metadata from './block.json';
import save from './save';
import transforms from './transforms';
import { addFilter } from '@wordpress/hooks';

const { name } = metadata;

Expand Down Expand Up @@ -56,4 +57,27 @@ export const settings = {
deprecated,
};

export const init = () => initBlock( { name, metadata, settings } );
export const init = () => {
addFilter(
'block-library.image.alignmentUpdate',
'core/block-library/filters',
( blockName, updatedAttributes ) => {
if ( blockName !== 'core/image' ) {
return updatedAttributes;
}
if ( [ 'wide', 'full' ].includes( updatedAttributes.align ) ) {
return {
...updatedAttributes,
...{
width: undefined,
height: undefined,
aspectRatio: undefined,
scale: undefined,
},
};
}
return updatedAttributes;
}
);
initBlock( { name, metadata, settings } );
};
4 changes: 2 additions & 2 deletions packages/block-library/src/image/test/__snapshots__/transforms.native.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ exports[`Image block transformations to Columns block 1`] = `
`;

exports[`Image block transformations to Cover block 1`] = `
"<!-- wp:cover {"url":"https://cldup.com/cXyG__fTLN.jpg","id":1,"dimRatio":50,"style":{"color":{}}} -->
"<!-- wp:cover {"url":"https://cldup.com/cXyG__fTLN.jpg","id":1,"dimRatio":50,"align":"","style":{"color":{}}} -->
<div class="wp-block-cover"><span aria-hidden="true" class="wp-block-cover__background has-background-dim"></span><img class="wp-block-cover__image-background wp-image-1" alt="" src="https://cldup.com/cXyG__fTLN.jpg" data-object-fit="cover"/><div class="wp-block-cover__inner-container"><!-- wp:paragraph {"align":"center","fontSize":"large"} -->
<p class="has-text-align-center has-large-font-size">Mountain</p>
<!-- /wp:paragraph --></div></div>
Expand All @@ -25,7 +25,7 @@ exports[`Image block transformations to File block 1`] = `
`;

exports[`Image block transformations to Gallery block 1`] = `
"<!-- wp:gallery {"linkTo":"none"} -->
"<!-- wp:gallery {"linkTo":"none","align":""} -->
<figure class="wp-block-gallery has-nested-images columns-default is-cropped"><!-- wp:image {"id":1,"sizeSlug":"large","linkDestination":"media","className":"is-style-default"} -->
<figure class="wp-block-image size-large is-style-default"><a href="https://cldup.com/cXyG__fTLN.jpg"><img src="https://cldup.com/cXyG__fTLN.jpg" alt="" class="wp-image-1"/></a><figcaption class="wp-element-caption">Mountain</figcaption></figure>
<!-- /wp:image --></figure>
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/blocks/core__gallery-with-caption.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "https://sergioestevaofolio.files.wordpress.com/2016/09/cropped-img_9054-1.jpg?w=190",
"alt": "Image gallery image",
"caption": "",
Expand All @@ -32,6 +33,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "https://sergioestevaofolio.files.wordpress.com/2017/09/cropped-l1001498-1.jpg?w=580",
"alt": "Image gallery image",
"caption": "",
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/blocks/core__gallery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "https://sergioestevaofolio.files.wordpress.com/2016/09/cropped-img_9054-1.jpg?w=190",
"alt": "Image gallery image",
"caption": "",
Expand All @@ -32,6 +33,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "https://sergioestevaofolio.files.wordpress.com/2017/09/cropped-l1001498-1.jpg?w=580",
"alt": "Image gallery image",
"caption": "",
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/blocks/core__gallery__columns.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "https://sergioestevaofolio.files.wordpress.com/2016/09/cropped-img_9054-1.jpg?w=190",
"alt": "Image gallery image",
"caption": "",
Expand All @@ -32,6 +33,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "https://sergioestevaofolio.files.wordpress.com/2017/09/cropped-l1001498-1.jpg?w=580",
"alt": "Image gallery image",
"caption": "",
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/blocks/core__gallery__deprecated-1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQABDQottAAAAABJRU5ErkJggg==",
"alt": "title",
"linkDestination": "none"
Expand All @@ -24,6 +25,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "data:image/jpeg;base64,/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=",
"alt": "title",
"linkDestination": "none"
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/blocks/core__gallery__deprecated-2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQABDQottAAAAABJRU5ErkJggg==",
"alt": "title",
"caption": "",
Expand All @@ -26,6 +27,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "data:image/jpeg;base64,/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=",
"alt": "title",
"caption": "",
Expand Down
2 changes: 2 additions & 0 deletions test/integration/fixtures/blocks/core__gallery__deprecated-3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQABDQottAAAAABJRU5ErkJggg==",
"alt": "title",
"caption": "",
Expand All @@ -24,6 +25,7 @@
"name": "core/image",
"isValid": true,
"attributes": {
"align": "",
"url": "data:image/jpeg;base64,/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k=",
"alt": "title",
"caption": "",
Expand Down
Loading
Loading