Problem/Motivation

The Views listing page (admin/structure/views offers a text input to filter Views by name or description. When entering text, the list of views changes dynamically. The change is easily noted visually, but is not conveyed to users with screen readers.

Proposed resolution

Use Drupal.announce() to convey a short message about the number of views now present in the filtered list.

We already do this with the module filter on the admin/modules page - see system.modules.js.

A difference with the Views listing is that there are actually TWO listings on the page: enabled and disabled views. So it may be worth announcing the count for each listing.

Remaining tasks

  • Devise the announcement string(s); e.g. "1 enabled view and 2 disabled views are available in the modified list." It should handle singular/plural result counts correctly (with Drupal.formatPlural())
  • Write a patch.
  • Tests - confirm the updated content of div#drupal-live-announce with JavascriptTestBase.

User interface changes

  • No visible changes intended.
  • Add a screen reader announcement to convey updates which are currently only apparent visually.
  • Introduces a new translatable string for Drupal.announce().

API changes

None expected.

Data model changes

None expected.

CommentFileSizeAuthor
#26 2805499-26-views_list_filter_accessibility_feedback.patch2.04 KBBarisW
#21 2805499-21-views_list_filter_accessibility_feedback.patch2.06 KBemcoward
#16 2805499-16-views_list_filter_accessibility_feedback.patch2.02 KBemcoward
#14 views-list-multiple-drupal-annouce-messages-2805499.png7.84 KBandrewmacpherson
#12 interdiff.2805499.10.11.txt1.06 KBDuaelFr
#12 2805499-11-views_list_filter_accessibility_feedback.patch1.08 KBDuaelFr
#10 2805499-10-views_list_filter_accessibility_feedback.patch676 byteskiwimind
#6 2805499-6-views_list_filter_accessibility_feedback.patch688 bytesEhud
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

andrewmacpherson created an issue. See original summary.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Issue tags: +Dublin2016, +Novice

This would be a good novice task for a mentored sprint at Dublin DrupalCon 2016.

It basically involves a copy/paste, adding a JS behaviour to views module.

We have an accessibility table in the general sprints room but I can come to the mentored room if you need me.

Details of the Drupal.announce() are here:
New accessibility feature: Drupal.announce() (change record)
Accessibility tools for JavaScript in Drupal 8 (handbook page)

criscom’s picture

criscom
Location Graz, Austria
CreditAttribution: criscom at Sunlime Web Innovations GmbH commented

I will take this task over at Drupalcon 2016.

criscom’s picture

criscom
Location Graz, Austria
CreditAttribution: criscom at Sunlime Web Innovations GmbH commented

This will take me longer as expected. I need to catch my flight. If anyone would want to take this over, you are welcome. Thanks.

Ehud’s picture

Ehud CreditAttribution: Ehud commented
Assigned: Unassigned » Ehud

Matthew Lambert (xiwar) and me (Ehud) are taking over. Thanks. On Dublin2016

Ehud’s picture

Ehud CreditAttribution: Ehud commented
Assigned: Ehud » Unassigned
Status: Active » Needs review
FileSize
2805499-6-views_list_filter_accessibility_feedback.patch688 bytes

Patch by Matthew Lambert (xiwar) and Ehud Ovadia (Ehud).

Status: Needs review » Needs work

The last submitted patch, 6: 2805499-6-views_list_filter_accessibility_feedback.patch, failed testing.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford commented
Related issues: +#2124415: Use Drupal.announce to give a screen reader user a succinct summary of how changes to a View's definition affected the preview
mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford commented
Related issues: +#2805197: Provide screen-reader feedback when Views UI filterable options are updated
kiwimind’s picture

kiwimind CreditAttribution: kiwimind at Investis Digital commented
Issue tags: +mssprintjan17
FileSize
2805499-10-views_list_filter_accessibility_feedback.patch676 bytes

Re-rolling patch to fix indentation issues.

emcoward’s picture

emcoward CreditAttribution: emcoward at Investis Digital commented

Testing the patch in #10 with VoiceOver on OSX works in the same way as the module filter and outputs the number of views in the filtered list. As stated in the summary, the announcement also needs to highlight whether the list of views are 'enabled' or 'disabled' which isn't included in the #10 patch.

DuaelFr’s picture

DuaelFr
he/him
Primary language French
Location Montpellier, France
CreditAttribution: DuaelFr as a volunteer and at Happyculture commented
Status: Needs work » Needs review
Issue tags: -aria, -Dublin2016
FileSize
2805499-11-views_list_filter_accessibility_feedback.patch1.08 KB
interdiff.2805499.10.11.txt1.06 KB

As in #2805197-9: Provide screen-reader feedback when Views UI filterable options are updated I think we should keep that function DOM-agnostic so the front can change without breaking these features.
This feature should be tested too but it could be done in a follow-up to avoid locking an accessibility improvement in the pipeline.

Status: Needs review » Needs work

The last submitted patch, 12: 2805499-11-views_list_filter_accessibility_feedback.patch, failed testing.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Issue summary: View changes
Issue tags: -Novice
Related issues: +#2805205: Provide screen-reader feedback when filtering by block name., +#2715663: Use Drupal.formatPlural for when announcing module-filter results for screenreader users
FileSize
views-list-multiple-drupal-annouce-messages-2805499.png7.84 KB

Thanks for working on this everyone.

If you type in the search field quickly enough, it's possible to get a repeated message in the div#drupal-live-annouce. For example, after typing "rec" the div contains the string "1 views are available in the modified list. 4 views are available in the modified list. 3 views are available in the modified list." We noticed the same problem in #2805205: Provide screen-reader feedback when filtering by block name. (comment 14 there). It can be solved by adding some debounce behaviour to limit how often Drupal.announce() is called. This screenshot shows what happens.

Screenshot of drupal.annouce DIV with repeated messages.

As #11 says, the patch doesn't treat the enabled/disabled counts separately. I think that would be a good thing to do; it ties in with the heading structure of the page and provides an extra clue about where to go next.

This can be tested with the new functional JavascriptTestBase class. We already have similar tests being developed for Drupal.announce() which can serve as a starting point. See:

Neither of these have been committed yet, so the test approach isn't set in stone ;-) Any suggestions for improvement would be welcome.

Instructions for running JavascriptTestBase are at Javascript Testing Comes to Drupal 8.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Issue summary: View changes

Another quirk: If there's only one result, the announcement is "1 views are available in the modified list".

Using Drupal.formatPlural() instead of Drupal.t() will fix this.

emcoward’s picture

emcoward CreditAttribution: emcoward at Investis Digital commented
FileSize
2805499-16-views_list_filter_accessibility_feedback.patch2.02 KB

Updated patch from #10 to include separate counts for enabled and disabled views. Also add debounce behaviour as Andrew suggested to prevent repeated messages being output.

emcoward’s picture

emcoward CreditAttribution: emcoward at Investis Digital commented
Status: Needs work » Needs review
Issue tags: +Needs tests

The last submitted patch, 10: 2805499-10-views_list_filter_accessibility_feedback.patch, failed testing.

Status: Needs review » Needs work

The last submitted patch, 16: 2805499-16-views_list_filter_accessibility_feedback.patch, failed testing.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford commented
Issue tags: +SprintWeekend2017a11y, +SprintWeekend2017
emcoward’s picture

emcoward CreditAttribution: emcoward at Investis Digital commented
FileSize
2805499-21-views_list_filter_accessibility_feedback.patch2.06 KB

Updated patch to include drupal.announce as a dependency.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford at OpenConcept Consulting Inc. commented
Status: Needs work » Needs review

Go bot go.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

ok_lyndsey’s picture

ok_lyndsey CreditAttribution: ok_lyndsey as a volunteer commented

Tested this patch in 8.4.x dev used Chrome Vox and NVDA to test screen reader function.

On inputting text to filter a view screen reader it reads: "x enabled views and y disabled views are available in the modified list"

Which is the expected behaviour of patch I believe (compared against vanilla 8.3 and it doesn't say this).

BarisW’s picture

BarisW CreditAttribution: BarisW at LimoenGroen for Historisch Centrum Overijssel commented
Status: Needs review » Needs work 
+++ b/core/modules/views_ui/js/views_ui.listing.js
@@ -38,6 +38,15 @@
+            Drupal.t(
+              $enabledViews + ' and ' + $disabledViews + ' are available in the modified list.'
+            )

This should use placeholders, like '@enabledviews and @disabledviews are available are available in the modified list'

BarisW’s picture

BarisW CreditAttribution: BarisW as a volunteer and at LimoenGroen commented
Status: Needs work » Needs review
FileSize
2805499-26-views_list_filter_accessibility_feedback.patch2.04 KB

This patch uses placeholders in the Drupal.t().

left’s picture

left CreditAttribution: left commented

I can confirm patch #26 works as expected with 8.4x using ChromeVox.
The latest additions to the code by @BarisW result in the same behaviour as reported by @ok_lyndsey in comment #24.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford at OpenConcept Consulting Inc. commented

Ok, so we have the patch tested (essentially) in ChromeVox and NVDA. @BarisW cleaned up @emcoward code.

We then waiting for someone to RTBC it when it goes green?

John Cook’s picture

John Cook CreditAttribution: John Cook commented

I've tested #26 with VoiceOver on Mac.

The announcement returned is correct with regards to singular/plural results.

Although, when typing I occasionally get repeating messages and others I do not get an announcement even when the list visually changes. I believe this due to the debounce.

Also, while typing and there is no changes, the announcement re-states the number of enabled / disabled views. Would having the announcement execute only when the list changes cause any accessibility problems?

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented

The tests are green, but this is still marked "needs tests". Some of the related Drupal.announce() issues already have some tests which are partly written. #2715663: Use Drupal.formatPlural for when announcing module-filter results for screenreader users is a good starting point.

If anyone wants to have a crack at those, make sure you understand how to run FunctionalJavascript tests in D8. See Javascript Testing Comes to Drupal 8.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Status: Needs review » Needs work

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Version: 8.5.x-dev » 8.4.x-dev
Category: Feature request » Bug report
Issue tags: +wcag21
Parent issue: » #2864791: Implement new Success Criteria from WCAG 2.1

Since we're now actively pursuing WCAG 2.1, I'm reclassifying this as a bug report.

It relates to the new WCAG 2.1 "Change of Content" success criterion. Under WCAG 2.0 the announcement was a nice-to-have, but under WCAG 2.1 it becomes a must-have. For a longer explanation, see #2864791-33: Implement new Success Criteria from WCAG 2.1.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Parent issue: #2864791: Implement new Success Criteria from WCAG 2.1 » #3015494: Make admin list filters behave more consistently.
Related issues: +#2864791: Implement new Success Criteria from WCAG 2.1

There's a parent plan about this now.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford at CivicActions commented
Issue tags: -JavaScript +JavaScript, +wcag412

Tagging https://www.w3.org/WAI/WCAG21/Understanding/name-role-value

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.