[Windows] Fix for Scrollview.ScrollTo execution only returns after manual scroll #28528

HarishwaranVijayakumar · 2025-03-20T06:50:17Z

Root Cause of the issue

When the scroll offset is set to the same value as the current view, the scroll view doesn't change. As a result, the scroll operation never completes, causing the await method to wait indefinitely. Consequently, the code after the await will not be executed.

Description of Change

To address this issue, I have implemented a check to mark the scroll as finished when the requested offset is the same as the current platform offset

Issues Fixed

Fixes #15508

Tested the behaviour in the following platforms

Windows
Android
iOS
Mac

Output

Before Fix	After Fix
Beforefix_scroll.mp4	Afterfix_scroll.mp4

jsuarezruiz · 2025-03-20T09:11:54Z

/azp run

azure-pipelines · 2025-03-20T09:12:15Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull Request Overview

This PR fixes an issue where ScrollView.ScrollTo on Windows would not complete the operation when the requested offset matched the current offset, causing the await to wait indefinitely.

Added automated tests for the issue in both shared tests and the host app.
Updated the Windows ScrollViewHandler to immediately mark scrolling as finished when the requested offset matches the current offset.

Reviewed Changes

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

File	Description
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue15508.cs	Added a test that verifies the scroll operation completes as expected.
src/Controls/tests/TestCases.HostApp/Issues/Issue15508.cs	Implemented a UI test demonstrating the scroll fix in the host app.
src/Core/src/Handlers/ScrollView/ScrollViewHandler.Windows.cs	Updated scroll behavior to handle cases where the current offset matches the requested offset.

Comments suppressed due to low confidence (2)

src/Controls/tests/TestCases.HostApp/Issues/Issue15508.cs:29

[nitpick] Consider renaming the local variable _scrollButton to scrollButton for clarity, reserving the underscore prefix for private fields.

Button _scrollButton = new Button

src/Core/src/Handlers/ScrollView/ScrollViewHandler.Windows.cs:77

[nitpick] If VerticalOffset and HorizontalOffset are floating point values, consider using an epsilon-based comparison to handle potential precision issues.

if (request.VerticalOffset == handler.PlatformView.VerticalOffset && request.HorizontalOffset == handler.PlatformView.HorizontalOffset)

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

jsuarezruiz · 2025-03-26T20:18:15Z

/azp run

azure-pipelines · 2025-03-26T20:18:35Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2025-03-27T06:47:25Z

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

+
+	[Test]
+	[Category(UITestCategories.ScrollView)]
+	public void ScrollViewinAwait()


This test still fails on Android:

Assert.That(scrollLabel.GetText(), Is.EqualTo("Scroll Completed")) Expected string length 16 but was 12. Strings differ at index 0. Expected: "Scroll Completed" But was: "Not Scrolled" -----------^

@jsuarezruiz, I have modified the test case and ensured that it passes when we include a slight delay.

jsuarezruiz · 2025-03-28T07:05:10Z

/azp run

azure-pipelines · 2025-03-28T07:05:31Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2025-04-25T07:23:26Z

/rebase

jsuarezruiz · 2025-04-28T07:12:13Z

src/Core/src/Handlers/ScrollView/ScrollViewHandler.Windows.cs

@@ -78,7 +78,14 @@ public static void MapRequestScrollTo(IScrollViewHandler handler, IScrollView sc
 		{
 			if (args is ScrollToRequest request)
 			{
-				handler.PlatformView.ChangeView(request.HorizontalOffset, request.VerticalOffset, null, request.Instant);
+				if (request.VerticalOffset == handler.PlatformView.VerticalOffset && request.HorizontalOffset == handler.PlatformView.HorizontalOffset)


Here, can extract the position comparison into a well-named boolean variable that clearly communicates its purpose:

bool isAlreadyAtRequestedPosition = request.VerticalOffset == handler.PlatformView.VerticalOffset && request.HorizontalOffset == handler.PlatformView.HorizontalOffset; if (isAlreadyAtRequestedPosition)

@jsuarezruiz, As suggested I have modified the changes

jsuarezruiz · 2025-04-28T07:19:55Z

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

+	{
+		App.WaitForElement("Button");
+		App.Tap("Button");
+		Thread.Sleep(1000);


Can remove this waiting time to a method waiting until "Scroll Completed" appears with a maximum timeout.

WaitForTextToBePresentInElement

@jsuarezruiz, As suggested I have modified the changes

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

/azp run MAUI-UITests-public

azure-pipelines · 2025-05-08T11:39:50Z

Azure Pipelines successfully started running 1 pipeline(s).

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

jsuarezruiz added the platform/windows label Mar 20, 2025

HarishwaranVijayakumar marked this pull request as ready for review March 20, 2025 10:00

Copilot AI review requested due to automatic review settings March 20, 2025 10:00

HarishwaranVijayakumar requested a review from a team as a code owner March 20, 2025 10:00

HarishwaranVijayakumar requested review from jfversluis and rmarinho March 20, 2025 10:00

Copilot AI reviewed Mar 20, 2025

View reviewed changes

mattleibow previously approved these changes Mar 20, 2025

View reviewed changes

mattleibow added the area-controls-scrollview ScrollView label Mar 20, 2025

jsuarezruiz requested changes Mar 26, 2025

View reviewed changes

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue15508.cs Show resolved Hide resolved

HarishwaranVijayakumar dismissed mattleibow’s stale review via 075e55e March 26, 2025 09:44

jsuarezruiz requested changes Mar 27, 2025

View reviewed changes

HarishwaranVijayakumar added 8 commits April 25, 2025 07:23

Fix for ScrollToAsync

0aaac57

Modified the test case

7a903a1

Test case Modified

b972f36

TestCase Modification

214a093

Fixes for ScrollHandler

11e6732

Modified the testcase

cd37a7a

Code modification and text case changes

8eaff73

Test case modification

027055c

github-actions bot force-pushed the fix-15508 branch from 0e54516 to 027055c Compare April 25, 2025 07:24

jsuarezruiz requested changes Apr 28, 2025

View reviewed changes

HarishwaranVijayakumar added 2 commits April 29, 2025 16:20

Code and Testcase changes

2253408

Code changes

2448f90

[Windows] Fix for Scrollview.ScrollTo execution only returns after manual scroll #28528

Are you sure you want to change the base?

[Windows] Fix for Scrollview.ScrollTo execution only returns after manual scroll #28528

Conversation

HarishwaranVijayakumar commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Root Cause of the issue

Description of Change

Issues Fixed

Tested the behaviour in the following platforms

Output

Uh oh!

jsuarezruiz commented Mar 20, 2025

Uh oh!

azure-pipelines bot commented Mar 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

jsuarezruiz commented Mar 26, 2025

Uh oh!

azure-pipelines bot commented Mar 26, 2025

Uh oh!

jsuarezruiz Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

HarishwaranVijayakumar Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented Mar 28, 2025

Uh oh!

azure-pipelines bot commented Mar 28, 2025

Uh oh!

jsuarezruiz commented Apr 25, 2025

Uh oh!

jsuarezruiz Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

HarishwaranVijayakumar Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

HarishwaranVijayakumar Apr 29, 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!

Uh oh!

HarishwaranVijayakumar commented Mar 20, 2025 •

edited

Loading