[Improvement] Add ReturnType API for SearchBar

src/Controls/src/Core/PublicAPI/net-android/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/PublicAPI/net-ios/PublicAPI.Unshipped.txt

@@ -1,2 +1,5 @@
 #nullable enable
 override Microsoft.Maui.Controls.Handlers.Compatibility.FrameRenderer.MovedToWindow() -> void
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt

@@ -1,2 +1,5 @@
 #nullable enable
-override Microsoft.Maui.Controls.Handlers.Compatibility.FrameRenderer.MovedToWindow() -> void
+override Microsoft.Maui.Controls.Handlers.Compatibility.FrameRenderer.MovedToWindow() -> void
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/PublicAPI/net-tizen/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/PublicAPI/net-windows/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/PublicAPI/net/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/PublicAPI/netstandard/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+Microsoft.Maui.Controls.SearchBar.ReturnType.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ReturnTypeProperty -> Microsoft.Maui.Controls.BindableProperty

src/Controls/src/Core/SearchBar/SearchBar.cs

@@ -10,6 +10,10 @@ namespace Microsoft.Maui.Controls
 	/// <include file="../../docs/Microsoft.Maui.Controls/SearchBar.xml" path="Type[@FullName='Microsoft.Maui.Controls.SearchBar']/Docs/*" />
 	public partial class SearchBar : InputView, ITextAlignmentElement, ISearchBarController, IElementConfiguration<SearchBar>, ICommandElement, ISearchBar
 	{
+		/// <summary>Bindable property for <see cref="ReturnType"/>.</summary>
+		public static readonly BindableProperty ReturnTypeProperty = BindableProperty.Create(
+			nameof(ReturnType), typeof(ReturnType), typeof(SearchBar), ReturnType.Search);
+
 		/// <summary>Bindable property for <see cref="SearchCommand"/>.</summary>
 		public static readonly BindableProperty SearchCommandProperty = BindableProperty.Create(
 			nameof(SearchCommand), typeof(ICommand), typeof(SearchBar), null,
@@ -69,6 +73,13 @@ public partial class SearchBar : InputView, ITextAlignmentElement, ISearchBarCon
 
 		readonly Lazy<PlatformConfigurationRegistry<SearchBar>> _platformConfigurationRegistry;
 
+		/// <include file="../../docs/Microsoft.Maui.Controls/SearchBar.xml" path="//Member[@MemberName='ReturnType']/Docs/*" />
+		public ReturnType ReturnType
+		{
+			get => (ReturnType)GetValue(ReturnTypeProperty);
+			set => SetValue(ReturnTypeProperty, value);
+		}
+
 		/// <include file="../../docs/Microsoft.Maui.Controls/SearchBar.xml" path="//Member[@MemberName='CancelButtonColor']/Docs/*" />
 		public Color CancelButtonColor
 		{

src/Core/src/Core/ISearchBar.cs

@@ -12,6 +12,11 @@ public interface ISearchBar : IView, ITextInput, ITextAlignment
 		/// </summary>
 		Color CancelButtonColor { get; }
 
+		/// <summary>
+		/// Gets an enumeration value that controls the appearance of the return button.
+		/// </summary>
+		ReturnType ReturnType { get; }
+
 		/// <summary>
 		/// Notify when the user presses the Search button.
 		/// </summary>

src/Core/src/Handlers/SearchBar/SearchBarHandler.Android.cs

@@ -132,6 +132,11 @@ public static void MapFocus(ISearchBarHandler handler, ISearchBar searchBar, obj
 				handler.QueryEditor?.Focus(request);
 		}
 
+		public static void MapReturnType(ISearchBarHandler handler, ISearchBar entry)
+		{
+			handler.PlatformView?.UpdateReturnType(entry);
+		}
+
 		void OnQueryTextSubmit(object? sender, QueryTextSubmitEventArgs e)
 		{
 			VirtualView.SearchButtonPressed();

src/Core/src/Handlers/SearchBar/SearchBarHandler.Standard.cs

@@ -19,6 +19,7 @@ public static void MapVerticalTextAlignment(IViewHandler handler, ISearchBar sea
 		public static void MapCharacterSpacing(IViewHandler handler, ISearchBar searchBar) { }
 		public static void MapTextColor(IViewHandler handler, ISearchBar searchBar) { }
 		public static void MapCancelButtonColor(IViewHandler handler, ISearchBar searchBar) { }
+		public static void MapReturnType(IViewHandler handler, ISearchBar searchBar) { }
 
 		/// <summary>
 		/// Maps the abstract <see cref="ITextInput.IsTextPredictionEnabled"/> property to the platform-specific implementations.

src/Core/src/Handlers/SearchBar/SearchBarHandler.Tizen.cs

@@ -65,6 +65,11 @@ public static void MapMaxLength(ISearchBarHandler handler, ISearchBar searchBar)
 			handler.PlatformView?.Entry.UpdateMaxLength(searchBar);
 		}
 
+		public static void MapReturnType(ISearchBarHandler handler, ISearchBar searchBar)
+		{
+			handler.PlatformView?.Entry.UpdateReturnType(searchBar);
+		}
+
 		public static void MapIsReadOnly(ISearchBarHandler handler, ISearchBar searchBar)
 		{
 			handler.PlatformView?.Entry.UpdateIsReadOnly(searchBar);

src/Core/src/Handlers/SearchBar/SearchBarHandler.Windows.cs

@@ -57,6 +57,11 @@ public static void MapPlaceholderColor(ISearchBarHandler handler, ISearchBar sea
 			handler.PlatformView?.UpdatePlaceholderColor(searchBar);
 		}
 
+		public static void MapReturnType(ISearchBarHandler handler, ISearchBar searchBar)
+		{
+			handler.PlatformView?.UpdateReturnType(searchBar);
+		}
+
 		public static void MapHorizontalTextAlignment(ISearchBarHandler handler, ISearchBar searchBar)
 		{
 			handler.PlatformView?.UpdateHorizontalTextAlignment(searchBar);

src/Core/src/Handlers/SearchBar/SearchBarHandler.cs

@@ -34,7 +34,8 @@ public partial class SearchBarHandler : ISearchBarHandler
 			[nameof(ISearchBar.Text)] = MapText,
 			[nameof(ISearchBar.TextColor)] = MapTextColor,
 			[nameof(ISearchBar.CancelButtonColor)] = MapCancelButtonColor,
-			[nameof(ISearchBar.Keyboard)] = MapKeyboard
+			[nameof(ISearchBar.Keyboard)] = MapKeyboard,
+			[nameof(ISearchBar.ReturnType)] = MapReturnType,
 		};
 
 		public static CommandMapper<ISearchBar, ISearchBarHandler> CommandMapper = new(ViewCommandMapper)

src/Core/src/Handlers/SearchBar/SearchBarHandler.iOS.cs

@@ -82,6 +82,11 @@ public static void MapFont(ISearchBarHandler handler, ISearchBar searchBar)
 			handler.QueryEditor?.UpdateFont(searchBar, fontManager);
 		}
 
+		public static void MapReturnType(ISearchBarHandler handler, ISearchBar searchBar)
+		{
+			handler.PlatformView?.UpdateReturnType(searchBar);
+		}
+
 		public static void MapHorizontalTextAlignment(ISearchBarHandler handler, ISearchBar searchBar)
 		{
 			handler.QueryEditor?.UpdateHorizontalTextAlignment(searchBar);

src/Core/src/Platform/Android/SearchViewExtensions.cs

@@ -1,5 +1,7 @@
-using Android.Content.Res;
+using Android.Content;
+using Android.Content.Res;
 using Android.Text;
+using Android.Views.InputMethods;
 using Android.Widget;
 using SearchView = AndroidX.AppCompat.Widget.SearchView;
 
@@ -162,6 +164,14 @@ public static void UpdateKeyboard(this SearchView searchView, ISearchBar searchB
 			searchView.SetInputType(searchBar);
 		}
 
+		public static void UpdateReturnType(this SearchView searchView, ISearchBar searchBar)
+		{
+			searchView.ImeOptions = (int)searchBar.ReturnType.ToPlatform();
+
+			InputMethodManager? imm = (InputMethodManager?)searchView.Context?.GetSystemService(Context.InputMethodService);
+			imm?.RestartInput(searchView);
+		}
+
 		internal static void SetInputType(this SearchView searchView, ISearchBar searchBar, EditText? editText = null)
 		{
 			editText ??= searchView.GetFirstChildOfType<EditText>();

src/Core/src/Platform/Tizen/EntryExtensions.cs

@@ -42,6 +42,11 @@ public static void UpdateReturnType(this Entry platformEntry, IEntry entry)
 			platformEntry.ReturnType = entry.ReturnType.ToPlatform();
 		}
 
+		public static void UpdateReturnType(this Entry platformEntry, ISearchBar searchBar)
+		{
+			platformEntry.ReturnType = searchBar.ReturnType.ToPlatform();
+		}
+
 		public static void UpdateFont(this Entry platformEntry, ITextStyle textStyle, IFontManager fontManager)
 		{
 			platformEntry.FontSize = textStyle.Font.Size > 0 ? textStyle.Font.Size.ToScaledPoint() : 25d.ToScaledPoint();

src/Core/src/Platform/Windows/SearchBarExtensions.cs

@@ -49,6 +49,11 @@ public static void UpdatePlaceholderColor(this AutoSuggestBox platformControl, I
 				searchBar.PlaceholderColor?.ToPlatform());
 		}
 
+		public static void UpdateReturnType(this AutoSuggestBox platformControl, ISearchBar searchBar)
+		{
+			platformControl.UpdateKeyboard(searchBar);
+		}
+
 		public static void UpdateText(this AutoSuggestBox platformControl, ISearchBar searchBar)
 		{
 			platformControl.Text = searchBar.Text;

src/Core/src/Platform/iOS/SearchBarExtensions.cs

@@ -186,5 +186,10 @@ public static void UpdateKeyboard(this UISearchBar uiSearchBar, ISearchBar searc
 
 			uiSearchBar.ReloadInputViews();
 		}
+
+		public static void UpdateReturnType(this UISearchBar uiSearchBar, ISearchBar searchBar)
+		{
+			uiSearchBar.ReturnKeyType = searchBar.ReturnType.ToPlatform();
+		}
 	}
 }

src/Core/src/PublicAPI/net-android/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! entry) -> void
+static Microsoft.Maui.Platform.SearchViewExtensions.UpdateReturnType(this AndroidX.AppCompat.Widget.SearchView! searchView, Microsoft.Maui.ISearchBar! searchBar) -> void
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType

src/Core/src/PublicAPI/net-ios/PublicAPI.Unshipped.txt

@@ -1,3 +1,6 @@
 #nullable enable
 override Microsoft.Maui.Platform.MauiCALayer.AddAnimation(CoreAnimation.CAAnimation! animation, string? key) -> void
-*REMOVED*override Microsoft.Maui.Handlers.BorderHandler.ConnectHandler(Microsoft.Maui.Platform.ContentView! platformView) -> void
+*REMOVED*override Microsoft.Maui.Handlers.BorderHandler.ConnectHandler(Microsoft.Maui.Platform.ContentView! platformView) -> void
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void
+static Microsoft.Maui.Platform.SearchBarExtensions.UpdateReturnType(this UIKit.UISearchBar! uiSearchBar, Microsoft.Maui.ISearchBar! searchBar) -> void
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType

src/Core/src/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt

@@ -1,3 +1,6 @@
 #nullable enable
 override Microsoft.Maui.Platform.MauiCALayer.AddAnimation(CoreAnimation.CAAnimation! animation, string? key) -> void
 *REMOVED*override Microsoft.Maui.Handlers.BorderHandler.ConnectHandler(Microsoft.Maui.Platform.ContentView! platformView) -> void
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void
+static Microsoft.Maui.Platform.SearchBarExtensions.UpdateReturnType(this UIKit.UISearchBar! uiSearchBar, Microsoft.Maui.ISearchBar! searchBar) -> void
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType

src/Core/src/PublicAPI/net-tizen/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void
+static Microsoft.Maui.Platform.EntryExtensions.UpdateReturnType(this Tizen.UIExtensions.NUI.Entry! platformEntry, Microsoft.Maui.ISearchBar! searchBar) -> void
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType

src/Core/src/PublicAPI/net-windows/PublicAPI.Unshipped.txt

@@ -1 +1,4 @@
 #nullable enable
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void
+static Microsoft.Maui.Platform.SearchBarExtensions.UpdateReturnType(this Microsoft.UI.Xaml.Controls.AutoSuggestBox! platformControl, Microsoft.Maui.ISearchBar! searchBar) -> void
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType

src/Core/src/PublicAPI/net/PublicAPI.Unshipped.txt

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.IViewHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

src/Core/src/PublicAPI/netstandard/PublicAPI.Unshipped.txt

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.IViewHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

src/Core/src/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ReturnType.get -> Microsoft.Maui.ReturnType
+static Microsoft.Maui.Handlers.SearchBarHandler.MapReturnType(Microsoft.Maui.IViewHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

src/Core/tests/DeviceTests/Handlers/SearchBar/SearchBarHandlerTests.Android.cs

@@ -3,7 +3,9 @@
 using System.Threading.Tasks;
 using Android.Text;
 using Android.Text.Method;
+using Android.Views.InputMethods;
 using Android.Widget;
+using AndroidX.AppCompat.Widget;
 using Microsoft.Maui.DeviceTests.Stubs;
 using Xunit;
 using AColor = Android.Graphics.Color;
@@ -103,6 +105,31 @@ public async Task CharacterSpacingInitializesCorrectly()
 			Assert.Equal(expectedValue, values.PlatformViewValue, EmCoefficientPrecision);
 		}
 
+		[Fact(DisplayName = "ReturnType Initializes Correctly")]
+		public async Task ReturnTypeInitializesCorrectly()
+		{
+			var xplatReturnType = ReturnType.Next;
+			var entry = new SearchBarStub()
+			{
+				Text = "Test",
+				ReturnType = xplatReturnType
+			};
+
+			ImeAction expectedValue = ImeAction.Next;
+
+			var values = await GetValueAsync(entry, (handler) =>
+			{
+				return new
+				{
+					ViewValue = entry.ReturnType,
+					PlatformViewValue = GetNativeReturnType(handler)
+				};
+			});
+
+			Assert.Equal(xplatReturnType, values.ViewValue);
+			Assert.Equal(expectedValue, values.PlatformViewValue);
+		}
+
 		[Fact]
 		public async Task SearchViewHasEditTextChild()
 		{
@@ -145,14 +172,16 @@ await layoutHandler.PlatformView.AttachAndRun(() =>
 			});
 		}
 
+		ImeAction GetNativeReturnType(SearchBarHandler searchBarHandler) =>
+			(ImeAction)GetNativeSearchBar(searchBarHandler).ImeOptions;
+
 		double GetInputFieldHeight(SearchBarHandler searchBarHandler)
 		{
 			var control = GetNativeSearchBar(searchBarHandler);
 			var editText = control.GetChildrenOfType<EditText>().FirstOrDefault();
 			return MauiContext.Context.FromPixels((double)editText.MeasuredHeight);
 		}
 
-
 		static SearchView GetNativeSearchBar(SearchBarHandler searchBarHandler) =>
 			searchBarHandler.PlatformView;
 

src/Core/tests/DeviceTests/Handlers/SearchBar/SearchBarHandlerTests.iOS.cs

@@ -132,11 +132,39 @@ public async Task CharacterSpacingInitializesCorrectly()
 			Assert.Equal(xplatCharacterSpacing, values.PlatformViewValue);
 		}
 
+		[Fact(DisplayName = "ReturnType Initializes Correctly")]
+		public async Task ReturnTypeInitializesCorrectly()
+		{
+			var xplatReturnType = ReturnType.Next;
+			var entry = new SearchBarStub()
+			{
+				Text = "Test",
+				ReturnType = xplatReturnType
+			};
+
+			UIReturnKeyType expectedValue = UIReturnKeyType.Next;
+
+			var values = await GetValueAsync(entry, (handler) =>
+			{
+				return new
+				{
+					ViewValue = entry.ReturnType,
+					PlatformViewValue = GetNativeReturnType(handler)
+				};
+			});
+
+			Assert.Equal(xplatReturnType, values.ViewValue);
+			Assert.Equal(expectedValue, values.PlatformViewValue);
+		}
+
 		double GetInputFieldHeight(SearchBarHandler searchBarHandler)
 		{
 			return GetNativeSearchBar(searchBarHandler).Bounds.Height;
 		}
 
+		UIReturnKeyType GetNativeReturnType(SearchBarHandler searchBarHandler) => 
+			GetNativeSearchBar(searchBarHandler).ReturnKeyType;
+
 		static UISearchBar GetNativeSearchBar(SearchBarHandler searchBarHandler) =>
 			(UISearchBar)searchBarHandler.PlatformView;
 

src/Core/tests/DeviceTests/Stubs/SearchBarStub.cs

@@ -49,6 +49,8 @@ void OnTextChanged(string oldValue, string newValue) =>
 
 		public Keyboard Keyboard { get; set; }
 
+		public ReturnType ReturnType { get; set; }
+
 		public void SearchButtonPressed() { }
 	}
 }