Make WordPress Core

Opened 7 years ago

Last modified 2 weeks ago

#42002 accepted defect (bug)

Improve the accordions accessibility

Reported by: afercia's profile afercia Owned by: joedolson's profile joedolson
Milestone: 6.6 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-screenshots has-patch needs-testing changes-requested
Focuses: ui, accessibility Cc:

Description

Splitting this out from #37013, props to monikarao, xavortm, mihai2u, Kopepasah for the work done there.

In #37013 was noted that the toggle "arrows" of the accordions in the Menus screen don't have the circular shape to indicate keyboard focus. This is inconsistent with other similar controls that do use the circular focus and could be improved.

https://cldup.com/WXR2bcgPQp.png

However, the accordions in the Menus screen are generated with do_accordion_sections(): plugins or themes might use this function for their own purposes and any change here should be carefully considered and well communicated.

In core, as far as I see, the Menus screen is the only place where do_accordion_sections() is used. In other places, for example the Customizer, the accordions markup is output by a custom implementation. The JS part instead, if I'm not wrong, is still shared and uses accordion.js.

This would be also a good opportunity to improve the accordions accessibility in core and standardize all the different implementations.

I'd recommend to follow the example on the ARIA Authoring Practices, see https://www.w3.org/TR/wai-aria-practices/#accordion and see the example on https://www.w3.org/TR/wai-aria-practices/examples/accordion/accordion.html where the accordion "titles" use a button inside a heading (note: the example uses <dt role="heading" aria-level="3"> because it's an ARIA example :) that's equivalent to a heading).

Attachments (7)

42002.patch (1.3 KB) - added by rishishah 7 years ago.
42002.2.patch (1.3 KB) - added by rishishah 7 years ago.
Here is the proper patch from src.
42002.01.02.24.diff (3.2 KB) - added by kushang78 4 months ago.
Added patch for this ticket.
42002.diff (3.3 KB) - added by kushang78 3 months ago.
Added latest patch for this ticket.
42002.jpg (264.2 KB) - added by rcreators 3 months ago.
I manually copied code from the patch was able to apply it. The tab index issue is solved with tab-index -1 for button. So tabbing works fine now. Yet css needs to be updated, so both left and right side have same appearance in each state
42002.2.diff (3.3 KB) - added by kushang78 8 weeks ago.
Added latest patch for this ticket.
42002.3.diff (3.2 KB) - added by kushang78 8 weeks ago.
Added latest patch for this ticket.

Download all attachments as: .zip

Change History (35)

@rishishah
7 years ago

#1 @rishishah
7 years ago

Hello afercia,

Please review my patch and let me know if anything.

Please see changes here: https://ibb.co/gfniB5

Thanks,

@rishishah
7 years ago

Here is the proper patch from src.

#2 @afercia
7 years ago

@rishishah thanks for the patch! What I meant is a bit more substantial chance though, making the heading contain just a button with some proper text. This would require some more changes. Basically something like:
<h3><button ...>accordion title here<span aria-hidden="true" class="toggle-indicator"></span></button></h3>

The span with icon should go inside the button.

This would match the aria example and allow to remove some of the screen reader text there. Also, it would be nice to remove the word "toggle" sinte it's difficult or impossible to translate in some languages, see #34753

With this changes, also the JS part should be reviewed to ensure it works properly.

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


7 years ago

#4 @afercia
7 years ago

  • Milestone changed from Awaiting Review to Future Release

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


6 years ago

This ticket was mentioned in Slack in #accessibility by rianrietveld. View the logs.


6 years ago

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


5 years ago

#8 @afercia
5 years ago

Note: the new Site Health feature that is going to land in WordPress 5.2 adds some new accordions, see #46573.

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


5 years ago

This ticket was mentioned in Slack in #accessibility by afercia. View the logs.


4 years ago

#11 @joedolson
7 months ago

  • Milestone changed from Future Release to 6.5
  • Owner set to joedolson
  • Status changed from new to accepted

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


7 months ago

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


7 months ago

@kushang78
4 months ago

Added patch for this ticket.

#14 @kushang78
4 months ago

  • Keywords has-patch added

@afercia,

I've worked upon your suggestion as you mentioned above. Here, I've attached the latest patch for that. So, Please check it and drop your feedback on it!

Thanks!

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


3 months ago

#16 @joedolson
3 months ago

  • Keywords needs-testing added

#17 @rcreators
3 months ago

Hello @kushang78,

I checked the patch. There is some tabbing order issue with the accordion. When we change from one item to another with the tab key, there is something hidden area which is getting focused and pressing enter to open/close the accordion as well. Which does not appear to be happening for right-side menu items.

For reference see this video: https://screencast-o-matic.com/watch/cZnO6LVKbhF

Also, the focus border of the icon does not match the right-side menu item. It needs to be the same as well.

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


3 months ago

#19 @joedolson
3 months ago

  • Milestone changed from 6.5 to 6.6

With a week until release candidate, this isn't ready yet. Moving to 6.6 so it has a bit more time.

There are some CSS issues with inconsistent focus design in addition to the tabbing issue that needs addressing.

#20 @joedolson
3 months ago

  • Keywords changes-requested added

@kushang78
3 months ago

Added latest patch for this ticket.

#21 @kushang78
3 months ago

Thanks for the feedback @rcreators @joedolson

I’ve attached the latest patch for this.

Thanks!

#22 @rcreators
3 months ago

@kushang78 This patch failed. Can you check on it? The below lines are error codes.

error: patch failed: src/wp-admin/css/common.css:2357
error: src/wp-admin/css/common.css: patch does not apply
error: patch failed: src/wp-admin/includes/template.php:1574
error: src/wp-admin/includes/template.php: patch does not apply

#23 @kushang78
3 months ago

@rcreators ,

In my case, The patch is working fine without any errors using below 2 methods that I've tried!

  • Using Command, git apply 42002.diff
  • Using Git Patch extension in VS Code

Usually, I'm applying the patch using Git Patch extension in VS Code.

Thanks!

Last edited 3 months ago by kushang78 (previous) (diff)

@rcreators
3 months ago

I manually copied code from the patch was able to apply it. The tab index issue is solved with tab-index -1 for button. So tabbing works fine now. Yet css needs to be updated, so both left and right side have same appearance in each state

@kushang78
8 weeks ago

Added latest patch for this ticket.

@kushang78
8 weeks ago

Added latest patch for this ticket.

#24 @kushang78
8 weeks ago

Please consider 42002.3.diff file as latest patch. Thanks!

This ticket was mentioned in Slack in #accessibility by rcreators. View the logs.


7 weeks ago

#26 @devsahadat
6 weeks ago

@kushang78 I just checked it and it's working fine. Thanks

This ticket was mentioned in Slack in #accessibility by rcreators. View the logs.


2 weeks ago

#28 @joedolson
2 weeks ago

Let's move the event trigger from .accordion-section-title to the button; that will allows us to remove the extraneous tabindex attributes, and will make the keyboard handling more standard.

It should also allow us to remove the keydown event handler from accordion.js, since the button will pass events natively.

Be sure to also check accordions in the Customizer and in the Site Health UI to make sure everything is consistent across those features.

Note: See TracTickets for help on using tickets.