Fix: Picker selects incorrect item after item removal #29313

Shalini-Ashokan · 2025-05-05T06:22:26Z

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!

Issue Details

In a Picker, the SelectedItem changes unexpectedly when an item is removed. The selection maintains the same index, resulting in a different item being selected.

Root Cause

The RemoveItems method preserves selection based on index rather than the actual item.

Description of Change

Update the RemoveItems method to track and preserve the selected item by value instead of by index.

Validated the behavior in the following platforms

Android
Windows
iOS
Mac

Issues Fixed

Fixes #29235

Output ScreenShot

Before	After
Issue29235BeforeFix.mov	Issue29235AfterFix.mov

dotnet-policy-service · 2025-05-05T06:22:43Z

Hey there @@Shalini-Ashokan! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

jsuarezruiz · 2025-05-05T07:17:36Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-05T07:17:47Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR fixes the issue where the Picker selects an incorrect item after removal by updating the selection logic to track the selected item by value instead of by index.

Updated the RemoveItems method to recalculate the selected index based on the actual SelectedItem.
Modified AddItems and ResetItems to use the new ClampSelectedIndex overload and a helper GetSelectedIndex method.

Reviewed Changes

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

File	Description
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue29235.cs	Added tests to validate Picker behavior after item insertion and removal.
src/Controls/tests/TestCases.HostApp/Issues/Issue29235.cs	Updated host UI to support interactive validation of the Picker’s selection behavior.
src/Controls/src/Core/Picker/Picker.cs	Updated logic for item insertion and removal to preserve the selected item by value and clamping the index using a new helper method.

Copilot · 2025-05-05T11:43:46Z

src/Controls/src/Core/Picker/Picker.cs

 			// take care of it
 			if (((LockableObservableListWrapper)Items).IsLocked)
 				return;



[nitpick] Consider adding an inline comment explaining that GetSelectedIndex() is used to recalculate the selected index based on the actual SelectedItem, especially when the ItemsSource is populated. This will aid future maintainers in understanding the fallback behavior when SelectedItem is not found.

Suggested change

// Recalculate the selected index based on the actual SelectedItem and ItemsSource.

// This ensures the SelectedIndex is consistent, especially when ItemsSource is populated

// or when the SelectedItem is not found in the Items collection.

Copilot · 2025-05-05T11:43:46Z

src/Controls/src/Core/Picker/Picker.cs

 			foreach (object _ in e.OldItems)
 				((LockableObservableListWrapper)Items).InternalRemoveAt(index--);
-			if (removeStart <= SelectedIndex)
+


[nitpick] Consider adding a comment explaining that recalculating the selected index before clamping ensures that the selection is preserved by comparing against the actual item value rather than the previous index. This clarification will help maintainers understand the importance of the order of operations in the removal logic.

Suggested change

// Recalculate the selected index before clamping to ensure that the selection is preserved

// by comparing against the actual item value rather than the previous index.

jsuarezruiz · 2025-05-08T11:47:05Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-08T11:47:16Z

Azure Pipelines successfully started running 1 pipeline(s).

jsuarezruiz · 2025-05-26T08:51:03Z

src/Controls/src/Core/Picker/Picker.cs

