Skip to content

Conversation

@igorschoester
Copy link
Contributor

Context

With Gutenberg 17.3 (PR WordPress/gutenberg#56635) all the button icons are now displayed as "compact", which makes the width 32px (from 36px). Resulting in no space around the icon (horizontally).
This change removes the icon size override when in compact mode. Effectively reverting the icon size back to be 24px. Leaving the same horizontal space as the WP icons.

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where the Yoast plugin icon in the block editor would not have any horizontal spacing anymore when rendered in "compact" mode.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Edit a post in the block editor
  • Verify the Yoast plugin icon in the sidebar looks normal:
    image
    • Button width of 36px and icon width of 28px
  • Activate the Gutenberg plugin v17.4.1 (or higher?)
  • Edit a post in the block editor
  • Verify the Yoast plugin in the sidebar still has horizontal spacing:
    image
    • Button width of 32px and icon width of 24px (same as the WP icon next to it)

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Block/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • Our Yoast plugin icon in the sidebar of the block editor

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

With Gutenberg 17.3 (PR WordPress/gutenberg#56635) all the button icons are now displayed as "compact", which makes the width 32px (from 36px). Resulting in no space around the icon (horizontally).
This change removes the icon size override when in compact mode. Effectively reverting the icon size back to be 24px. Leaving the same horizontal space as the WP icons.
@igorschoester igorschoester added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Jan 8, 2024
Copy link
Member

@pls78 pls78 left a comment

Choose a reason for hiding this comment

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

CR && Acc: ✅

@pls78 pls78 added this to the 21.9 milestone Jan 8, 2024
@pls78 pls78 merged commit 464642b into trunk Jan 8, 2024
@pls78 pls78 deleted the update-plugin-icon-for-compact-block-editor branch January 8, 2024 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants