[a11y] Make CommandPalette announce selected item #13519

carlos-zamora · 2022-07-16T00:29:18Z

Summary of the Pull Request

The command palette (and tab search by extension) doesn't ever tell screen readers what is selected. Here, we simply hook up the selection changed event to a function that tells the screen reader what is selected. With this, the user no longer has to tab into the list view to know what is selected!

Will resolve the following bug upon validation from a11y team: #12065

Validation Steps Performed

Performed repro steps from #12065.

NOTE: we do NOT read the selected item when the command palette is first opened. I think that's ok.

DHowett · 2022-07-18T18:03:40Z

I'm a little concerned. How did we regress this? It was working, and I thought that a list view was supposed to automatically handle accessibility notifications when its selected item changed. Is that not true? Has this never worked?

Mini-RCA?

carlos-zamora · 2022-07-18T18:30:11Z

I'm a little concerned. How did we regress this? It was working, and I thought that a list view was supposed to automatically handle accessibility notifications when its selected item changed. Is that not true? Has this never worked?

Mini-RCA?

Nah, this isn't a regression. It's just slightly different. The implementation we had was that we added AutomationProperties to the ListViewItem and that worked (and continues to work) correctly. A screen reader can point to the item and extract the text from it.

The difference here is when that information gets extracted. The AutomationProperties made it so that you had to tab to the item to get the name/keys. So the workflow would look like this:

open cmd palette
tab to list of results
use up/down to move focus/selection to the desired item

But the command palette has an additional way to change the selection without moving the focus:

open cmd palette
use up/down to move selection to the desired item (but maintain focus in text box)

This PR enables support for that second scenario.

NOTE: since the experience is still accessible, the bug is marked as a Sev3 as opposed to a higher one.

DHowett · 2022-07-26T18:19:44Z

I don't know how I feel about this. Are we certain that the content that Narrator reads is identical to the one when you select a list item? What about "drilling in" for details -- can you get Narrator to read the Name and the Key Binding separately? What happens today in keyboard focus if you do that? What about this new thing?

DHowett · 2022-07-26T18:20:30Z

Is there a better way to do this than say "narrator speak these words?" Is it possible to say, "narrator, speak this control"?

DHowett

Red for questions

carlos-zamora · 2022-07-27T00:11:46Z

I don't know how I feel about this. Are we certain that the content that Narrator reads is identical to the one when you select a list item?

Tested with Narrator/NVDA/JAWS: identical behavior to when you move focus onto a list item

What about "drilling in" for details -- can you get Narrator to read the Name and the Key Binding separately? What happens today in keyboard focus if you do that? What about this new thing?

After a bit of digging, I can't figure out a way to do this with Narrator or NVDA. I reached out to Bill and he said that NVDA just reads accelerator keys automatically; there's no way to do it on request, but he could write up a plug-in for it. It seems to be a common standard to just read the accelerator keys.

Is there a better way to do this than say "narrator speak these words?" Is it possible to say, "narrator, speak this control"?

Hmm... I don't think there's a way to just hand over the control to Narrator. I don't think that's necessarily desired either though? The user has the ability to tab to the selected item then "drill in" if so desired. This notification is more intended to let the user know what the "enter" button will do if it's invoked.

codeofdusk · 2022-08-16T11:37:54Z

I reached out to Bill and he said that NVDA just reads accelerator keys automatically; there's no way to do it on request

There is now, see PR nvaccess/nvda#13960 (available from 2022.4).

DHowett · 2022-08-25T18:55:35Z

src/cascadia/TerminalApp/CommandPalette.cpp

+                    {
+                        if (const auto paletteItem = filteredCmd.Item().try_as<TerminalApp::PaletteItem>())
+                        {
+                            automationPeer.RaiseNotificationEvent(


okay, here's another annoying question!

How do we tell the user that the command they selected has nested commands? What is the audible version of the > symbol?

Ah, you've stumbled upon #12041 haha.

The short version is that we have help text saying "More options", but depending on the screen reader, that may or may not be read automatically. Rahul seems to have commented on the thread with a way to fix the issue, so that's nice.

DHowett

This is an improvement for now!

carlos-zamora · 2022-08-26T00:01:05Z

@msftbot merge this in 10 minutes

ghost · 2022-08-26T00:01:15Z

Hello @carlos-zamora!

Because you've given me some instructions on how to help merge this pull request, I'll be modifying my merge approach. Here's how I understand your requirements for merging this pull request:

I won't merge this pull request until after the UTC date Fri, 26 Aug 2022 00:11:14 GMT, which is in 10 minutes

If this doesn't seem right to you, you can tell me to cancel these instructions and use the auto-merge policy that has been configured for this repository. Try telling me "forget everything I just told you".

## Summary of the Pull Request The command palette (and tab search by extension) doesn't ever tell screen readers what is selected. Here, we simply hook up the selection changed event to a function that tells the screen reader what is selected. With this, the user no longer has to tab into the list view to know what is selected! Will resolve the following bug upon validation from a11y team: #12065 ## Validation Steps Performed Performed repro steps from #12065. NOTE: we do NOT read the selected item when the command palette is first opened. I think that's ok. (cherry picked from commit deb5e7c) Service-Card-Id: 85254984 Service-Version: 1.15

ghost · 2022-09-13T17:02:26Z

🎉Windows Terminal v1.15.252 has been released which incorporates this pull request.:tada:

Handy links:

ghost · 2022-09-13T17:04:01Z

🎉Windows Terminal Preview v1.16.252 has been released which incorporates this pull request.:tada:

Handy links:

ghost added Area-Accessibility Issues related to accessibility Issue-Bug It either shouldn't be doing this or needs an investigation. Priority-3 A description (P3) Product-Terminal The new Windows Terminal. labels Jul 16, 2022

[a11y] Make CommandPalette announce selected item

3a5ffdf

carlos-zamora force-pushed the dev/cazamor/a11y-sev3/12065 branch from d5d1e88 to 3a5ffdf Compare July 16, 2022 00:31

zadjii-msft approved these changes Jul 26, 2022

View reviewed changes

DHowett requested changes Jul 26, 2022

View reviewed changes

carlos-zamora assigned DHowett Jul 27, 2022

DHowett added a commit that referenced this pull request Jul 29, 2022

PRE-MERGE #13519 [a11y] Make CommandPalette announce selected item

cf25b4c

zadjii-msft added this to the Terminal v1.17 milestone Aug 1, 2022

DHowett reviewed Aug 25, 2022

View reviewed changes

DHowett approved these changes Aug 25, 2022

View reviewed changes

carlos-zamora unassigned DHowett Aug 26, 2022

ghost added the AutoMerge Marked for automatic merge by the bot when requirements are met label Aug 26, 2022

ghost merged commit deb5e7c into main Aug 26, 2022

ghost deleted the dev/cazamor/a11y-sev3/12065 branch August 26, 2022 00:11

carlos-zamora mentioned this pull request Oct 6, 2022

[Terminal> Command palette]: Screen Reader is not announcing Suggestion name when user navigate to Command Palette suggestions using up/down arrow keys. #12065

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[a11y] Make CommandPalette announce selected item #13519

[a11y] Make CommandPalette announce selected item #13519

carlos-zamora commented Jul 16, 2022 •

edited

Loading

DHowett commented Jul 18, 2022

carlos-zamora commented Jul 18, 2022

DHowett commented Jul 26, 2022

DHowett commented Jul 26, 2022

DHowett left a comment

carlos-zamora commented Jul 27, 2022

codeofdusk commented Aug 16, 2022

DHowett Aug 25, 2022

carlos-zamora Aug 26, 2022

DHowett left a comment

carlos-zamora commented Aug 26, 2022

ghost commented Aug 26, 2022

ghost commented Sep 13, 2022

ghost commented Sep 13, 2022

[a11y] Make CommandPalette announce selected item #13519

[a11y] Make CommandPalette announce selected item #13519

Conversation

carlos-zamora commented Jul 16, 2022 • edited Loading

Summary of the Pull Request

Validation Steps Performed

DHowett commented Jul 18, 2022

carlos-zamora commented Jul 18, 2022

DHowett commented Jul 26, 2022

DHowett commented Jul 26, 2022

DHowett left a comment

Choose a reason for hiding this comment

carlos-zamora commented Jul 27, 2022

codeofdusk commented Aug 16, 2022

DHowett Aug 25, 2022

Choose a reason for hiding this comment

carlos-zamora Aug 26, 2022

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

carlos-zamora commented Aug 26, 2022

ghost commented Aug 26, 2022

ghost commented Sep 13, 2022

ghost commented Sep 13, 2022

carlos-zamora commented Jul 16, 2022 •

edited

Loading