[Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation #29441

BagavathiPerumal · 2025-05-12T11:42:21Z

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

The issue is caused by the SearchHandler visibility not updating properly during navigation between pages within the same ShellSection. The SearchHandler visibility only updates when Shell.CurrentItem changes and during initial view loading, but not during in-section navigation. This results in the search bar remaining persistently visible during transitions from list pages to detail pages where search functionality is not contextually relevant.

Description of Issue Fix

The fix involves subscribing to the Shell.Navigated event and calling UpdateSearchHandler() when navigation occurs. This ensures the search bar updates correctly after each page transition, including when moving to a detail page. It aligns Windows behavior with Android and iOS by showing the search bar only when appropriate.

Tested the behavior in the following platforms.

Windows
Mac
iOS
Android

Issues Fixed

Fixes #17521

Output

Before Issue Fix	After Issue Fix
SearchHandler-BeforeFix.mp4	SearchHandler-AfterFix.mp4

…ithin same ShellSection.

Copilot

Pull Request Overview

This PR fixes an issue with the SearchHandler visibility not updating during in-section navigation by subscribing to the Shell.Navigated event to trigger an UpdateSearchHandler call.

Subscribes and unsubscribes to the Shell.Navigated event in ShellItemHandler.Windows.cs
Adds tests in both shared and host test projects to verify the fix
Updates the test host app to include navigation routes and search handler functionality

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

File	Description
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue17521.cs	Adds a new UI test for the SearchHandler behavior
src/Controls/tests/TestCases.HostApp/Issues/Issue17521.cs	Implements a sample Shell with navigation and search handler for testing the fix
src/Controls/src/Core/Handlers/Shell/ShellItemHandler.Windows.cs	Updates event subscriptions to refresh the SearchHandler on in-section navigation

Copilot · 2025-05-12T12:48:04Z

src/Controls/tests/TestCases.HostApp/Issues/Issue17521.cs

+			Cats.Add(new _17521Animal
+			{
+				Name = "Abyssinian",
+				Location = "Ethopia",


Consider correcting the spelling of 'Ethopia' to 'Ethiopia' for clarity.

Suggested change

Location = "Ethopia",

Location = "Ethiopia",

…pia".

jsuarezruiz · 2025-05-16T11:20:21Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-16T11:20:33Z

Azure Pipelines successfully started running 1 pipeline(s).

jsuarezruiz · 2025-05-19T09:37:14Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-19T09:37:26Z

Azure Pipelines successfully started running 1 pipeline(s).

…tion Navigation (#29441) * fix-17521-Updates the SearchHandler when navigating to another page within same ShellSection. * fix-17521-Added testcase and added snapshot for Android and iOS. * fix-17521-Renamed Shell_Navigated to OnShellNavigated. * fix-17521-Modified the Location string value from "Ethopia" to "Ethiopia". * fix-17521-Snapshot updated. * fix-17521-Updated Windows and Mac Snapshot.

#25393) * [create-pull-request] automated change (#29793) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Convert HybridWebView.js to TypeScript and embed (#27183) * Fix up relevant CA1416 warnings - Set 3 (#26751) * [Testing] Feature Matrix UITest Cases for CollectionView Dynamic changes (#29424) * Added FeatureTests for CollectionView * changes updated * changes updated * [create-pull-request] automated change (#29505) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * CA1416 warning fix * Added snapshots * Reverting files changes * Removed the old approach * Revert unwanted changes * Reverted unwanted changes * Reverted unwanted changes * Revert unwanted changes --------- Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix up relevant CA1416 warnings - Set 1 (#26696) * Changed Syncfusion toolkit version from 1.0.4 to 1.0.5 (#29659) * [ci] Update dependencies from 9.0.4 to 9.0.5 (#29667) * [ci] Update dependencies from 9.0.4 to 9.0.5 * Update the net8 version * Add missing version MicrosoftJSInteropPackageVersion * Page.OnBackButtonPressed remove outdated API documentation (#29543) * Fixed KeepLastItemInView Does Not Scroll to Last Item When Adding Items at Top (#29632) * Fixed KeepLastItem not scrolled to last item * Updated Fix * Updated test sample * Added comment line * Updated test sample for iOS and mac * Added Snapshots for android and WinUI * Added UI tests. * Test sample changes. * script changes * script changes * Added snapshots * Resaved Mac images and the gradient image size issue has been fixed * CA1416 warning changes * Reverted unwanted changes --------- Co-authored-by: Paul Anderson <42271912+PaulAndersonS@users.noreply.github.com> Co-authored-by: Rui Marinho <me@ruimarinho.net> Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com> Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com> * [iOS/Mac]Fix StrokeDashArray Property not Rendering (#29670) * fix added * Test added * snap added * [Android/ iOS] Fix Flyout icon is displayed when flyout is disabled (#29637) * fix added * modified the fix * test case added * test case added * summary added * Script name changed * [Android & iOS] Fix for SearchHandler Character Spacing Property (#29497) * [Android & iOS] Fix for character spacing in searchHandler * Updated test sample concerns * Update on naming * Update on formatting * Allowing updating character spacing to zero * Updated Andorid, iOS, Mac images * [create-pull-request] automated change (#29724) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * [Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation (#29441) * fix-17521-Updates the SearchHandler when navigating to another page within same ShellSection. * fix-17521-Added testcase and added snapshot for Android and iOS. * fix-17521-Renamed Shell_Navigated to OnShellNavigated. * fix-17521-Modified the Location string value from "Ethopia" to "Ethiopia". * fix-17521-Snapshot updated. * fix-17521-Updated Windows and Mac Snapshot. * [Windows] - Fix view position shift when shadows are added or removed at runtime (#29681) * Fix-view-position-shift-when-toggling-shadows * Added-Pending-SnapShots * Resaved-image * [Testing] Feature Matrix UITest Cases for Shadows (#27701) * Added sample to Matrix UITest Cases for Shadow * Renamed sample page * Renamed sample page * More tests * More tests * More tests * More tests * Added shadow tests * Updated sample * Added Windows snapshots * Updated tests * Added link to issue * More changes * Updated sample reset logic * Updated sample * More changes * More changes * More changes * Updated sample * Added snapshots * Hide cursor * More changes * More snapshots * Updated tests * Updated iOS snapshots * Updated iOS snapshots * Updated snapshots * Updated snapshots * Updated tests * [housekeeping] Automated PR to fix formatting errors on uitest-shadow-feature * Updated tests * Fix build errors * More changes * More changes * More changes * More changes --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * [iOS] Fixed Shell.SearchHandler ClearPlaceholderIcon Color Issue (#28601) * SearchHandler ClearPlaceholderIcon color fix * Added Mac snapshot * Updated SearchBar Icon changes * Test script changes. * Revert unwanted changes * Updated custom icon changes * Fix -[iOS] - CarouselView Throws ArgumentOutOfRangeException Immediately on Application Launch in CV2 (#29316) * Update ItemsSourceFactory2.cs * Update CarouselViewPositionVisibility.xaml * [Windows] Fix for ItemsSource Does Not Dynamically Set to null in CarouselView (#29660) * [Windows] Fix for ItemsSource Does Not Dynamically Set to null in CarouselView * Have added test case * Updated AutomationId for better clarity and readability * Have modified the context of the description label * Have committed the snapshots * [Testing] Feature Matrix UITest Cases for Label (#29690) * Added Label Feature tests * changes updated * changes updated * changes updated * Added Screenshots * Added Snapshots for iOS * Corrected Mistakes * Added snapshots * Added images * Renamed file --------- Co-authored-by: Rui Marinho <me@ruimarinho.net> * updated base images for candidate PR failures (#29766) * [Android] Fix: Modal Animation Repeats When Returning from Background 3 (#29702) * fix * dispose listner once not needed * Revert "dispose listner once not needed" * call invalidate * add device test to check for leaks * null check and remove strong references in callback * Throw if rootview is null before adding animation * fix spelling mistake * [Testing] Include a tolerance parameter in the Verifyscreenshot method (#29776) * Added tolerance parameter to the VerifyScreenshot method * More changes * Update src/Controls/tests/TestCases.Shared.Tests/UITest.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update src/Controls/tests/TestCases.Shared.Tests/UITest.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * [Testing] Update Appium to v8 (#29774) * Update Appium to the latest version * Removed deprecated logic * Update comment * [create-pull-request] automated change (#29831) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Perf : ButtonContentTypeConverter now using InvariantCulture to parse double --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Tamilarasan Paranthaman <93904422+Tamilarasan-Paranthaman@users.noreply.github.com> Co-authored-by: NafeelaNazhir <nafeela.nazhirhussain@syncfusion.com> Co-authored-by: Paul Anderson <42271912+PaulAndersonS@users.noreply.github.com> Co-authored-by: Rui Marinho <me@ruimarinho.net> Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com> Co-authored-by: Dhivya-SF4094 <127717131+Dhivya-SF4094@users.noreply.github.com> Co-authored-by: devanathan-vaithiyanathan <114395405+devanathan-vaithiyanathan@users.noreply.github.com> Co-authored-by: Subhiksha Chandrasekaran <subhiksha.c@syncfusion.com> Co-authored-by: BagavathiPerumal <93652794+BagavathiPerumal@users.noreply.github.com> Co-authored-by: prakashKannanSf3972 <127308739+prakashKannanSf3972@users.noreply.github.com> Co-authored-by: Javier Suárez <javiersuarezruiz@hotmail.com> Co-authored-by: SuthiYuvaraj <92777079+SuthiYuvaraj@users.noreply.github.com> Co-authored-by: SyedAbdulAzeemSF4852 <syedabdulazeem.a@syncfusion.com> Co-authored-by: Anandhan Rajagopal <97146406+anandhan-rajagopal@users.noreply.github.com> Co-authored-by: Bhavanesh N <bhavanesh001@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Shane Neuville <shneuvil@microsoft.com>

BagavathiPerumal added 3 commits May 5, 2025 17:02

fix-17521-Updates the SearchHandler when navigating to another page w…

20e55fb

…ithin same ShellSection.

fix-17521-Added testcase and added snapshot for Android and iOS.

97a03fa

fix-17521-Renamed Shell_Navigated to OnShellNavigated.

3adf652

dotnet-policy-service bot added community ✨ Community Contribution partner/syncfusion Issues / PR's with Syncfusion collaboration labels May 12, 2025

BagavathiPerumal marked this pull request as ready for review May 12, 2025 12:47

Copilot AI review requested due to automatic review settings May 12, 2025 12:47

BagavathiPerumal requested a review from a team as a code owner May 12, 2025 12:47

BagavathiPerumal requested review from jfversluis and jsuarezruiz May 12, 2025 12:47

Copilot AI reviewed May 12, 2025

View reviewed changes

fix-17521-Modified the Location string value from "Ethopia" to "Ethio…

1f95b09

…pia".

sheiksyedm added shell-search-handler area-controls-shell Shell Navigation, Routes, Tabs, Flyout platform/windows labels May 12, 2025

BagavathiPerumal changed the title ~~Fix for SearchHandler Visibility Not Updating During In-Section Navigation~~ [Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation May 12, 2025

fix-17521-Snapshot updated.

16efc75

fix-17521-Updated Windows and Mac Snapshot.

b2d510d

jsuarezruiz approved these changes May 29, 2025

View reviewed changes

rmarinho changed the base branch from main to inflight/current May 29, 2025 10:11

rmarinho merged commit 7fd2f2d into dotnet:inflight/current May 29, 2025
78 of 79 checks passed

SyedAbdulAzeemSF4852 mentioned this pull request May 30, 2025

[Android] Fix for Unable to Programmatically Update SearchHandler Query Value on Second Tab within ShellSection #29715

Open

4 tasks

github-actions bot locked and limited conversation to collaborators Jun 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation #29441

[Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation #29441

Uh oh!

BagavathiPerumal commented May 12, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 12, 2025

Uh oh!

jsuarezruiz commented May 16, 2025

Uh oh!

azure-pipelines bot commented May 16, 2025

Uh oh!

jsuarezruiz commented May 19, 2025

Uh oh!

azure-pipelines bot commented May 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation #29441

[Windows] Fix for SearchHandler Visibility Not Updating During In-Section Navigation #29441

Uh oh!

Conversation

BagavathiPerumal commented May 12, 2025

Root cause

Description of Issue Fix

Issues Fixed

Output

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 12, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented May 16, 2025

Uh oh!

azure-pipelines bot commented May 16, 2025

Uh oh!

jsuarezruiz commented May 19, 2025

Uh oh!

azure-pipelines bot commented May 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants