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<KeyboardManagerExtensionsPage, KeyboardManagerExtensionsViewModel, 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<KeyboardManagerExtensionsPage, KeyboardManagerExtensionsViewModel>();
 
 		// Add ImageSources Pages + ViewModels
 		services.AddTransientWithShellRoute<GravatarImageSourcePage, GravatarImageSourceViewModel>();

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

@@ -0,0 +1,18 @@
+<?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.KeyboardManagerExtensionsPage"
+    Title="KeyboardManagerExtensionsPage"
+    xmlns:vm="clr-namespace:CommunityToolkit.Maui.Sample.ViewModels.Extensions"
+    x:TypeArguments="vm:KeyboardManagerExtensionsViewModel"
+    x:DataType="vm:KeyboardManagerExtensionsViewModel">
+    <pages:BasePage.Content>
+        <VerticalStackLayout Spacing="12">
+            <Entry Text="Hello" x:Name="entry"></Entry>
+            <Button Text="Show Keyboard" CommandParameter="{x:Reference Name=entry}" Command="{Binding ShowKeyboard}"></Button>
+            <Button Text="Hide Keyboard" CommandParameter="{x:Reference Name=entry}" Command="{Binding HideKeyboard}"></Button>
+        </VerticalStackLayout>
+    </pages:BasePage.Content>
+</pages:BasePage>

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

@@ -0,0 +1,13 @@
+using CommunityToolkit.Maui.Sample.ViewModels.Converters;
+using CommunityToolkit.Maui.Sample.ViewModels.Extensions;
+
+namespace CommunityToolkit.Maui.Sample.Pages.Extensions;
+
+public partial class KeyboardManagerExtensionsPage : BasePage<KeyboardManagerExtensionsViewModel>
+{
+	public KeyboardManagerExtensionsPage(KeyboardManagerExtensionsViewModel viewModel) :
+		base(viewModel)
+	{
+		InitializeComponent();
+	}
+}

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<KeyboardManagerExtensionsViewModel>(nameof(KeyboardManager),
+				"Extension methods that provide keyboard interactions"),
 		})
 	{
 

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

@@ -0,0 +1,29 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using CommunityToolkit.Maui.Core.Platform;
+
+namespace CommunityToolkit.Maui.Sample.ViewModels.Extensions;
+public class KeyboardManagerExtensionsViewModel : BaseViewModel
+{
+	public Command<ITextInput> ShowKeyboard { get; }
+	public Command<ITextInput> HideKeyboard { get; }
+
+	public KeyboardManagerExtensionsViewModel()
+	{
+		ShowKeyboard = new Command<ITextInput>(OnShowKeyboard);
+		HideKeyboard = new Command<ITextInput>(OnHideKeyboard);
+	}
+
+	void OnHideKeyboard(ITextInput view)
+	{
+		view.HideKeyboard();
+	}
+
+	void OnShowKeyboard(ITextInput view)
+	{
+		view.ShowKeyboard();
+	}
+}

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

@@ -0,0 +1,73 @@
+using System;
+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 KeyboardManager
+{
+	static void HideKeyboard(this AView inputView)
+	{
+		if (inputView?.Context == null)
+		{
+			throw new ArgumentNullException(nameof(inputView), "Must be set before the keyboard can be hidden.");
+		}
+
+		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 != null && inputMethodManager != null)
+			{
+				inputMethodManager.HideSoftInputFromWindow(windowToken, HideSoftInputFlags.None);
+			}
+		}
+	}
+
+	static void ShowKeyboard(this TextView inputView)
+	{
+		if (inputView?.Context == null)
+		{
+			throw new ArgumentNullException(nameof(inputView), "Must be set before the keyboard can be shown.");
+		}
+
+		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
+			inputMethodManager?.ShowSoftInput(inputView, 0);
+		}
+	}
+
+	static void ShowKeyboard(this AView view)
+	{
+		switch (view)
+		{
+			case TextView textView:
+				textView.ShowKeyboard();
+				break;
+			case ViewGroup viewGroup:
+				viewGroup.GetFirstChildOfType<TextView>()?.ShowKeyboard();
+				break;
+		}
+	}
+
+	static bool IsSoftKeyboardVisible(this AView view)
+	{
+		var insets = ViewCompat.GetRootWindowInsets(view);
+		if (insets == null)
+		{
+			return false;
+		}
+
+		var result = insets.IsVisible(WindowInsetsCompat.Type.Ime());
+		return result;
+	}
+}

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

@@ -0,0 +1,13 @@
+using System;
+using UIKit;
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+public static partial class KeyboardManager
+{
+	static void HideKeyboard(this UIView inputView) => inputView.ResignFirstResponder();
+
+	static void ShowKeyboard(this UIView inputView) => inputView.BecomeFirstResponder();
+
+	static bool IsSoftKeyboardVisible(this UIView inputView) => inputView.IsFirstResponder;
+}

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

@@ -0,0 +1,23 @@
+using System;
+using UIKit;
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+[UnsupportedOSPlatform("MacOS")]
+public static partial class KeyboardManager
+{
+	static void HideKeyboard(this UIView inputView)
+	{
+		throw new NotSupportedException("MacOS does not currently support opening the SoftKeyboard");
+	}
+
+	static void ShowKeyboard(this UIView inputView)
+	{
+		throw new NotSupportedException("MacOS does not currently support opening the SoftKeyboard");
+	}
+
+	static bool IsSoftKeyboardVisible(this UIView inputView)
+	{
+		throw new NotSupportedException("MacOS does not currently support opening the SoftKeyboard");
+	}
+}

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

@@ -0,0 +1,21 @@
+using System;
+using System.Diagnostics;
+using System.Reflection.Metadata;
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+public static partial class KeyboardManager
+{
+	static void HideKeyboard(this object _)
+	{
+	}
+
+	static void ShowKeyboard(this object _)
+	{
+	}
+
+	static bool IsSoftKeyboardVisible(this object _)
+	{
+		return false;
+	}
+}

src/CommunityToolkit.Maui.Core/Platform/KeyboardManager/KeyboardManager.shared.cs

@@ -0,0 +1,119 @@
+using System.Diagnostics.CodeAnalysis;
+using CommunityToolkit.Maui.Core.Extensions;
+using Microsoft.Maui.Dispatching;
+
+#if IOS || MACCATALYST
+using PlatformView = UIKit.UIView;
+#elif ANDROID
+using PlatformView = Android.Views.View;
+#elif WINDOWS
+using PlatformView = Microsoft.UI.Xaml.FrameworkElement;
+#elif TIZEN
+using PlatformView = Tizen.NUI.BaseComponents.View;
+#elif (NETSTANDARD || !PLATFORM) || (NET6_0_OR_GREATER && !IOS && !ANDROID && !TIZEN)
+using PlatformView = System.Object;
+using IPlatformViewHandler = Microsoft.Maui.IViewHandler;
+#endif
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+/// <summary>
+/// 
+/// </summary>
+public static partial class KeyboardManager
+{
+	static bool TryGetPlatformView(
+		this ITextInput textInput,
+		[NotNullWhen(true)] out PlatformView? platformView,
+		[NotNullWhen(true)] out IPlatformViewHandler? handler,
+		[NotNullWhen(true)] out IView? view)
+	{
+		if (textInput is not IView iView ||
+			iView.Handler is not IPlatformViewHandler platformViewHandler)
+		{
+			platformView = null;
+			handler = null;
+			view = null;
+			return false;
+		}
+
+		if (iView.Handler?.PlatformView is not PlatformView platform)
+		{
+
+			platformView = null;
+			handler = null;
+			view = null;
+			return false;
+		}
+
+		handler = platformViewHandler;
+		platformView = platform;
+		view = iView;
+
+		return true;
+	}
+
+	/// <summary>
+	/// 
+	/// </summary>
+	/// <param name="targetView"></param>
+	public static void HideKeyboard(this ITextInput targetView)
+	{
+		if (!targetView.TryGetPlatformView(
+			out var platformView,
+			out _,
+			out _))
+		{
+			return;
+		}
+
+		HideKeyboard(platformView);
+	}
+
+	/// <summary>
+	/// 
+	/// </summary>
+	/// <param name="targetView"></param>
+	public static void ShowKeyboard(this ITextInput targetView)
+	{
+		if (!targetView.TryGetPlatformView(
+			out var platformView, 
+			out var handler,
+			out var view))
+		{
+			return;
+		}
+
+		if (!view.IsFocused)
+		{
+			handler.Invoke(nameof(IView.Focus), new FocusRequest(false));
+			handler.GetRequiredService<IDispatcher>()
+				.Dispatch(() =>
+				{
+					platformView.ShowKeyboard();
+				});
+		}
+		else
+		{
+			platformView.ShowKeyboard();
+		}
+	}
+
+	/// <summary>
+	/// 
+	/// </summary>
+	/// <param name="targetView"></param>
+	/// <returns></returns>
+	public static bool IsSoftKeyboardVisible(this ITextInput targetView)
+	{
+		if (!targetView.TryGetPlatformView(
+			out var platformView,
+			out _,
+			out _))
+		{
+			return false;
+		}
+
+		return platformView.IsSoftKeyboardVisible();
+	}
+}