KeyboardExtensions

[PureWeen]

Description of Change

Linked Issues

• Fixes [Proposal] Add a KeyboardManager for interacting with SoftInputKeyboard device #1055

PR Checklist

• Has a linked Issue, and the Issue has been approved(bug) or Championed (feature/proposal)
• Has tests (if omitted, state reason in description)
• Has samples (if omitted, state reason in description)
• Rebased on top of main at time of PR
• Changes adhere to coding standard
• Documentation created or updated: Keyboard Extensions Docs MicrosoftDocs/CommunityToolkit#248

[pictos]

I've one suggestion

[rachelkang]

Just did some initial testing - ran the sample on Windows and Android, and I'm not sure if the behavior I'm seeing is what we're expecting. (From what I've looked of the code so far (haven't looked at it all yet), this doesn't seem like the intended behavior)

1. On Windows only, clicking on "Check Keyboard State" would hide the keyboard. I'm not sure why this is happening.
2. On both Windows (touch mode) and Android, clicking on "Show Keyboard" does successfully show the keyboard. However, it will ALWAYS focus on the first entry, even if the keyboard is already focused and open on another entry. If a control already has focus, I think we should ensure the keyboard will open on that currently focused control. (perhaps even consider making it open on the last focused control if nothing has focus, but I wouldn't be surprised if that actually unleashed a can of worms so maybe not)

[rachelkang]

1. This is also happening on iOS, as tested on iPad. So on both Windows and iOS, checking the keyboard state hides the keyboard.

2. On iOS, I'm seeing that while "Hide Keyboard" succeeds to hide the keyboard, the label says "Hide Failed"

[JoonghyunCho]

Added Tizen implementation :)

[PureWeen]

1. This is also happening on iOS, as tested on iPad. So on both Windows and iOS, checking the keyboard state hides the keyboard.

2. On iOS, I'm seeing that while "Hide Keyboard" succeeds to hide the keyboard, the label says "Hide Failed"

Yea :-/ this is because of the automatically closing TapGesture that gets added to the underlying page. I added some code to remove that tap gesture with a comment here https://github.com/CommunityToolkit/Maui/pull/1064/files#diff-30341c4d54048fcf5f19b98431e6a7fbdf7b21ab928538aa17ff335961a6f667R16-R34.

[pictos]

@PureWeen is this PR ready for review?

[jfversluis]

@pictos marked as ready for review and talked to Shane for the docs, so ready to go!

[al3xmeister]

How is this meant to be working? The documentation here makes no comment on the token functionality https://learn.microsoft.com/en-us/dotnet/api/microsoft.maui.itextinput.keyboard?view=net-maui-7.0
It would appear replicating the sample code with a command executed from the same control, i.e. the return command of an entry throws a : 'Could not resolve type with token in assembly 'CommunityToolkit.Maui.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null')'.
Could someone please update?

[brminnick]

@al3xmeister KeyboardExtensions provides extension methods for ITextInput, for example;

entry.HideKeyboardAsync();

You can find our documentation here: https://learn.microsoft.com/dotnet/communitytoolkit/maui/extensions/keyboard-extensions

And you can read more about the detailed API design and the motivation for adding this feature here: #1055

[al3xmeister]

@brminnick Thanks Brandon, but doesnt answer my question. The microsoft documentation makes no reference to a cancellation token. It is a required parameter to HideKeyboardAsync();. I presume it's likely after activity.CurrentFocus?.WindowToken, however you can't access it from the return command of an entry. The sample does it from a button. Could this be updated or revisited?

[jfversluis]

This video will be made public later today that goes over it: https://youtu.be/bIsGFx7jGcM the sample that goes with it is here: https://github.com/jfversluis/MauiToolkitKeyboardExtensionsSample

If you don't plan on using the cancellation token you can pass in default. Nonetheless, we should fix this up in the docs.