[Windows] Fix SearchHandler does not focus when ShowSoftInputAsync is called by praveenkumarkarunanithi · Pull Request #35079 · dotnet/maui

praveenkumarkarunanithi · 2026-04-22T08:34:32Z

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue.
Thank you!

Root Cause

PR #29600 added ShowSoftInputRequested and HideSoftInputRequested event handling for Android and iOS via their respective SearchHandlerAppearanceTracker implementations.

However, Windows uses ShellItemHandler.Windows.cs, which was not updated to handle these events. As a result, although the events are raised by SearchHandler.ShowSoftInputAsync(), there are no subscribers on Windows, leading to no action.

Description of Change

Extended support for ShowSoftInputAsync() / HideSoftInputAsync() to Windows by wiring the corresponding events in ShellItemHandler.Windows.cs.

Event subscriptions are handled in UpdateSearchHandler when a handler is assigned, and are properly cleaned up when the handler is replaced or during DisconnectHandler.

Since Windows does not use an on-screen keyboard, the implementation focuses on focus management. Focus is applied using autoSuggestBox.Focus(FocusState.Programmatic), aligning with standard WinUI behavior. Unfocus is handled using the existing IsEnabled toggle pattern (consistent with ViewExtensions.UnfocusControl), with proper preservation of IsTabStop.

A safety guard is included to ensure that disabled controls are not unintentionally re-enabled during the unfocus process.

Issues Fixed

Fixes #34930

Tested the behaviour in the following platforms

Android
Windows
iOS
Mac

Screenshots

Before Issue Fix	After Issue Fix

github-actions · 2026-04-22T08:34:42Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.sh | bash -s -- 35079

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.ps1) } 35079"

Copilot

Pull request overview

Adds Windows support for SearchHandler.ShowSoftInputAsync() / HideSoftInputAsync() by wiring the corresponding internal events in the Windows ShellItemHandler, and introduces a UI test + HostApp repro page to validate focus behavior.

Changes:

Subscribe/unsubscribe to ShowSoftInputRequested / HideSoftInputRequested in ShellItemHandler.Windows.cs and implement focus/unfocus behavior via the AutoSuggestBox.
Add HostApp issue page Issue34930 with buttons and labels to exercise/observe focus behavior.
Add Appium/NUnit UI test Issue34930 to validate focus occurs after invoking ShowSoftInputAsync().

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

File	Description
src/Controls/src/Core/Handlers/Shell/ShellItemHandler.Windows.cs	Wires `ShowSoftInputRequested`/`HideSoftInputRequested` to focus/unfocus the underlying `AutoSuggestBox` on Windows.
src/Controls/tests/TestCases.HostApp/Issues/Issue34930.cs	Adds a HostApp repro page that triggers Show/Hide soft-input requests and displays focus state.
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue34930.cs	Adds a UI test which taps the button and asserts focus state/event indicators.

Copilot · 2026-04-22T10:44:11Z

+			var focusedEvent = App.WaitForElement("focusedEventLabel").GetText();
+			Assert.That(focusedEvent, Is.EqualTo("FocusedEvent: True"));


Same timing issue as above: focusedEventLabel exists from the start, so WaitForElement doesn't wait for its text to change. Consider waiting for the label text to become FocusedEvent: True before asserting to avoid race conditions.

Copilot · 2026-04-22T10:44:12Z

+		}
+
+		[Test]
+		[Category(UITestCategories.SearchBar)]


This test is exercising the ShowSoftInputAsync/HideSoftInputAsync behavior; UITestCategories.SoftInput (or Shell) looks like a better fit than SearchBar and is already used for other soft-input tests. Using the more specific category helps CI categorization and targeted runs.

Suggested change

[Category(UITestCategories.SearchBar)]

[Category(UITestCategories.SoftInput)]

Copilot · 2026-04-22T10:44:12Z

+		public void SearchHandlerShowSoftInputShouldFocusSearchHandlerOnWindows()
+		{
+			App.WaitForElement("ShowKeyboardButton");
+			App.Tap("ShowKeyboardButton");
+


The PR wires up both Show/Hide soft-input requests on Windows, but this test only validates the "show" path. To prevent regressions in the new HideSoftInputRequested wiring, consider extending the test to tap the hide button and assert focus is cleared (e.g., IsFocused: False and/or an unfocused indicator).

Copilot · 2026-04-22T10:44:12Z

+			showKeyboardButton.Clicked += async (s, e) =>
+			{
+				searchHandler.ShowSoftInputAsync();
+				await Task.Delay(200);
+				isFocusedLabel.Text = $"IsFocused: {searchHandler.IsFocused}";


The Task.Delay(200) here is a fixed timing guess to wait for focus to propagate, which can be flaky across devices/CI load. Prefer updating isFocusedLabel in response to searchHandler.Focused/Unfocused (or another deterministic signal) so the UI and the UITest can wait on state instead of time.

Copilot · 2026-04-22T10:44:12Z

+				AutomationId = "isFocusedLabel"
+			};
+
+			var focusedEventLabel = new Label
+			{
+				Text = "FocusedEvent: False",
+				AutomationId = "focusedEventLabel"
+			};
+
+			var searchHandler = new SearchHandler
+			{
+				AutomationId = "searchHandler",


AutomationId values in this file are mostly PascalCase (e.g., ShowKeyboardButton), but isFocusedLabel is lower camelCase. Consider using a consistent naming style for AutomationIds to make tests easier to read and maintain.

Suggested change

AutomationId = "isFocusedLabel"

};

var focusedEventLabel = new Label

{

Text = "FocusedEvent: False",

AutomationId = "focusedEventLabel"

};

var searchHandler = new SearchHandler

{

AutomationId = "searchHandler",

AutomationId = "IsFocusedLabel"

};

var focusedEventLabel = new Label

{

Text = "FocusedEvent: False",

AutomationId = "FocusedEventLabel"

};

var searchHandler = new SearchHandler

{

AutomationId = "SearchHandler",

Copilot · 2026-04-22T10:44:13Z

+				AutomationId = "isFocusedLabel"
+			};
+
+			var focusedEventLabel = new Label
+			{
+				Text = "FocusedEvent: False",
+				AutomationId = "focusedEventLabel"
+			};
+
+			var searchHandler = new SearchHandler
+			{
+				AutomationId = "searchHandler",


AutomationId is lower camelCase here (focusedEventLabel) while other IDs in the page use PascalCase (e.g., ShowKeyboardButton). Aligning on one style for AutomationIds improves consistency across HostApp issue pages and UI tests.

Suggested change

AutomationId = "isFocusedLabel"

};

var focusedEventLabel = new Label

{

Text = "FocusedEvent: False",

AutomationId = "focusedEventLabel"

};

var searchHandler = new SearchHandler

{

AutomationId = "searchHandler",

AutomationId = "IsFocusedLabel"

};

var focusedEventLabel = new Label

{

Text = "FocusedEvent: False",

AutomationId = "FocusedEventLabel"

};

var searchHandler = new SearchHandler

{

AutomationId = "SearchHandler",

Copilot · 2026-04-22T10:44:14Z

+				AutomationId = "isFocusedLabel"
+			};
+
+			var focusedEventLabel = new Label
+			{
+				Text = "FocusedEvent: False",
+				AutomationId = "focusedEventLabel"
+			};
+
+			var searchHandler = new SearchHandler
+			{
+				AutomationId = "searchHandler",


AutomationId = "searchHandler" is lower camelCase while other AutomationIds in the page use PascalCase. Consider renaming for consistency (and update the corresponding UITest IDs if it becomes referenced there).

Suggested change

AutomationId = "isFocusedLabel"

};

var focusedEventLabel = new Label

{

Text = "FocusedEvent: False",

AutomationId = "focusedEventLabel"

};

var searchHandler = new SearchHandler

{

AutomationId = "searchHandler",

AutomationId = "IsFocusedLabel"

};

var focusedEventLabel = new Label

{

Text = "FocusedEvent: False",

AutomationId = "FocusedEventLabel"

};

var searchHandler = new SearchHandler

{

AutomationId = "SearchHandler",

Copilot · 2026-04-22T10:44:14Z

+
+			var isFocused = App.WaitForElement("isFocusedLabel").GetText();
+			Assert.That(isFocused, Is.EqualTo("IsFocused: True"));
+


The test reads isFocusedLabel text immediately after tapping the button. Since the label exists before the tap, WaitForElement doesn't guarantee the text has updated yet, which can make this assertion flaky. Prefer waiting for the expected text (e.g., via WaitForTextToBePresentInElement) before asserting.

Suggested change

var isFocused = App.WaitForElement("isFocusedLabel").GetText();

Assert.That(isFocused, Is.EqualTo("IsFocused: True"));

App.WaitForTextToBePresentInElement("isFocusedLabel", "IsFocused: True");

var isFocused = App.WaitForElement("isFocusedLabel").GetText();

Assert.That(isFocused, Is.EqualTo("IsFocused: True"));

App.WaitForTextToBePresentInElement("focusedEventLabel", "FocusedEvent: True");

kubaflo

Could you please review the ai's summary and verify the failing tests?

kubaflo

Could you please check the ai's summary?

MauiBot · 2026-05-02T23:48:13Z

⚠️ Merge Conflict Detected — This PR has merge conflicts with its target branch. Please rebase onto the target branch and resolve the conflicts.

praveenkumarkarunanithi added 6 commits April 7, 2026 10:16

fix and test code update

1e598e0

Update ShellItemHandler.Windows.cs

3b14a7c

updated windows fix and test as per new API

7175e0f

updated test

2ed2061

Update Issue22151.cs

bed6295

test name updated

4463c98

praveenkumarkarunanithi added platform/windows area-controls-entry Entry labels Apr 22, 2026

dotnet-policy-service Bot added the partner/syncfusion Issues / PR's with Syncfusion collaboration label Apr 22, 2026

praveenkumarkarunanithi added shell-search-handler and removed area-controls-entry Entry labels Apr 22, 2026

sheiksyedm marked this pull request as ready for review April 22, 2026 10:37

Copilot AI review requested due to automatic review settings April 22, 2026 10:37

Copilot started reviewing on behalf of sheiksyedm April 22, 2026 10:38 View session

Copilot AI reviewed Apr 22, 2026

View reviewed changes

MauiBot added s/agent-changes-requested AI agent recommends changes - found a better alternative or issues s/agent-fix-win AI found a better alternative fix than the PR s/agent-reviewed PR was reviewed by AI agent workflow (full 4-phase review) labels Apr 22, 2026

github-actions Bot mentioned this pull request Apr 23, 2026

[PR Review Queue] 2026-04-23 #35101

Closed

kubaflo requested changes Apr 23, 2026

View reviewed changes

kubaflo mentioned this pull request Apr 23, 2026

Add smart UI test category detection to skip irrelevant test jobs #33176

Closed

github-actions Bot mentioned this pull request Apr 24, 2026

[PR Review Queue] 2026-04-24 #35123

Closed

This was referenced Apr 24, 2026

Integrate UI test category detection into PR review and fix gate reliability #35133

Merged

Add UI test category detection to maui-pr-uitests pipeline #35136

Open

dotnet deleted a comment from MauiBot Apr 25, 2026

github-actions Bot mentioned this pull request Apr 26, 2026

[repo-status] 🌟 Daily Repo Status - April 26, 2026 #35139

Closed

kubaflo requested changes Apr 26, 2026

View reviewed changes

This was referenced Apr 27, 2026

[PR Review Queue] 2026-04-27 #35146

Closed

[PR Review Queue] 2026-04-28 #35182

Closed

This was referenced Apr 29, 2026

[PR Review Queue] 2026-04-29 #35207

Closed

[PR Review Queue] 2026-04-30 #35246

Closed

[PR Review Queue] 2026-05-01 #35274

Closed

dotnet deleted a comment from MauiBot May 2, 2026

This was referenced May 4, 2026

[PR Review Queue] 2026-05-04 #35296

Closed

[PR Review Queue] 2026-05-05 #35306

Closed

[PR Review Queue] 2026-05-06 #35320

Closed

[PR Review Queue] 2026-05-07 #35336

Open

		var focusedEvent = App.WaitForElement("focusedEventLabel").GetText();
		Assert.That(focusedEvent, Is.EqualTo("FocusedEvent: True"));

	[Category(UITestCategories.SearchBar)]
	[Category(UITestCategories.SoftInput)]


		var isFocused = App.WaitForElement("isFocusedLabel").GetText();
		Assert.That(isFocused, Is.EqualTo("IsFocused: True"));

Conversation

praveenkumarkarunanithi commented Apr 22, 2026

Root Cause

Description of Change

Issues Fixed

Screenshots

Uh oh!

github-actions Bot commented Apr 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

kubaflo left a comment

Choose a reason for hiding this comment

Uh oh!

kubaflo left a comment

Choose a reason for hiding this comment

Uh oh!

MauiBot commented May 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants