[Windows] Fix CollectionView selected item visibility #31126

Vignesh-SF3580 · 2025-08-12T10:00:49Z

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

On Windows, the CollectionView selection state was not visible.

Root Cause

When adding new container styles, the default styles was not added.

Description of Change

Used the BasedOn property to include the default style along with the new style, so selection states remain visible.

Tested the behavior in the following platforms

Android
Windows
iOS
Mac

Issues Fixed

Fixes #30868

Screenshots

SelectionMode: Multiple

Before Issue Fix	After Issue Fix

SelectionMode: Single

Before Issue Fix	After Issue Fix

dotnet-policy-service · 2025-08-12T10:01:11Z

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

bhavanesh2001 · 2025-08-13T07:32:02Z

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs

 			var margin = WinUIHelpers.CreateThickness(0, v, 0, v);

-			var style = new WStyle(typeof(ListViewItem));
+			var defaultStyle = GetDefaultStyle("DefaultListViewItemStyle");


Can we store the resourceKey in a field and use it?

I have updated the code to store the resourceKey in a field.

Copilot

Pull Request Overview

This PR fixes an issue where CollectionView selected item states were not visible on Windows. The root cause was that when creating custom container styles for spacing and layout, the default styles containing selection visual states were being overridden completely instead of being extended.

Key changes:

Modified style creation to use BasedOn property to inherit from default styles
Added UI test to verify selection visibility behavior
Applied fix to both GridView and ListView item container styles

Reviewed Changes

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

File	Description
`src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs`	Updated style creation logic to inherit from default styles using `BasedOn` property, ensuring selection states remain visible
`src/Controls/tests/TestCases.HostApp/Issues/Issue30868.cs`	Added test page with CollectionView configured for multiple selection mode to demonstrate the fix
`src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue30868.cs`	Added UI test that taps an item and verifies selection state through screenshot comparison

_{You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}

Copilot · 2025-08-13T12:48:11Z

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

+					VerticalTextAlignment = TextAlignment.Center,
+					Padding = new Thickness(10, 0, 10, 10)
+				};
+				label.SetBinding(Label.TextProperty, ".");


The Label element lacks an AutomationId property. According to the testing guidelines, all interactive UI elements should have unique AutomationIds to ensure proper test automation. Consider adding label.AutomationId = (string)label.BindingContext; or a similar unique identifier.

Copilot · 2025-08-13T12:48:12Z

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

+	[Category(UITestCategories.CollectionView)]
+	public void CollectionViewSelectionMode()
+	{
+		App.WaitForElement("Item 2");


The test is waiting for an element with text 'Item 2', but the corresponding HostApp page doesn't assign AutomationIds to the Label elements within the CollectionView items. This could cause the test to fail because WaitForElement may not be able to locate the element reliably without proper AutomationIds.

jsuarezruiz · 2025-08-28T11:36:26Z

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs

 			var margin = WinUIHelpers.CreateThickness(h, v, h, v);

-			var style = new WStyle(typeof(GridViewItem));
+			var defaultStyle = GetDefaultStyle(GridViewItemStyleKey);


The GetDefaultStyle() method could return null if the resource key doesn't exist. Must not happen except mistake, but, can protect it?

if (defaultStyle is not null) { style.BasedOn = defaultStyle; }

@jsuarezruiz Added a null check to avoid unexpected failures.

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs

jsuarezruiz · 2025-09-01T11:15:12Z

/azp run MAUI-UITests-public

azure-pipelines · 2025-09-01T11:15:24Z

Azure Pipelines successfully started running 1 pipeline(s).

jsuarezruiz

With the changes, requires updates in the reference snapshot from several Windows tests related with CV selection:

Could you review it?

jsuarezruiz · 2025-09-02T06:33:24Z

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

+	{
+		App.WaitForElement("Item 2");
+		App.Tap("Item 2");
+		VerifyScreenshot();


Pending snapshot on Windows and macOS.

Could you commit the images?

I’ve committed the images for Windows and macOS.

Could we modify it a little bit? Use

maui/src/TestUtils/src/UITest.Appium/HelperExtensions.cs

Line 1730 in 4d6515f

public static void SetLightTheme(this IApp app)

SetLightTheme and SetDarkTheme, and validating a screenshot in both cases.

@jsuarezruiz I have updated the test cases based on your suggestion. Let me know if any further changes are needed.

Vignesh-SF3580 · 2025-09-02T06:58:57Z

With the changes, requires updates in the reference snapshot from several Windows tests related with CV selection: Could you review it?

@jsuarezruiz Previously, the default style for SelectedItems was not updating properly. It is now updated along with the default styles. I have updated these with the newly generated images.

jsuarezruiz · 2025-09-04T14:26:23Z

/azp run

azure-pipelines · 2025-09-04T14:26:51Z

Azure Pipelines successfully started running 3 pipeline(s).

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs

jsuarezruiz · 2025-09-16T08:58:06Z

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs

 		PropertyChangedEventHandler _layoutPropertyChanged;
+		const string ListViewItemStyleKey = "DefaultListViewItemStyle";
+		const string GridViewItemStyleKey = "DefaultGridViewItemStyle";
+		static WStyle _listViewItemStyle;


Could validate if user switches between Light/Dark themes works as expected or static cached styles won't update?

@jsuarezruiz I have validated switching between Light and Dark themes, and it works as expected. The checkbox colors are updated correctly based on the theme changes defined in the default style. I have attached a video for reference.

31126Theme.mp4

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs

jsuarezruiz · 2025-09-23T06:34:25Z

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

+	{
+		App.WaitForElement("Item 2");
+		App.Tap("Item 2");
+		VerifyScreenshot();


Could we modify it a little bit? Use

maui/src/TestUtils/src/UITest.Appium/HelperExtensions.cs

Line 1730 in 4d6515f

public static void SetLightTheme(this IApp app)

SetLightTheme and SetDarkTheme, and validating a screenshot in both cases.

PureWeen · 2025-10-06T17:11:35Z

/azp run

azure-pipelines · 2025-10-06T17:12:08Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz

Re-running the Windows CollectionView UITests. The process was canceled after some time running.

Vignesh-SF3580 · 2025-10-07T11:31:09Z

Re-running the Windows CollectionView UITests. The process was canceled after some time running.

@jsuarezruiz Changing themes continuously fails on CI for Windows. It seems that theme changes do not work on Windows, and this was already noted in the implemented PR.
PR: #25863

jsuarezruiz · 2025-10-08T12:24:25Z

/azp run

azure-pipelines · 2025-10-08T12:24:49Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2025-10-10T09:29:41Z

/azp run

azure-pipelines · 2025-10-10T09:30:03Z

Azure Pipelines successfully started running 3 pipeline(s).

dotnet-policy-service bot added the community ✨ Community Contribution label Aug 12, 2025

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

Tamilarasan-Paranthaman added platform/windows area-controls-collectionview CollectionView, CarouselView, IndicatorView labels Aug 12, 2025

bhavanesh2001 reviewed Aug 13, 2025

View reviewed changes

Vignesh-SF3580 marked this pull request as ready for review August 13, 2025 12:45

Copilot AI review requested due to automatic review settings August 13, 2025 12:45

Vignesh-SF3580 requested a review from a team as a code owner August 13, 2025 12:45

Vignesh-SF3580 requested review from jfversluis and jsuarezruiz August 13, 2025 12:45

Copilot AI reviewed Aug 13, 2025

View reviewed changes

jsuarezruiz requested changes Aug 28, 2025

View reviewed changes

jsuarezruiz requested changes Sep 2, 2025

View reviewed changes

PureWeen added this to the .NET 9 SR11 milestone Sep 4, 2025

PureWeen added this to MAUI SDK Ongoing Sep 4, 2025

github-project-automation bot moved this to Todo in MAUI SDK Ongoing Sep 4, 2025

PureWeen moved this from Todo to Ready To Review in MAUI SDK Ongoing Sep 4, 2025

jsuarezruiz requested changes Sep 9, 2025

View reviewed changes

src/Controls/src/Core/Handlers/Items/StructuredItemsViewHandler.Windows.cs Show resolved Hide resolved

github-project-automation bot moved this from Ready To Review to Changes Requested in MAUI SDK Ongoing Sep 9, 2025

PureWeen modified the milestones: .NET 9 SR11, .NET 9 SR12 Sep 10, 2025

PureWeen added the p/0 Work that we can't release without label Sep 10, 2025

jsuarezruiz requested changes Sep 16, 2025

View reviewed changes

jsuarezruiz requested changes Sep 23, 2025

View reviewed changes

Vignesh-SF3580 and others added 7 commits September 30, 2025 13:35

added UI test.

3c1a1b5

added snapshots.

6cbe6b0

Update StructuredItemsViewHandler.Windows.cs

c3c5ee5

updated review concerns.

37a62d0

added snapshots.

65074c5

Updated test

f67848b

removed existing output images.

dd0f21f

Vignesh-SF3580 force-pushed the fix-30868 branch from d1b4700 to dd0f21f Compare September 30, 2025 08:10

snapshots added.

02e41aa

jsuarezruiz reviewed Oct 7, 2025

View reviewed changes

Update Issue30868.cs

133e82a

Update Issue30868.cs

059dbe0

Vignesh-SF3580 force-pushed the fix-30868 branch from f8eeb1f to 059dbe0 Compare October 7, 2025 11:47

PureWeen modified the milestones: .NET 9 SR12, .NET 10.0 GA Oct 8, 2025

added windows snapshot.

b3b6401

sheiksyedm moved this from Changes Requested to Ready To Review in MAUI SDK Ongoing Oct 13, 2025

jsuarezruiz approved these changes Oct 14, 2025

View reviewed changes

github-project-automation bot moved this from Ready To Review to Approved in MAUI SDK Ongoing Oct 14, 2025

PureWeen merged commit e9d69ec into dotnet:main Oct 15, 2025
129 checks passed

github-project-automation bot moved this from Approved to Done in MAUI SDK Ongoing Oct 15, 2025

Vignesh-SF3580 mentioned this pull request Oct 23, 2025

Right icon present to show selected tag that icon color contrast with back ground color less than 3:1 :A11y_.NET maui_Projact_Non text Contrast #30868

Open

TamilarasanSF4853 mentioned this pull request Oct 24, 2025

[Testing] Fixed Test case failure in net10 branch #32196

Merged

[Windows] Fix CollectionView selected item visibility #31126

[Windows] Fix CollectionView selected item visibility #31126

Uh oh!

Conversation

Vignesh-SF3580 commented Aug 12, 2025

Issue Details

Root Cause

Description of Change

Tested the behavior in the following platforms

Issues Fixed

Screenshots

Uh oh!

dotnet-policy-service bot commented Aug 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jsuarezruiz commented Sep 1, 2025

Uh oh!

azure-pipelines bot commented Sep 1, 2025

Uh oh!

jsuarezruiz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vignesh-SF3580 commented Sep 2, 2025

Uh oh!

jsuarezruiz commented Sep 4, 2025

Uh oh!

azure-pipelines bot commented Sep 4, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PureWeen commented Oct 6, 2025

Uh oh!

azure-pipelines bot commented Oct 6, 2025

Uh oh!

jsuarezruiz left a comment

Choose a reason for hiding this comment

Uh oh!

Vignesh-SF3580 commented Oct 7, 2025

Uh oh!

jsuarezruiz commented Oct 8, 2025

Uh oh!

azure-pipelines bot commented Oct 8, 2025

Uh oh!

jsuarezruiz commented Oct 10, 2025

Uh oh!

azure-pipelines bot commented Oct 10, 2025

Uh oh!