+			if (SelectedItem is not null && (ItemsSource is not null || Items is not null))
 			{
-				ClampSelectedIndex();
+				int newIndex = ItemsSource?.IndexOf(SelectedItem) ?? Items.IndexOf(SelectedItem);


Already are checking if ItemsSource is not null before, redundant check here. Can remove the ?, or modify the code:

if (SelectedItem is null) { return SelectedIndex; } int newIndex = ItemsSource?.IndexOf(SelectedItem) ?? Items?.IndexOf(SelectedItem) ?? -1; return newIndex >= 0 ? newIndex : SelectedIndex;

@jsuarezruiz, I have updated the code section based on your suggestions.

jsuarezruiz · 2025-05-27T07:59:43Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-27T07:59:53Z

Azure Pipelines successfully started running 1 pipeline(s).

jsuarezruiz · 2025-10-30T15:58:50Z

/rebase

- Add PickerPreservesSelectedItemAfterRemovingItemBeforeSelection test - Add PickerPreservesSelectedItemAfterInsertingItemBeforeSelection test - Update existing tests to verify the new correct behavior

Unit tests are sufficient to validate this fix.

StephaneDelcroix

replaced the UITest by a Unit Test

* Fixed the selected item changed * fix for adding items * Added the test cases * Modified the logics * Modified the test case * Corrected the code * Modified the logics * Modified the changes * Add unit tests for Picker selection preservation - Add PickerPreservesSelectedItemAfterRemovingItemBeforeSelection test - Add PickerPreservesSelectedItemAfterInsertingItemBeforeSelection test - Update existing tests to verify the new correct behavior * Remove UI test, keep only unit test Unit tests are sufficient to validate this fix. --------- Co-authored-by: Stephane Delcroix <[email protected]>

dotnet-policy-service bot added the community ✨ Community Contribution label May 5, 2025

dotnet-policy-service bot added the partner/syncfusion Issues / PR's with Syncfusion collaboration label May 5, 2025

jsuarezruiz added the area-controls-picker Picker label May 5, 2025

Shalini-Ashokan marked this pull request as ready for review May 5, 2025 11:43

Copilot AI review requested due to automatic review settings May 5, 2025 11:43

Shalini-Ashokan requested a review from a team as a code owner May 5, 2025 11:43

Shalini-Ashokan requested review from StephaneDelcroix and jfversluis May 5, 2025 11:43

Copilot AI reviewed May 5, 2025

View reviewed changes

jsuarezruiz reviewed May 26, 2025

View reviewed changes

MartyIX added platform/macos macOS / Mac Catalyst platform/windows platform/android platform/ios labels May 26, 2025

Shalini-Ashokan added 8 commits October 30, 2025 15:59

Fixed the selected item changed

cb9dc93

fix for adding items

2eb8d83

Added the test cases

5a247c8

Modified the logics

c087d5a

Modified the test case

198a3ae

Corrected the code

2d2943d

Modified the logics

e68d3f1

Modified the changes

93765fa

github-actions bot force-pushed the fix-29235 branch from c7e02a4 to 93765fa Compare October 30, 2025 15:59

StephaneDelcroix added 2 commits December 3, 2025 15:43

Add unit tests for Picker selection preservation

a2e7c96

- Add PickerPreservesSelectedItemAfterRemovingItemBeforeSelection test - Add PickerPreservesSelectedItemAfterInsertingItemBeforeSelection test - Update existing tests to verify the new correct behavior

Remove UI test, keep only unit test

8ce6938

Unit tests are sufficient to validate this fix.

StephaneDelcroix approved these changes Dec 3, 2025

View reviewed changes

StephaneDelcroix changed the base branch from main to inflight/current December 3, 2025 14:49

StephaneDelcroix merged commit 50e87cb into dotnet:inflight/current Dec 3, 2025
1 check passed

+			// Recalculate the selected index based on the actual SelectedItem and ItemsSource.
+			// This ensures the SelectedIndex is consistent, especially when ItemsSource is populated
+			// or when the SelectedItem is not found in the Items collection.



	// Recalculate the selected index before clamping to ensure that the selection is preserved
	// by comparing against the actual item value rather than the previous index.

Fix: Picker selects incorrect item after item removal #29313

Fix: Picker selects incorrect item after item removal #29313

Uh oh!

Conversation

Shalini-Ashokan commented May 5, 2025

Issue Details

Root Cause

Description of Change

Issues Fixed

Output ScreenShot

Uh oh!

dotnet-policy-service bot commented May 5, 2025

Uh oh!

jsuarezruiz commented May 5, 2025

Uh oh!

azure-pipelines bot commented May 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 5, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented May 8, 2025

Uh oh!

azure-pipelines bot commented May 8, 2025

Uh oh!

jsuarezruiz May 26, 2025

Choose a reason for hiding this comment

Uh oh!

Shalini-Ashokan May 27, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented May 27, 2025

Uh oh!

azure-pipelines bot commented May 27, 2025

Uh oh!

jsuarezruiz commented Oct 30, 2025

Uh oh!

StephaneDelcroix left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants