KeyboardExtensions

samples/CommunityToolkit.Maui.Sample/AppShell.xaml.cs

@@ -12,6 +12,7 @@
 using CommunityToolkit.Maui.Sample.ViewModels.Behaviors;
 using CommunityToolkit.Maui.Sample.ViewModels.Converters;
 using CommunityToolkit.Maui.Sample.ViewModels.Essentials;
+using CommunityToolkit.Maui.Sample.ViewModels.Extensions;
 using CommunityToolkit.Maui.Sample.ViewModels.ImageSources;
 using CommunityToolkit.Maui.Sample.ViewModels.Layouts;
 using CommunityToolkit.Maui.Sample.ViewModels.Views;
@@ -87,6 +88,7 @@ public partial class AppShell : Shell
 
 		// Add Extensions View Models
 		CreateViewModelMapping<ColorAnimationExtensionsPage, ColorAnimationExtensionsViewModel, ExtensionsGalleryPage, ExtensionsGalleryViewModel>(),
+		CreateViewModelMapping<KeyboardExtensionsPage, KeyboardExtensionsViewModel, ExtensionsGalleryPage, ExtensionsGalleryViewModel>(),
 
 		// Add ImageSources View Models
 		CreateViewModelMapping<GravatarImageSourcePage, GravatarImageSourceViewModel, ImageSourcesGalleryPage, ImageSourcesGalleryViewModel>(),

samples/CommunityToolkit.Maui.Sample/MauiProgram.cs

@@ -15,6 +15,7 @@
 using CommunityToolkit.Maui.Sample.ViewModels.Behaviors;
 using CommunityToolkit.Maui.Sample.ViewModels.Converters;
 using CommunityToolkit.Maui.Sample.ViewModels.Essentials;
+using CommunityToolkit.Maui.Sample.ViewModels.Extensions;
 using CommunityToolkit.Maui.Sample.ViewModels.ImageSources;
 using CommunityToolkit.Maui.Sample.ViewModels.Layouts;
 using CommunityToolkit.Maui.Sample.ViewModels.Views;
@@ -156,6 +157,7 @@ static void RegisterViewsAndViewModels(in IServiceCollection services)
 
 		// Add Extensions Pages + ViewModels
 		services.AddTransientWithShellRoute<ColorAnimationExtensionsPage, ColorAnimationExtensionsViewModel>();
+		services.AddTransientWithShellRoute<KeyboardExtensionsPage, KeyboardExtensionsViewModel>();
 
 		// Add ImageSources Pages + ViewModels
 		services.AddTransientWithShellRoute<GravatarImageSourcePage, GravatarImageSourceViewModel>();

samples/CommunityToolkit.Maui.Sample/Pages/Behaviors/StatusBarBehaviorPage.xaml.cs

@@ -1,4 +1,3 @@
-using CommunityToolkit.Maui.Sample.Pages;
 using CommunityToolkit.Maui.Sample.ViewModels.Behaviors;
 
 namespace CommunityToolkit.Maui.Sample.Pages.Behaviors;

samples/CommunityToolkit.Maui.Sample/Pages/Extensions/KeyboardExtensionsPage.xaml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<pages:BasePage 
+    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+    xmlns:pages="clr-namespace:CommunityToolkit.Maui.Sample.Pages"
+    x:Class="CommunityToolkit.Maui.Sample.Pages.Extensions.KeyboardExtensionsPage"
+    Title="KeyboardExtensionsPage"
+    xmlns:vm="clr-namespace:CommunityToolkit.Maui.Sample.ViewModels.Extensions"
+    x:TypeArguments="vm:KeyboardExtensionsViewModel"
+    x:DataType="vm:KeyboardExtensionsViewModel">
+    <pages:BasePage.Content>
+        <ScrollView>
+            <VerticalStackLayout Spacing="12">
+                <Label Text="The Keyboard extension method provides an easy way to open and close the SoftInput Keyboard device on platforms that support it."
+                       HorizontalOptions="Center"
+                       HorizontalTextAlignment="Center"/>
+
+                <Label Text="{Binding OperationResult}"></Label>
+
+                <Entry Text="" x:Name="entryToFocus" Focused="OnEntryFocused"></Entry>
+
+                <Button Text="Show Keyboard" CommandParameter="{x:Reference Name=entryToFocus}" Command="{Binding ShowKeyboardCommand}"></Button>
+                <Button Text="Hide Keyboard" CommandParameter="{x:Reference Name=entryToFocus}" Command="{Binding HideKeyboardCommand}"></Button>
+                <Button Text="Check Keyboard State" CommandParameter="{x:Reference Name=entryToFocus}" Command="{Binding IsKeyboardShowingCommand}"></Button>
+
+            </VerticalStackLayout>
+        </ScrollView>
+
+    </pages:BasePage.Content>
+</pages:BasePage>

samples/CommunityToolkit.Maui.Sample/Pages/Extensions/KeyboardExtensionsPage.xaml.cs

@@ -0,0 +1,37 @@
+using CommunityToolkit.Maui.Sample.ViewModels.Extensions;
+
+namespace CommunityToolkit.Maui.Sample.Pages.Extensions;
+
+public partial class KeyboardExtensionsPage : BasePage<KeyboardExtensionsViewModel>
+{
+	public KeyboardExtensionsPage(KeyboardExtensionsViewModel viewModel) :
+		base(viewModel)
+	{
+		InitializeComponent();
+	}
+
+	void OnEntryFocused(System.Object sender, Microsoft.Maui.Controls.FocusEventArgs e)
+	{
+#if IOS || MACCATALYST
+		// Currently .NET MAUI will auto close the keyboard on iOS if you click outside of the entry
+		// This causes the examples on this page to behave oddly, because the keybord auto closes if the user
+		// taps the "hide keyboard" or "check keyboard status" buttons.
+		// We're going to remove this as the default behavior in .NET 8 and then users can re-enable it via
+		// https://github.com/CommunityToolkit/Maui/issues/978
+		// This code removes the TapGestureRecognizer used to detect and close the keyboard so that we can accurately
+		// validate that these APIs work on iOS
+		if (this?.Handler?.PlatformView is UIKit.UIView uiView &&
+			uiView.GestureRecognizers is not null)
+		{
+			foreach (var gesture in uiView.GestureRecognizers)
+			{
+				if (gesture is UIKit.UITapGestureRecognizer gr)
+				{
+					uiView.RemoveGestureRecognizer(gr);
+					break;
+				}
+			}
+		}
+#endif
+	}
+}

samples/CommunityToolkit.Maui.Sample/ViewModels/Extensions/ExtensionsGalleryViewModel.cs

@@ -1,5 +1,7 @@
-using CommunityToolkit.Maui.Extensions;
+using CommunityToolkit.Maui.Core.Platform;
+using CommunityToolkit.Maui.Extensions;
 using CommunityToolkit.Maui.Sample.Models;
+using CommunityToolkit.Maui.Sample.ViewModels.Extensions;
 
 namespace CommunityToolkit.Maui.Sample.ViewModels.Converters;
 
@@ -10,6 +12,9 @@ public ExtensionsGalleryViewModel()
 		{
 			SectionModel.Create<ColorAnimationExtensionsViewModel>(nameof(ColorAnimationExtensions),
 				"Extension methods that provide color animations"),
+
+			SectionModel.Create<KeyboardExtensionsViewModel>(nameof(KeyboardExtensions),
+				"Extension methods that provide keyboard interactions"),
 		})
 	{
 

samples/CommunityToolkit.Maui.Sample/ViewModels/Extensions/KeyboardExtensionsViewModel.cs

@@ -0,0 +1,68 @@
+using CommunityToolkit.Maui.Core.Platform;
+using CommunityToolkit.Mvvm.ComponentModel;
+using CommunityToolkit.Mvvm.Input;
+
+namespace CommunityToolkit.Maui.Sample.ViewModels.Extensions;
+
+public partial class KeyboardExtensionsViewModel : BaseViewModel
+{
+	[ObservableProperty]
+	string operationResult = string.Empty;
+
+	[RelayCommand]
+	void OnIsKeyboardShowing(ITextInput view)
+	{
+		if (view.IsSoftKeyboardShowing())
+		{
+			OperationResult = $"Soft Input Is Currently Showing";
+		}
+		else
+		{
+			OperationResult = $"Soft Input Is Currently Hidden";
+		}
+	}
+
+	[RelayCommand]
+	async Task OnHideKeyboard(ITextInput view, CancellationToken token)
+	{
+		try
+		{
+			bool isSuccessful = await view.HideKeyboardAsync(token);
+
+			if (isSuccessful)
+			{
+				OperationResult = "Hide Succeeded";
+			}
+			else
+			{
+				OperationResult = "Hide Failed";
+			}
+		}
+		catch (Exception e)
+		{
+			OperationResult = e.Message;
+		}
+	}
+
+	[RelayCommand]
+	async Task OnShowKeyboard(ITextInput view, CancellationToken token)
+	{
+		try
+		{
+			bool isSuccessful = await view.ShowKeyboardAsync(CancellationToken.None);
+
+			if (isSuccessful)
+			{
+				OperationResult = "Show Succeeded";
+			}
+			else
+			{
+				OperationResult = "Show Failed";
+			}
+		}
+		catch (Exception e)
+		{
+			OperationResult = e.Message;
+		}
+	}
+}

src/CommunityToolkit.Maui.Core/Platform/KeyboardExtensions/KeyboardExtensions.android.cs

@@ -0,0 +1,56 @@
+using Android.Content;
+using Android.Views;
+using Android.Views.InputMethods;
+using AndroidX.Core.View;
+using Microsoft.Maui.Platform;
+using AView = Android.Views.View;
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+public static partial class KeyboardExtensions
+{
+	static bool HideKeyboard(this AView inputView)
+	{
+		var focusedView = inputView.Context?.GetActivity()?.Window?.CurrentFocus;
+		AView tokenView = focusedView ?? inputView;
+
+		using var inputMethodManager = (InputMethodManager?)tokenView.Context?.GetSystemService(Context.InputMethodService);
+		var windowToken = tokenView.WindowToken;
+
+		if (windowToken is not null && inputMethodManager is not null)
+		{
+			return inputMethodManager.HideSoftInputFromWindow(windowToken, HideSoftInputFlags.None);
+		}
+
+		return false;
+	}
+
+	static bool ShowKeyboard(this TextView inputView)
+	{
+		using var inputMethodManager = (InputMethodManager?)inputView.Context?.GetSystemService(Context.InputMethodService);
+
+		// The zero value for the second parameter comes from 
+		// https://developer.android.com/reference/android/view/inputmethod/InputMethodManager#showSoftInput(android.view.View,%20int)
+		// Apparently there's no named value for zero in this case
+		return inputMethodManager?.ShowSoftInput(inputView, 0) is true;
+	}
+
+	static bool ShowKeyboard(this AView view) => view switch
+	{
+		TextView textView => textView.ShowKeyboard(),
+		ViewGroup viewGroup => viewGroup.GetFirstChildOfType<TextView>()?.ShowKeyboard() is true,
+		_ => false,
+	};
+
+	static bool IsSoftKeyboardShowing(this AView view)
+	{
+		var insets = ViewCompat.GetRootWindowInsets(view);
+		if (insets is null)
+		{
+			return false;
+		}
+
+		var result = insets.IsVisible(WindowInsetsCompat.Type.Ime());
+		return result;
+	}
+}

src/CommunityToolkit.Maui.Core/Platform/KeyboardExtensions/KeyboardExtensions.ios.cs

@@ -0,0 +1,10 @@
+namespace CommunityToolkit.Maui.Core.Platform;
+
+public static partial class KeyboardExtensions
+{
+	static bool HideKeyboard(this UIView inputView) => inputView.ResignFirstResponder();
+
+	static bool ShowKeyboard(this UIView inputView) => inputView.BecomeFirstResponder();
+
+	static bool IsSoftKeyboardShowing(this UIView inputView) => inputView.IsFirstResponder;
+}

src/CommunityToolkit.Maui.Core/Platform/KeyboardExtensions/KeyboardExtensions.macos.cs

@@ -0,0 +1,13 @@
+using System.Runtime.Versioning;
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+[UnsupportedOSPlatform("MacCatalyst")]
+public static partial class KeyboardExtensions
+{
+    static bool HideKeyboard(this UIView inputView) => throw new NotSupportedException("MacOS does not currently support opening the SoftKeyboard");
+
+    static bool ShowKeyboard(this UIView inputView) => throw new NotSupportedException("MacOS does not currently support opening the SoftKeyboard");
+
+    static bool IsSoftKeyboardShowing(this UIView inputView) => throw new NotSupportedException("MacOS does not currently support opening the SoftKeyboard");
+}

src/CommunityToolkit.Maui.Core/Platform/KeyboardExtensions/KeyboardExtensions.net.cs

@@ -0,0 +1,10 @@
+namespace CommunityToolkit.Maui.Core.Platform;
+
+public static partial class KeyboardExtensions
+{
+	static bool HideKeyboard(this object _) => throw new NotSupportedException();
+
+	static bool ShowKeyboard(this object _) => throw new NotSupportedException();
+
+	static bool IsSoftKeyboardShowing(this object _) => throw new NotSupportedException();
+}