[Issue-Resolver] Add ShowsCancelButton property to SearchBar and SearchHandler

src/Controls/src/Core/Compatibility/Handlers/Shell/iOS/SearchHandlerAppearanceTracker.cs

@@ -117,6 +117,10 @@ void SearchHandlerPropertyChanged(object sender, System.ComponentModel.PropertyC
 			{
 				UpdateSearchBarVerticalTextAlignment(_uiSearchBar.FindDescendantView<UITextField>());
 			}
+			else if (e.Is(SearchHandler.ShowsCancelButtonProperty))
+			{
+				UpdateShowsCancelButton();
+			}
 		}
 
 		void GetDefaultSearchBarColors(UISearchBar searchBar)
@@ -319,13 +323,29 @@ void UpdateKeyboard()
 			_uiSearchBar.ReloadInputViews();
 		}
 
+		void UpdateShowsCancelButton()
+		{
+			if (_searchHandler.IsFocused)
+			{
+				_uiSearchBar.SetShowsCancelButton(_searchHandler.ShowsCancelButton, true);
+			}
+		}
+
 		void OnEditingEnded(object sender, EventArgs e)
 		{
+			if (_searchHandler.ShowsCancelButton)
+			{
+				_uiSearchBar.SetShowsCancelButton(false, true);
+			}
 			_searchHandler.SetIsFocused(false);
 		}
 
 		void OnEditingStarted(object sender, EventArgs e)
 		{
+			if (_searchHandler.ShowsCancelButton)
+			{
+				_uiSearchBar.SetShowsCancelButton(true, true);
+			}
 			UpdateCancelButtonColor(_uiSearchBar.FindDescendantView<UIButton>());
 			_searchHandler.SetIsFocused(true);
 			//ElementController?.SetValueFromRenderer(VisualElement.IsFocusedPropertyKey, true);

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

@@ -1 +1,7 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -1,2 +1,8 @@
 #nullable enable
 ~override Microsoft.Maui.Controls.Platform.Compatibility.ShellFlyoutRenderer.ViewWillTransitionToSize(CoreGraphics.CGSize toSize, UIKit.IUIViewControllerTransitionCoordinator coordinator) -> void
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -1,2 +1,8 @@
 #nullable enable
 ~override Microsoft.Maui.Controls.Platform.Compatibility.ShellFlyoutRenderer.ViewWillTransitionToSize(CoreGraphics.CGSize toSize, UIKit.IUIViewControllerTransitionCoordinator coordinator) -> void
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -1 +1,7 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -1 +1,7 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -1 +1,7 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -1 +1,7 @@
 #nullable enable
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchBar.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchBar.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.get -> bool
+Microsoft.Maui.Controls.SearchHandler.ShowsCancelButton.set -> void
+~static readonly Microsoft.Maui.Controls.SearchHandler.ShowsCancelButtonProperty -> Microsoft.Maui.Controls.BindableProperty

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

@@ -33,6 +33,9 @@ public partial class SearchBar : InputView, ITextAlignmentElement, ISearchBarCon
 		/// <summary>Bindable property for <see cref="CancelButtonColor"/>.</summary>
 		public static readonly BindableProperty CancelButtonColorProperty = BindableProperty.Create(nameof(CancelButtonColor), typeof(Color), typeof(SearchBar), default(Color));
 
+		/// <summary>Bindable property for <see cref="ShowsCancelButton"/>.</summary>
+		public static readonly BindableProperty ShowsCancelButtonProperty = BindableProperty.Create(nameof(ShowsCancelButton), typeof(bool), typeof(SearchBar), true);
+
 		/// <summary>Bindable property for <see cref="SearchIconColor"/>.</summary>
 		public static readonly BindableProperty SearchIconColorProperty = BindableProperty.Create(nameof(SearchIconColor), typeof(Color), typeof(SearchBar), default(Color));
 
@@ -94,6 +97,20 @@ public Color CancelButtonColor
 			get { return (Color)GetValue(CancelButtonColorProperty); }
 			set { SetValue(CancelButtonColorProperty, value); }
 		}
+
+		/// <summary>
+		/// Gets or sets a value that indicates whether the cancel button is shown.
+		/// </summary>
+		/// <remarks>
+		/// On iOS, the cancel button appears when the search bar is focused and allows users to dismiss the keyboard.
+		/// Default value is <c>true</c>.
+		/// </remarks>
+		public bool ShowsCancelButton
+		{
+			get { return (bool)GetValue(ShowsCancelButtonProperty); }
+			set { SetValue(ShowsCancelButtonProperty, value); }
+		}
+
 		/// <summary>
 		/// Gets or sets the color of the search icon in the <see cref="SearchBar"/>.
 		/// </summary>

src/Controls/src/Core/Shell/SearchHandler.cs

@@ -157,6 +157,9 @@ public Color TextColor
 		/// <summary>Bindable property for <see cref="CancelButtonColor"/>.</summary>
 		public static readonly BindableProperty CancelButtonColorProperty = BindableProperty.Create(nameof(CancelButtonColor), typeof(Color), typeof(SearchHandler), default(Color));
 
+		/// <summary>Bindable property for <see cref="ShowsCancelButton"/>.</summary>
+		public static readonly BindableProperty ShowsCancelButtonProperty = BindableProperty.Create(nameof(ShowsCancelButton), typeof(bool), typeof(SearchHandler), true);
+
 		/// <summary>Bindable property for <see cref="FontFamily"/>.</summary>
 		public static readonly BindableProperty FontFamilyProperty = FontElement.FontFamilyProperty;
 
@@ -200,6 +203,19 @@ public Color CancelButtonColor
 			set { SetValue(CancelButtonColorProperty, value); }
 		}
 
+		/// <summary>
+		/// Gets or sets a value that indicates whether the cancel button is shown.
+		/// </summary>
+		/// <remarks>
+		/// On iOS, the cancel button appears when the search bar is focused and allows users to dismiss the keyboard.
+		/// Default value is <c>true</c>.
+		/// </remarks>
+		public bool ShowsCancelButton
+		{
+			get { return (bool)GetValue(ShowsCancelButtonProperty); }
+			set { SetValue(ShowsCancelButtonProperty, value); }
+		}
+
 
 		/// <include file="../../../docs/Microsoft.Maui.Controls/SearchHandler.xml" path="//Member[@MemberName='FontAttributes']/Docs/*" />
 		public FontAttributes FontAttributes

src/Controls/tests/TestCases.HostApp/Issues/Issue33008.xaml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+             x:Class="Maui.Controls.Sample.Issues.Issue33008"
+             Title="Issue 33008 - ShowsCancelButton">
+
+       <Shell.SearchHandler>
+              <SearchHandler Placeholder="Search..."
+                             AutomationId="SearchHandler"
+                             x:Name="SearchHandler"
+                             ShowsCancelButton="True"/>
+       </Shell.SearchHandler>
+
+       <ScrollView>
+              <VerticalStackLayout Padding="20"
+                                   Spacing="15">
+                     <Label Text="ShowsCancelButton Property Tests"
+                            FontSize="18"
+                            FontAttributes="Bold"
+                            AutomationId="TitleLabel"/>
+
+                     <!-- SearchBar Tests -->
+                     <Label Text="SearchBar Tests"
+                            FontSize="16"
+                            FontAttributes="Bold"
+                            Margin="0,10,0,0"/>
+
+                     <Label Text="1. Default (true):"
+                            FontAttributes="Bold"/>
+                     <SearchBar x:Name="SearchBarDefault"
+                                Placeholder="Default - shows cancel when typing"
+                                AutomationId="SearchBarDefault"/>
+
+                     <Label Text="2. ShowsCancelButton=True:"
+                            FontAttributes="Bold"/>
+                     <SearchBar x:Name="SearchBarTrue"
+                                Placeholder="True - shows cancel when typing"
+                                ShowsCancelButton="True"
+                                AutomationId="SearchBarTrue"/>
+
+                     <Label Text="3. ShowsCancelButton=False:"
+                            FontAttributes="Bold"/>
+                     <SearchBar x:Name="SearchBarFalse"
+                                Placeholder="False - NEVER shows cancel"
+                                ShowsCancelButton="False"
+                                AutomationId="SearchBarFalse"/>
+
+                     <Button Text="Set Text"
+                             Clicked="OnSetText"
+                             AutomationId="SetTextButton"/>
+
+                     <!-- Status -->
+                     <BoxView HeightRequest="2"
+                              Color="Gray"
+                              Margin="0,10,0,0"/>
+                     <Label Text="Status:"
+                            FontAttributes="Bold"/>
+                     <Label x:Name="StatusLabel"
+                            Text="Ready"
+                            AutomationId="StatusLabel"/>
+
+              </VerticalStackLayout>
+       </ScrollView>
+</ContentPage>

src/Controls/tests/TestCases.HostApp/Issues/Issue33008.xaml.cs

@@ -0,0 +1,27 @@
+namespace Maui.Controls.Sample.Issues;
+
+[Issue(IssueTracker.Github, 33008, "SearchBar and SearchHandler ShowsCancelButton property", PlatformAffected.iOS)]
+public class Issue33008Shell : Shell
+{
+	public Issue33008Shell()
+	{
+		Items.Add(new Issue33008());
+	}
+}
+
+public partial class Issue33008 : ContentPage
+{
+	public Issue33008()
+	{
+		InitializeComponent();
+	}
+
+	private void OnSetText(object sender, EventArgs e)
+	{
+		SearchBarDefault.Text = "Test text";
+		SearchBarTrue.Text = "Test text";
+		SearchBarFalse.Text = "Test text";
+		StatusLabel.Text = "Text set on all SearchBars";
+		SearchHandler.Query = "Test text";
+	}
+}

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue33008.cs

@@ -0,0 +1,29 @@
+using NUnit.Framework;
+using UITest.Appium;
+using UITest.Core;
+
+namespace Microsoft.Maui.TestCases.Tests.Issues;
+
+public class Issue33008 : _IssuesUITest
+{
+	public override string Issue => "SearchBar and SearchHandler ShowsCancelButton property";
+
+	public Issue33008(TestDevice device) : base(device) { }
+
+	[Test]
+	[Category(UITestCategories.SearchBar)]
+	public void SearchBarShowsCancelButtonWorks()
+	{
+		App.WaitForElement("TitleLabel");
+		App.Tap("SetTextButton");
+		App.EnterText("Search...", "Test text");
+
+		var status = App.FindElement("StatusLabel").GetText();
+		Assert.That(status, Does.Contain("Text set on all SearchBars"), "Should set text on all SearchBars");
+
+#if IOS || MACCATALYST
+		// Verify that the Cancel button is visible on SearchBars where ShowsCancelButton is true
+		VerifyScreenshot();
+#endif
+	}
+}

src/Core/src/Core/ISearchBar.cs

@@ -12,6 +12,11 @@ public interface ISearchBar : IView, ITextInput, ITextAlignment
 		/// </summary>
 		Color CancelButtonColor { get; }
 
+		/// <summary>
+		/// Gets a value indicating whether the cancel button should be displayed.
+		/// </summary>
+		bool ShowsCancelButton { get; }
+
 		/// <summary>
 		/// Gets the color of the Search icon.
 		/// </summary>

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

@@ -140,6 +140,12 @@ public static void MapCancelButtonColor(ISearchBarHandler handler, ISearchBar se
 			handler.PlatformView?.UpdateCancelButtonColor(searchBar);
 		}
 
