Edit

KeyboardExtensions

  • Article

The KeyboardExtensions provide a series of extension methods that support interacting with the Keyboard on controls that support text input.

The KeyboardExtensions can be found under the CommunityToolkit.Maui.Core.Platform namespace so just add the following line to get started:

using CommunityToolkit.Maui.Core.Platform;

Soft Keyboard Methods

The following methods allow you to close, show, and check if the keyboard is open.

Hide Keyboard

The HideKeyboardAsync method will hide the Soft Input Keyboard if it is currently visible

The following example shows how to hide the keyboard for a given entry:

using CommunityToolkit.Maui.Core.Platform;

entry.HideKeyboardAsync(CancellationToken.None);

Show Keyboard

The ShowKeyboardAsync method will show the Soft Input Keyboard and indicates what control you are opening it for

The following example shows how to show the keyboard for a given entry:

using CommunityToolkit.Maui.Core.Platform;

entry.ShowKeyboardAsync(CancellationToken.None);

Is SoftKeyboard Showing

The IsSoftKeyboardShowing method indicates if the Soft Keyboard is currently open.

The following example shows how to check if the Soft Input Keyboard is currently open and showing:

using CommunityToolkit.Maui.Core.Platform;

entry.IsSoftKeyboardShowing()

Examples

You can find an example of this extension in action in the .NET MAUI Community Toolkit Sample Application.

API

You can find the source code for KeyboardExtensions over on the .NET MAUI Community Toolkit GitHub repository.