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.

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

Tiled Gallery: Ensure container enclosing image is selectable #40779

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Dec 31, 2024

Fixes #40747

Issue and Proposed changes:

  • Due to a change added to the Gutenberg plugin (in v19.9), the icons to move and remove an image within a Tiled Gallery block were not visible, if the Gutenberg plugin is also active on a site (at v19.9 or greater).
  • However, the Tiled Gallery block itself is not built in a way that makes the best sense in terms of interactivity.
  • In this PR, I've implemented a temporary fix: moving the interactive focus from the img elements to the enclosing figure elements, and changing those from figure to div's. This prevents the issue mentioned above, though adding the interactive elements to the enclosing div is also not a perfect solution. I've added the role of button so that it makes more sense from an accessibility POV.
  • As an unrelated small addition, an aria-hidden="true" property has been added to the anchor that encloses the Tiled Gallery img in the editor, as the link isn't meant to be functional there.

For Follow-up:

  • I suggest we revisit the Tiled Gallery block and update the process to move and remove images within the block completely, that also considers using drag and drop for re-ordering. I can create another issue to follow up on that as that may require more discussion.
  • There may also be possible follow ups on the relevant Gutenberg PR as well - Block editor: try direct drag (outside text editable) WordPress/gutenberg#67305 - that could continue to affect the block in some way, so I'll continue to follow that.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

#40747

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

To test the original behavior:

  • On Self-hosted or WoA - ensure the Gutenberg plugin is not installed or active
  • Add a Tiled Gallery block to a post or page, and add multiple images.
  • On saving the post / page, notice that you can select each image, and move them using the movement arrows.
  • You can also delete them using the close icon, and by using the backspace key when the image is selected.

To replicate the issue:

  • On Self-hosted and WoA - ensure the Gutenberg plugin is installed and active (v 19.9 or higher (eg. nightly builds)). On Simple, Gutenberg is active by default.
  • Revisit the same post / page with the Tiled Gallery. Notice the whole block is now selected, and it isn't possible to select individual images.

To test the fix:

  • On self-hosted and WoA - apply this PR using the Jetpack beta plugin (or checkout the PR if testing locally). On Simple, sandbox a Simple site and use the command in the generated comment below.
  • Revisit the same post / page with the Tiled Gallery. You should now be able to select and manipulate each image as before.

Existing issues:

  • If testing on Simple, there is an existing issue when adding a Tiled Gallery block - after clicking save and refreshing the page you'll see block validation errors in the console (the block itself isn't affected). This occurs on trunk as well as with the branch, but noting it here as it is pre-existing. I only noticed this on Simple.

@coder-karen coder-karen self-assigned this Dec 31, 2024
@coder-karen coder-karen added the [Type] Bug When a feature is broken and / or not performing as intended label Dec 31, 2024
Copy link
Contributor

github-actions bot commented Dec 31, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/tiled-gallery-image-controls branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/tiled-gallery-image-controls
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Block] Tiled Gallery [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Dec 31, 2024
Copy link
Contributor

github-actions bot commented Dec 31, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for January 7, 2025 (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@coder-karen coder-karen force-pushed the fix/tiled-gallery-image-controls branch from 96dbbfb to 04d2824 Compare January 3, 2025 14:47
@coder-karen coder-karen marked this pull request as ready for review January 3, 2025 14:52
@coder-karen coder-karen changed the title Tiled Gallery: Ensure figure enclosing image is selectable Tiled Gallery: Ensure container enclosing image is selectable Jan 3, 2025
@coder-karen coder-karen requested a review from a team January 3, 2025 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Tiled Gallery [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Team Review [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tiled Gallery: Missing arrows to rearrange images
1 participant