New behavior KeyDownTriggerBehavior

[ArchieCoder]

Fixes #4152

Discussion: #4152

Add a new behavior that listens to a key press event on the associated UIElement and triggers the set of actions.

PR Type

What kind of change does this PR introduce?

New behavior

What is the current behavior?

What is the new behavior?

New behavior is added.

PR Checklist

Please check if your PR fulfills the following requirements:

• Tested code with current supported SDKs
• Pull Request has been submitted to the documentation repository instructions. Link:
• Sample in sample app has been added / updated (for bug fixes / features)
  • Icon has been created (if new sample) following the Thumbnail Style Guide and templates
• New major technical changes in the toolkit have or will be added to the Wiki e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
• Tests for the changes have been added (for bug fixes / features) (if applicable)
• Header has been added to all new source files (run build/UpdateHeaders.bat)
• Contains NO breaking changes

Other information

[ghost]

Thanks ArchieCoder for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌

[net-foundation-cla]

All CLA requirements met.

[net-foundation-cla]

Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

❌ ArchieCoder sign now
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[michael-hawker]

@ArchieCoder did you forget to push? Looks like you replied to some comments, but I don't see the changes up here in the PR.

[ArchieCoder]

@michael-hawker One last thing, is the doc generated after the PR is merged?

[michael-hawker]

@ArchieCoder you need to manually submit a doc PR, though I don't think we have a base Behavior page in the docs, as we'd probably just want to point folks to general overview since they're pretty simple (vs. having a dedicated page for each one). @XAML-Knight this could be a good thing we could have you do to get familiar with the docs and the other behaviors.

The API doc is auto-generated when we do the release as long as all the XML comments are there, which we enforce with Style-cop.

Looks like the build is failing as the header is still missing on the new file. You can also run UpdateHeaders.bat or '.\build.ps1 -Target UpdateHeaders' to add it.

[ArchieCoder]

@michael-hawker I ran the tool and submitted the header.

I was just wondering about the doc because for example the other behavior has this file and it is nowhere in the solution. This is why I supposed it is generated with another system.

"DocumentationUrl": "https://raw.githubusercontent.com/MicrosoftDocs/WindowsCommunityToolkitDocs/master/docs/behaviors/FocusBehaviors.md

[XAML-Knight]

Hi @ArchieCoder , I've started a dev branch for this behavior's documentation; feel free to fork & embellish:

https://github.com/XAML-Knight/WindowsCommunityToolkitDocs/tree/dev/KeyDownTriggerBehavior

[ArchieCoder]

@michael-hawker Hi, is there any other steps that I need to do?

[michael-hawker]

@ArchieCoder the CI is still failing on a StyleCop issue:

D:\a\1\s\Microsoft.Toolkit.Uwp.UI.Behaviors\Keyboard\KeyDownTriggerBehavior.cs(17,5): error SA1505: An opening brace should not be followed by a blank line. [D:\a\1\s\Microsoft.Toolkit.Uwp.UI.Behaviors\Microsoft.Toolkit.Uwp.UI.Behaviors.csproj]

Other than that though, I think it's all set to be tested and reviewed, so we'd just need to get sign-off from a couple of folks. I'll take another pass now, but I know it's been looking pretty good. Appreciate all your work on this! 🦙❤

[ArchieCoder]

Ok, I didn't notice the StyleCop. Fixed now.

[michael-hawker]

Code-side looks good to me. @XAML-Knight or @RosarioPulella feel like taking it for a spin? 🙂

[michael-hawker]

Suggested change

<ItemGroup />

We can remove this to minimize noise.

[XAML-Knight]

Make sure this DocumentationUrl property points to the correct markdown file, for the corresponding file in the
WindowsCommunityToolkitDocs repo. A markdown file doesn't exist in the Docs repo for this Keyboard behavior yet, of course, so we'll need to add it, as an additional PR to the Docs repo.

• @ArchieCoder are you planning on submitting a corresponding PR to the WindowsCommunityToolkitDocs repo, for the markdown file?
  • Feel free to reach out regarding how to submit a PR to the Docs repo
  • More online guidance for submitting a Docs PR guidance here and here

[ArchieCoder]

@XAML-Knight can I just remove the DocumentationUrl? This behavior is so simple that the existing comments in the code is self-explanatory.

So far, it took me like 20 mins to do the behavior, but all the rest is many hours!

[XAML-Knight]

Approved. Pushed commit eab041e to this user branch, for modification of samples.json, to fit more descriptive markdown file name in the Docs repo.

Submitted related Docs PR #556

[XAML-Knight]

DocumentationUrl modified, to fit more descriptive markdown file name

[michael-hawker]

Thanks @ArchieCoder for this contribution to the Toolkit! 🎉🎉🎉

[ArchieCoder]

Thanks you for your help @michael-hawker !