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: Accessibility - when images are not interactive, remove button role and tabindex. #40241

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 Nov 19, 2024

Fixes #39925

Proposed changes:

  • This PR removes the button role and the tabindex that is added to Tiled Gallery images to help them be accessible (originally added here), but only in one scenario: when Carousel is disabled, and 'linkTo' is set to none.
  • One option was to remove the tabindex and role conditionally from the relevant save.js file, but to prevent needing additional deprecation files as well as this only being a conditional change I opted to make this change when rendering the block via PHP.

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

#39925

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

No.

Testing instructions:

Replicating the issue:

  1. On a test site (WoA / self-hosted), ensure the full-screen Carousel option is disabled under Jetpack > Settings > Writing: /wp-admin/admin.php?page=jetpack#/writing
  2. Create a new post and add a Tiled Gallery block.
  3. Ensure 'None' is set for the 'Link to' option in the sidebar:
  1. Save and preview
  2. If you inspect the image source for one of the Tiled Gallery images, you'll see a tabIndex of 0, and role of button:

Image

  1. Click on any of the images - you'll see the image highlighted but no action taken
  2. Similarly, tab onto one of the images and press enter. You'll see the image highlighted, but no action taken.
  3. For all other options - images set to link to attachment type or media page, as well as Carousel enabled, you should be able to click on the image using a mouse and by tabbing and entering.
  4. Changing between options and disabling / enabling Carousel should not result in any broken Tiled Gallery blocks.

Testing the fix

  1. Repeat the above steps - step 8 should work as before, but for the testing steps where Carousel is disabled and the images set to link to 'none', you should not be able to tab onto the gallery images (nor see a role of button nor tabindex showing in the inspector for those specific gallery images).
  2. Additionally, if you had a previously added Tiled Gallery, there should be no broken block messaging.

Simple testing

  • Testing is not quite as easy on Simple - on trunk itself you may see a block validation error in the console upon adding a TG, saving, and refreshing the editor. However we can confirm the changes on the front-end, and that there is no visible broken TG in the editor itself with the changes (after applying the fix using the command in the generated comment below).
    • In Simple, the role="button" is what should be removed on the front-end when Carousel is disabled.
  • On a Simple site, you can enable and disable Carousel from Settings > Media: /wp-admin/options-media.php

Copy link
Contributor

github-actions bot commented Nov 19, 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-link-none-accessibility branch.

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

    bin/jetpack-downloader test jetpack fix/tiled-gallery-link-none-accessibility
    

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 Nov 19, 2024
Copy link
Contributor

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 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 none scheduled (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 marked this pull request as ready for review November 19, 2024 13:14
@coder-karen coder-karen requested a review from a team November 19, 2024 13:34
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tiled Gallery: Accessibility - when set to link to 'None', remove button role, and tabIndex of 0
1 participant