Add tooltips to the Suggestions Control

[zadjii-msft]

targets #14938

These are currently powered by the "ToolTip" element in the completion protocol. This also adds room for "description"s in any action. This will be more relevant for Tasks, in #1595.

By all accounts, this could have been in the parent commit. I broke it apart for the ease of reviewing.

• Related to Enhance shell autocompletion with a cool new user interface and shell completion protocol #3121
• Doesn't close anything by itself

[zadjii-msft]

[carlos-zamora]

Accessibility is gonna be rough here. You should test it out, but I assume TeachingTips aren't read out by screen readers. What you could do though, is apply that text to the AutomationProperties.FullDescription property. That way, the user can specifically request more info whenever they want it. That info shouldn't be read out automatically by the screen reader either. Only on request.

[carlos-zamora]

Is "Subtitle" necessary? Why?

[carlos-zamora]

Same with Title?

Also, looks like the WinUI docs don't say the default value (grr). So, mind checking each of these to make sure they're necessary?

[zadjii-msft]

I assume TeachingTips aren't read out by screen readers

gods I forgot they aren't. WHY ARENT THEY.

Also, Narrator and the Command Palette are already weird. Like, navigating the cmdpal with narrator never moves the selected item. It moves focus, but not the selected item.

So of course, for the tooltips, they too do not get updated with narrator open. Frick.

[zadjii-msft]

Notes:

• F6 to focus the TeachingTip doesn't work. It doesn't work because the SuggestionsControl::_lostFocusHandler fires, we don't find the tip as a child of the sxnui (it's a popup). We dismiss ourselves immediately.
  • Same with clicking on it.
  • This can be fixed by looking to see if the focused thing is a child of the
• Closing the TeachingTip doesn't focus the sxnui again. The sxnui has lost focus (it lost focus to the popup), and the popup gave it to the TermControl, and now there's no way to dismiss the sxnui.
  • fixable. Toss focus manually.
• OS dark theme, app in light theme? That's right, the Title of the TeachingTip will be white. Fucking themeing lambda again.
• Change the app theme at runtime? sxnui doesn't reload it.
  • I don't believe the cmdpal does either tho
• more?

I've got a vibe that this is too wacky to land for 1.19. I'm gonna close this one for now and come back to it.

Further reading:

• Teaching tip narrator announcement does not announce the subtitle microsoft-ui-xaml#3277 (comment)

  • However you should be able to adjust what narrator reads by setting automation properties on your TeachingTip. Setting AutomationID of the tip eventually gets folded into the announcement from narrator here

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view or the 📜action log for details.

Unrecognized words (2)

exersize
teachingtip

Previously acknowledged words that are now absent

countof cpprest homeglyphs keyevent ONLCR OSCBG OSCCT OSCFG OSCRCC OSCSCB OSCSCC OSCWT pplx pseudocode testdlls Tlgdata websockets xxyyzz :arrow_right:

To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the git@github.com:microsoft/terminal.git repository
on the dev/migrie/f/3121-tooltips branch (ℹ️ how do I use this?):

curl -s -S -L 'https://github.com/raw/check-spelling/check-spelling/v0.0.21/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/5823618460/attempts/1'

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. If it doesn't work for you, you can manually add (one word per line) / remove items to expect.txt and the excludes.txt files.

If the listed items are:

• ... misspelled, then please correct them instead of using the command.
• ... names, please add them to .github/actions/spelling/allow/names.txt.
• ... APIs, you can add them to a file in .github/actions/spelling/allow/.
• ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
• ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

If the flagged items are 🤯 false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it,
  try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

[zadjii-msft]

Attempted resurrection in dev/migrie/fhl/sxnui-tooltips-3

Less wacky with the TeachingTip, but positioning the menu gets harder and I haven't solved that yet.

[zadjii-msft]

AHAHAHA I finally got it to work right!

https://github.com/microsoft/terminal/compare/dev/migrie/f/sxnui-tooltips-4