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/Extensions/KeyboardExtensionsPage.xaml

@@ -0,0 +1,29 @@
+<?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." />
+
+                <Label Text="{Binding KeyboardShowingText}"></Label>
+                <Label Text="{Binding OperationResult}"></Label>
+
+                <Entry Text="" x:Name="entryToFocus"></Entry>
+                <Entry Text="" x:Name="secondEntry"></Entry>
+                <Button Text="Show Keyboard" CommandParameter="{x:Reference Name=entryToFocus}" Command="{Binding ShowKeyboard}"></Button>
+                <Button Text="Hide Keyboard" CommandParameter="{x:Reference Name=entryToFocus}" Command="{Binding HideKeyboard}"></Button>
+                <Button Text="Check Keyboard State" CommandParameter="{x:Reference Name=entryToFocus}" Command="{Binding IsKeyboardShowing}"></Button>
+
+            </VerticalStackLayout>
+        </ScrollView>
+
+    </pages:BasePage.Content>
+</pages:BasePage>

samples/CommunityToolkit.Maui.Sample/Pages/Extensions/KeyboardExtensionsPage.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 KeyboardExtensionsPage : BasePage<KeyboardExtensionsViewModel>
+{
+	public KeyboardExtensionsPage(KeyboardExtensionsViewModel 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<KeyboardExtensionsViewModel>(nameof(KeyboardExtensions),
+				"Extension methods that provide keyboard interactions"),
 		})
 	{
 

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

@@ -0,0 +1,70 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using CommunityToolkit.Maui.Core.Platform;
+using CommunityToolkit.Mvvm.ComponentModel;
+
+namespace CommunityToolkit.Maui.Sample.ViewModels.Extensions;
+public partial class KeyboardExtensionsViewModel : BaseViewModel
+{
+
+	public KeyboardExtensionsViewModel()
+	{
+		ShowKeyboard = new Command<ITextInput>(OnShowKeyboard);
+		HideKeyboard = new Command<ITextInput>(OnHideKeyboard);
+		IsKeyboardShowing = new Command<ITextInput>(OnIsKeyboardShowing);
+	}
+
+	void OnIsKeyboardShowing(ITextInput view)
+	{
+		if (!view.IsSoftKeyboardShowing())
+		{
+			KeyboardShowingText = $"Soft Input Is Currently Hidden";
+		}
+		else
+		{
+			KeyboardShowingText = $"Soft Input Is Currently Showing";
+		}
+	}
+
+	async void OnHideKeyboard(ITextInput view)
+	{
+		if (await view.HideKeyboardAsync())
+		{
+			OperationResult = "Hide Succeeded";
+		}
+		else
+		{
+			OperationResult = "Hide Failed";
+		}
+	}
+
+	async void OnShowKeyboard(ITextInput view)
+	{
+		if (await view.ShowKeyboardAsync())
+		{
+			OperationResult = "Show Succeeded";
+		}
+		else
+		{
+			OperationResult = "Show Failed";
+		}
+	}
+
+	[ObservableProperty]
+	string? keyboardShowingText;
+
+	[ObservableProperty]
+	string? operationResult;
+
+	[ObservableProperty]
+	Command<ITextInput>? showKeyboard;
+
+	[ObservableProperty]
+	Command<ITextInput>? hideKeyboard;
+
+	[ObservableProperty]
+	Command<ITextInput>? isKeyboardShowing;
+}

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

@@ -0,0 +1,66 @@
+using System;
+using Android.Content;
+using Android.Views;
+using Android.Views.InputMethods;
+using AndroidX.Core.View;
+using Kotlin.Contracts;
+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) == true;
+		}
+	}
+
+	static bool ShowKeyboard(this AView view)
+	{
+		switch (view)
+		{
+			case TextView textView:
+				return textView.ShowKeyboard();
+			case ViewGroup viewGroup:
+				return viewGroup.GetFirstChildOfType<TextView>()?.ShowKeyboard() == true;
+		}
+
+		return 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/KeyboardManager/KeyboardExtensions.ios.cs

@@ -0,0 +1,13 @@
+using System;
+using UIKit;
+
+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/KeyboardManager/KeyboardExtensions.macos.cs

@@ -0,0 +1,23 @@
+using System;
+using UIKit;
+
+namespace CommunityToolkit.Maui.Core.Platform;
+
+[UnsupportedOSPlatform("MacOS")]
+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/KeyboardManager/KeyboardExtensions.net.cs

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