+		public static void MapShowsCancelButton(ISearchBarHandler handler, ISearchBar searchBar)
+		{
+			// ShowsCancelButton is iOS-specific behavior
+			// Android SearchView doesn't have an equivalent cancel button
+		}
+
 		internal static void MapSearchIconColor(ISearchBarHandler handler, ISearchBar searchBar)
 		{
 			handler.PlatformView?.UpdateSearchIconColor(searchBar);

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 MapShowsCancelButton(IViewHandler handler, ISearchBar searchBar) { }
 		internal static void MapSearchIconColor(IViewHandler handler, ISearchBar searchBar) { }
 
 		/// <summary>

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

@@ -112,6 +112,11 @@ public static void MapCancelButtonColor(ISearchBarHandler handler, ISearchBar se
 			handler.PlatformView?.UpdateCancelButtonColor(searchBar);
 		}
 
+		public static void MapShowsCancelButton(ISearchBarHandler handler, ISearchBar searchBar)
+		{
+			// ShowsCancelButton is iOS-specific behavior
+		}
+
 		internal static void MapSearchIconColor(ISearchBarHandler handler, ISearchBar searchBar)
 		{
 			handler.PlatformView?.UpdateSearchIconColor(searchBar);

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

@@ -34,6 +34,7 @@ public partial class SearchBarHandler : ISearchBarHandler
 			[nameof(ISearchBar.Text)] = MapText,
 			[nameof(ISearchBar.TextColor)] = MapTextColor,
 			[nameof(ISearchBar.CancelButtonColor)] = MapCancelButtonColor,
+			[nameof(ISearchBar.ShowsCancelButton)] = MapShowsCancelButton,
 			[nameof(ISearchBar.SearchIconColor)] = MapSearchIconColor,
 			[nameof(ISearchBar.Keyboard)] = MapKeyboard,
 			[nameof(ISearchBar.ReturnType)] = MapReturnType,

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

@@ -141,6 +141,11 @@ public static void MapCancelButtonColor(ISearchBarHandler handler, ISearchBar se
 			handler.PlatformView?.UpdateCancelButton(searchBar);
 		}
 
+		public static void MapShowsCancelButton(ISearchBarHandler handler, ISearchBar searchBar)
+		{
+			handler.PlatformView?.UpdateCancelButton(searchBar);
+		}
+
 		internal static void MapSearchIconColor(ISearchBarHandler handler, ISearchBar searchBar)
 		{
 			handler.PlatformView?.UpdateSearchIcon(searchBar);

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

@@ -117,10 +117,12 @@ public static void UpdateIsReadOnly(this UISearchBar uiSearchBar, ISearchBar sea
 		}
 
 		internal static bool ShouldShowCancelButton(this ISearchBar searchBar) =>
-			!string.IsNullOrEmpty(searchBar.Text);
+			searchBar.ShowsCancelButton && !string.IsNullOrEmpty(searchBar.Text);
 
 		public static void UpdateCancelButton(this UISearchBar uiSearchBar, ISearchBar searchBar)
 		{
+			// Respect the ShowsCancelButton property - if false, never show the button
+			// If true, show it based on whether there's text (iOS standard behavior)
 			uiSearchBar.ShowsCancelButton = searchBar.ShouldShowCancelButton();
 
 			// We can't cache the cancel button reference because iOS drops it when it's not displayed

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

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

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

@@ -1,2 +1,4 @@
 #nullable enable
 override Microsoft.Maui.Platform.MauiView.DidUpdateFocus(UIKit.UIFocusUpdateContext! context, UIKit.UIFocusAnimationCoordinator! coordinator) -> void
+Microsoft.Maui.ISearchBar.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

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

@@ -1,2 +1,4 @@
 #nullable enable
 override Microsoft.Maui.Platform.MauiView.DidUpdateFocus(UIKit.UIFocusUpdateContext! context, UIKit.UIFocusAnimationCoordinator! coordinator) -> void
+Microsoft.Maui.ISearchBar.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

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

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

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

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(Microsoft.Maui.Handlers.ISearchBarHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void

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

@@ -1 +1,3 @@
 #nullable enable
+Microsoft.Maui.ISearchBar.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(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.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(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.ShowsCancelButton.get -> bool
+static Microsoft.Maui.Handlers.SearchBarHandler.MapShowsCancelButton(Microsoft.Maui.IViewHandler! handler, Microsoft.Maui.ISearchBar! searchBar) -> void