feat!: switch InputExtensions.ReturnType to InputReturnType

BREAKING CHANGE: Uno dependency has been bumped to 6.0 and the InputExtensions.ReturnType has been changed to InputReturnType.

Author: Kunal22shah

doc/helpers/Input-extensions.md

@@ -13,7 +13,7 @@ Provides various attached properties for _input controls_, such as `TextBox` and
 | `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 type of return button on a soft keyboard for Android/iOS. It can be one of the following options: __Default, Done, Go, Next, Search, Send__.  |
+| `ReturnType`           | `InputReturnType` | The type of return button on a soft keyboard for Android/iOS. It can be one of the following options: __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 precedence over `AutoFocusNext` when both are set.
 

doc/toc.yml

@@ -1,6 +1,8 @@
 # ******************* Overview *******************
 - name: Overview
   href: getting-started.md
+- name: Upgrading Toolkit
+  href: Toolkit.Migration.md
   items:
   # ***************** Material *******************
   - name: Material

doc/uno-toolkit-migration.md

@@ -0,0 +1,22 @@
+---
+uid: Toolkit.Migration
+---
+
+# Upgrading Uno Toolkit
+
+## Upgrading to Uno Toolkit 7.1
+
+1. Switch from `ReturnType` to `InputReturnType`
+
+    Version 7.1 of `Uno.Toolkit` now requires `Uno.UI v6.0`. The `InputExtensions` helper has been updated to use the built-in `InputReturnType` enum (provided by Uno.UI v6+) instead of the legacy `ReturnType` enum.
+
+    ```csharp
+    // No code changes required in XAML, but under the hood
+    // the attached property now uses InputReturnType:
+    public static DependencyProperty ReturnTypeProperty =
+        DependencyProperty.RegisterAttached(
+            "ReturnType",
+            typeof(InputReturnType),
+            typeof(InputExtensions),
+            new PropertyMetadata(InputReturnType.Default, OnReturnTypeChanged));
+    ```

src/Directory.Packages.props

@@ -23,7 +23,7 @@
     <PackageVersion Include="Uno.Material" Version="5.0.13" />
     <PackageVersion Include="Uno.Material.WinUI" Version="5.0.13" />
     <PackageVersion Include="Uno.UI" Version="5.4.22" />
-    <PackageVersion Include="Uno.WinUI" Version="5.4.22" />
+    <PackageVersion Include="Uno.WinUI" Version="6.0.465" />
     <PackageVersion Include="Uno.XamlMerge.Task" Version="1.32.0-dev.61" />
     <PackageVersion Include="FluentAssertions" Version="5.10.3" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />

src/Uno.Toolkit.UI/Behaviors/InputExtensions.cs

@@ -11,10 +11,8 @@
 using Windows.System;
 using Windows.UI.ViewManagement;
 
-#if __ANDROID__
-using Android.Views.InputMethods;
-#elif __IOS__
-using UIKit;
+#if HAS_UNO_WINUI
+using Uno.UI.Xaml.Controls;
 #endif
 
 #if IS_WINUI
@@ -27,43 +25,62 @@
 using Windows.UI.Xaml.Input;
 #endif
 
+#if !HAS_UNO_WINUI
+namespace Uno.Toolkit.UI
+{
+
+	// Dummy enum for Uno.UI v5 so ReturnType DP compiles as InputReturnType is available for v6+.
+	public enum InputReturnType
+	{
+		Default,
+		Done,
+		Go,
+		Next,
+		Search,
+		Send
+	}
+}
+#endif
+
 namespace Uno.Toolkit.UI
 {
 	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));
+				"ReturnType",
+				typeof(InputReturnType),
+				typeof(InputExtensions),
+				new PropertyMetadata(InputReturnType.Default, OnReturnTypeChanged));
 
 		[DynamicDependency(nameof(SetReturnType))]
-		public static ReturnType GetReturnType(DependencyObject obj) => (ReturnType)obj.GetValue(ReturnTypeProperty);
+		public static InputReturnType GetReturnType(DependencyObject obj) => (InputReturnType)obj.GetValue(ReturnTypeProperty);
 		[DynamicDependency(nameof(GetReturnType))]
-		public static void SetReturnType(DependencyObject obj, ReturnType value) => obj.SetValue(ReturnTypeProperty, value);
+		public static void SetReturnType(DependencyObject obj, InputReturnType value) => obj.SetValue(ReturnTypeProperty, value);
 
 		#endregion
+
+		private static void OnReturnTypeChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
+		{
+#if HAS_UNO_WINUI
+			if (sender is TextBox || sender is PasswordBox)
+			{
+				TextBoxExtensions.SetInputReturnType(sender, (InputReturnType)e.NewValue);
+			}
+#endif
+		}
+
 		#region DependencyProperty: AutoDismiss
 
-		/// <summary>
-		/// Backing property for whether the soft keyboard will be dismissed when the enter key is pressed.
-		/// </summary>
+			/// <summary>
+			/// Backing property for whether the soft keyboard will be dismissed when the enter key is pressed.
+			/// </summary>
 		public static DependencyProperty AutoDismissProperty { [DynamicDependency(nameof(GetAutoDismiss))] get; } = DependencyProperty.RegisterAttached(
 			"AutoDismiss",
 			typeof(bool),
@@ -141,44 +158,14 @@ internal static bool IsEnterCommandSupportedFor(DependencyObject host)
 			return host is TextBox || host is PasswordBox;
 		}
 
-		private static void OnReturnTypeChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
-		{
-			if (sender is TextBox || sender is PasswordBox)
-			{
-				if (e.NewValue is not ReturnType returnType)
-				{
-					returnType = ReturnType.Default;
-				}
-#if __ANDROID__
-				ImeAction imeAction = GetImeActionFromReturnType(returnType);
-
-				if (sender is TextBox textBox)
-				{
-					textBox.ImeOptions = imeAction;
-				}
-				else if (sender is PasswordBox passwordBox)
-				{
-					passwordBox.ImeOptions = imeAction;
-				}
-#elif __IOS__
-				UIReturnKeyType returnKeyType = GetReturnKeyTypeFromReturnType(returnType);
-
-				if (sender is TextBox textBox)
-				{
-					textBox.ReturnKeyType = returnKeyType;
-				}
-				else if (sender 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);
-		internal static void OnEnterCommandChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) => UpdateSubscription(sender);
+		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);
+		internal static void OnEnterCommandChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
+			=> UpdateSubscription(sender);
 
 		private static void UpdateSubscription(DependencyObject sender)
 		{
@@ -243,29 +230,5 @@ private static void OnUIElementKeyUp(object sender, KeyRoutedEventArgs e)
 				_ => default,
 			};
 		}
-
-#if __ANDROID__
-		private static ImeAction GetImeActionFromReturnType(ReturnType returnType) => returnType switch
-		{
-			ReturnType.Next => ImeAction.Next,
-			ReturnType.Go => ImeAction.Go,
-			ReturnType.Search => ImeAction.Search,
-			ReturnType.Send => ImeAction.Send,
-			ReturnType.Done => ImeAction.Done,
-			ReturnType.Default or _ => ImeAction.Unspecified
-		};
-#endif
-
-#if __IOS__
-		private static UIReturnKeyType GetReturnKeyTypeFromReturnType(ReturnType returnType) => returnType switch
-		{
-			ReturnType.Next => UIReturnKeyType.Next,
-			ReturnType.Go => UIReturnKeyType.Go,
-			ReturnType.Search => UIReturnKeyType.Search,
-			ReturnType.Send => UIReturnKeyType.Send,
-			ReturnType.Done => UIReturnKeyType.Done,
-			ReturnType.Default or _ => UIReturnKeyType.Default
-		};
-#endif
 	}
 }

src/Uno.Toolkit.UI/Controls/ExtendedSplashScreen/ExtendedSplashScreen.cs

@@ -58,7 +58,7 @@ internal object SplashScreenContent
 	protected static ExtendedSplashScreen? Instance { get; private set; }
 
 	public
-#if __IOS__ || __MACOS__ // hides UIView.Window and NSView.Window
+#if __IOS__ || __MACOS__ && !HAS_UNO_WINUI // hides UIView.Window and NSView.Window
 	new
 #endif
 Window? Window