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

Improve image carousel accessibility #39913

Merged
merged 2 commits into from
Oct 28, 2024
Merged

Improve image carousel accessibility #39913

merged 2 commits into from
Oct 28, 2024

Conversation

dsas
Copy link
Contributor

@dsas dsas commented Oct 25, 2024

Fixes #39908

Proposed changes:

Accessibility has been improved by reducing which images receive a tab index and an aria role of button.

This has been done by moving it out of PHP - where it applied the two attributes to all images in the post, and into javascript where it can be added when applying the interactivity which makes the attributes necessary.

An aria-label has been added for good measure.

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

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

Testing instructions:

GB

  1. Create a post containing:
  • An image block linking to the images attachment page
  • An image block not linking to anywhere
  • An image block linking to itself
  • A tiled gallery
  • A slideshow
  1. View the post, notice that all of the mentioned images have a role=button and a tabIndex=0 regardless of whether they do act as a button
  2. Apply this patch and build
  3. View the post again, notice that only the interactive images - those launching a full-window "lightbox" have a role=button and a tabIndex=0 and additionally, they don't have a warning about not being labelled.

TinyMCE

  1. Install the classic editor plugin
  2. Use the "Add media" button to add images as before, and also a gallery
  3. View the post and as before notice that only the interactive images have aria attributes etc.

dsas added 2 commits October 25, 2024 21:55
Accessibility has been improved by reducing which images receive a tab
index and an aria role of button.

This has been done by moving it out of PHP, where it applied the two
attributes to all images in the post, to setting it in javascript,
alongside where the interactivity is being setup.

An aria-label has been added for good measure.
@dsas dsas requested a review from coder-karen October 25, 2024 21:44
@dsas dsas self-assigned this Oct 25, 2024
Copy link
Contributor

github-actions bot commented Oct 25, 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 improve/carousel-a11y branch.

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

    bin/jetpack-downloader test jetpack improve/carousel-a11y
    

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 [Feature] Carousel A fullscreen modal appearing when clicking on an image in a gallery or tiled gallery. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Oct 25, 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 November 5, 2024 (scheduled code freeze on November 4, 2024).

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

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 25, 2024
Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

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

Thank you for looking at this and for an excellent solution!

The main change I noticed was in images that did not link to anything - with this PR the role of button and tabIndex have been removed, which is now what we want.

I did notice something else - two different issues - but they were also an issue before:

  1. A Tiled Gallery set to link to 'None' still defines a role of button and tabIndex of 0. Both clicking on it and tabbing to it then pressing enter result in no action being taken, which is what I'd assume would be expected. So it looks like they would also need the role and tabIndex removed.
  2. An image set to link to an attachment page opens a lightbox if Carousel is enabled if using keyboard and pressing enter, but opens the attachment page if clicking on it (I'd assume it should open the lightbox). If Carousel is not enabled, both clicking on it and tabbing to it then clicking / entering open the attachment page.

These are both quite specific issues, not related to the report anyway, so I'd be happy to create follow-up issues for these.

@dsas
Copy link
Contributor Author

dsas commented Oct 28, 2024

@coder-karen would rather get this issue landed rather than growing the scope. If you share the links though I will see if I can find some time for those issues too.

@dsas dsas merged commit 71640d2 into trunk Oct 28, 2024
59 checks passed
@dsas dsas deleted the improve/carousel-a11y branch October 28, 2024 10:54
@github-actions github-actions bot added this to the jetpack/14.0 milestone Oct 28, 2024
@github-actions github-actions bot removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Carousel A fullscreen modal appearing when clicking on an image in a gallery or tiled gallery. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
2 participants