feat: added inputextensions returntype property

unoplatform · May 9, 2024 · 3d63364 · 3d63364
1 parent 87f3a19
commit 3d63364
Show file tree

Hide file tree

Showing 3 changed files with 113 additions and 5 deletions.
diff --git a/doc/helpers/Input-extensions.md b/doc/helpers/Input-extensions.md
@@ -8,11 +8,12 @@ Provides various attached properties for _input controls_, such as `TextBox` and
 
 ## Attached Properties
 
-| Property               | Type      | Description                                                                                |
-|------------------------|-----------|--------------------------------------------------------------------------------------------|
-| `AutoDismiss`          | `bool`    | Whether the soft-keyboard will be dismissed when the enter key is pressed.                 |
-| `AutoFocusNext`        | `bool`    | Whether the focus will move to the next focusable element when the enter key is pressed.\* |
-| `AutoFocusNextElement` | `Control` | Sets the next control to focus when the enter key is pressed.\*                            |
+| Property               | Type         | Description                                                                                                           |
+|------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------|
+| `AutoDismiss`          | `bool`       | Whether the soft-keyboard will be dismissed when the enter key is pressed.                                            |
+| `AutoFocusNext`        | `bool`       | Whether the focus will move to the next focusable element when the enter key is pressed.\*                            |
+| `AutoFocusNextElement` | `Control`    | Sets the next control to focus when the enter key is pressed.\*                                                       |
+| `ReturnType`           | `ReturnType` | The return button type on the soft-keyboard. Can be one of the following: __Default, Done, Go, Next, Search, Send__.  |
 
 `AutoFocusNext` and `AutoFocusNextElement`\*: Having either or both of the two properties set will enable the focus next behavior. `AutoFocusNextElement` will take precedences over `AutoFocusNext` when both are set.
 
@@ -37,4 +38,7 @@ xmlns:utu="using:Uno.Toolkit.UI"
 
 <!-- Dismiss soft-keyboard on enter -->
 <TextBox utu:InputExtensions.AutoDismiss="True" />
+
+<!-- Soft-keyboard with send as return button -->
+<TextBox utu:InputExtensions.ReturnType="Send" />
 ```
diff --git a/...oolkit.Samples/Uno.Toolkit.Samples.Shared/Content/Controls/InputExtensionsSamplePage.xaml b/...oolkit.Samples/Uno.Toolkit.Samples.Shared/Content/Controls/InputExtensionsSamplePage.xaml
@@ -35,6 +35,16 @@
 							<TextBox utu:InputExtensions.AutoDismiss="True" />
 						</StackPanel>
 
+						<StackPanel Spacing="8">
+							<TextBlock Text="Soft-keyboards of different return types" />
+							<TextBox Text="Default" utu:InputExtensions.ReturnType="Default" />
+							<TextBox Text="Done" utu:InputExtensions.ReturnType="Done" />
+							<TextBox Text="Go" utu:InputExtensions.ReturnType="Go" />
+							<TextBox Text="Next" utu:InputExtensions.ReturnType="Next" />
+							<TextBox Text="Search" utu:InputExtensions.ReturnType="Search" />
+							<TextBox Text="Send" utu:InputExtensions.ReturnType="Send" />
+						</StackPanel>
+
 					</StackPanel>
 				</DataTemplate>
 			</sample:SamplePageLayout.DesignAgnosticTemplate>

diff --git a/src/Uno.Toolkit.UI/Behaviors/InputExtensions.cs b/src/Uno.Toolkit.UI/Behaviors/InputExtensions.cs
@@ -11,6 +11,12 @@
 using Windows.System;
 using Windows.UI.ViewManagement;
 
+#if __ANDROID__
+using Android.Views.InputMethods;
+#elif __IOS__
+using UIKit;
+#endif
+
 #if IS_WINUI
 using Microsoft.UI.Xaml;
 using Microsoft.UI.Xaml.Controls;
@@ -27,6 +33,32 @@ public static class InputExtensions
 	{
 		private static readonly ILogger _logger = typeof(InputExtensions).Log();
 
+		public enum ReturnType {
+			Default,
+			Done,
+			Go,
+			Next,
+			Search,
+			Send
+		}
+
+		#region DependencyProperty: ReturnType
+
+		/// <summary>
+		/// Backing property for what type of return the soft-keyboard will show.
+		/// </summary>
+		public static DependencyProperty ReturnTypeProperty { [DynamicDependency(nameof(GetReturnType))] get; } = DependencyProperty.RegisterAttached(
+			"ReturnType",
+			typeof(ReturnType),
+			typeof(InputExtensions),
+			new PropertyMetadata(ReturnType.Default, OnReturnTypeChanged));
+
+		[DynamicDependency(nameof(SetReturnType))]
+		public static ReturnType GetReturnType(DependencyObject obj) => (ReturnType)obj.GetValue(ReturnTypeProperty);
+		[DynamicDependency(nameof(GetReturnType))]
+		public static void SetReturnType(DependencyObject obj, ReturnType value) => obj.SetValue(ReturnTypeProperty, value);
+
+		#endregion
 		#region DependencyProperty: AutoDismiss
 
 		/// <summary>
@@ -109,6 +141,36 @@ internal static bool IsEnterCommandSupportedFor(DependencyObject host)
 			return host is TextBox || host is PasswordBox;
 		}
 
+		private static void OnReturnTypeChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
+		{
+			if (sender is Control control && (sender is TextBox || sender is PasswordBox) && e.NewValue is ReturnType returnType)
+			{
+#if __ANDROID__
+				ImeAction imeAction = GetImeActionFromReturnType(returnType);
+
+				if (control is TextBox textBox)
+				{
+					textBox.ImeOptions = imeAction;
+				}
+				else if (control is PasswordBox passwordBox)
+				{
+					passwordBox.ImeOptions = imeAction;
+				}
+#elif __IOS__
+				UIReturnKeyType returnKeyType = GetReturnKeyTypeFromReturnType(returnType);
+
+				if (control is TextBox textBox)
+				{
+					textBox.ReturnKeyType = returnKeyType;
+				}
+				else if (control is PasswordBox passwordBox)
+				{
+					passwordBox.ReturnKeyType = returnKeyType;
+				}
+#endif
+			}
+		}
+
 		private static void OnAutoDismissChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) => UpdateSubscription(sender);
 		private static void OnAutoFocusNextChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) => UpdateSubscription(sender);
 		private static void OnAutoFocusNextElementChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) => UpdateSubscription(sender);
@@ -177,5 +239,37 @@ private static void OnUIElementKeyUp(object sender, KeyRoutedEventArgs e)
 				_ => default,
 			};
 		}
+
+#if __ANDROID__
+		private static ImeAction GetImeActionFromReturnType(ReturnType returnType)
+		{
+			switch (returnType)
+			{
+				case ReturnType.Next: return ImeAction.Next;
+				case ReturnType.Go: return ImeAction.Go;
+				case ReturnType.Search: return ImeAction.Search;
+				case ReturnType.Send: return ImeAction.Send;
+				case ReturnType.Done: return ImeAction.Done;
+				case ReturnType.Default:
+				default: return ImeAction.Unspecified;
+			}
+		}
+#endif
+
+#if __IOS__
+		private static UIReturnKeyType GetReturnKeyTypeFromReturnType(ReturnType returnType)
+		{
+			switch (returnType)
+			{
+			    case ReturnType.Next: return UIReturnKeyType.Next;
+				case ReturnType.Go: return UIReturnKeyType.Go;
+				case ReturnType.Search: return UIReturnKeyType.Search;
+				case ReturnType.Send: return UIReturnKeyType.Send;
+				case ReturnType.Done: return UIReturnKeyType.Done;
+				case ReturnType.Default:
+				default: return UIReturnKeyType.Default;
+			}
+		}
+#endif
 	}
 }