Skip to content

Commit 6154b3b

Browse files
authored
Improve Scrollbar drag behavior (#112434)
1 parent 14a7360 commit 6154b3b

File tree

2 files changed

+97
-14
lines changed

2 files changed

+97
-14
lines changed

packages/flutter/lib/src/widgets/scrollbar.dart

+26-14
Original file line numberDiff line numberDiff line change
@@ -686,6 +686,17 @@ class ScrollbarPainter extends ChangeNotifier implements CustomPainter {
686686
return scrollableExtent * thumbOffsetLocal / thumbMovableExtent;
687687
}
688688

689+
/// The thumb's corresponding scroll offset in the track.
690+
double getThumbScrollOffset() {
691+
final double scrollableExtent = _lastMetrics!.maxScrollExtent - _lastMetrics!.minScrollExtent;
692+
693+
final double fractionPast = (scrollableExtent > 0)
694+
? clampDouble(_lastMetrics!.pixels / scrollableExtent, 0.0, 1.0)
695+
: 0;
696+
697+
return fractionPast * (_traversableTrackExtent - _thumbExtent);
698+
}
699+
689700
// Converts between a scroll position and the corresponding position in the
690701
// thumb track.
691702
double _getScrollToTrack(ScrollMetrics metrics, double thumbExtent) {
@@ -1446,15 +1457,15 @@ class RawScrollbar extends StatefulWidget {
14461457
/// Provides defaults gestures for dragging the scrollbar thumb and tapping on the
14471458
/// scrollbar track.
14481459
class RawScrollbarState<T extends RawScrollbar> extends State<T> with TickerProviderStateMixin<T> {
1449-
Offset? _dragScrollbarAxisOffset;
1460+
Offset? _startDragScrollbarAxisOffset;
1461+
double? _startDragThumbOffset;
14501462
ScrollController? _currentController;
14511463
Timer? _fadeoutTimer;
14521464
late AnimationController _fadeoutAnimationController;
14531465
late Animation<double> _fadeoutOpacityAnimation;
14541466
final GlobalKey _scrollbarPainterKey = GlobalKey();
14551467
bool _hoverIsActive = false;
14561468

1457-
14581469
/// Used to paint the scrollbar.
14591470
///
14601471
/// Can be customized by subclasses to change scrollbar behavior by overriding
@@ -1688,30 +1699,30 @@ class RawScrollbarState<T extends RawScrollbar> extends State<T> with TickerProv
16881699

16891700
void _updateScrollPosition(Offset updatedOffset) {
16901701
assert(_currentController != null);
1691-
assert(_dragScrollbarAxisOffset != null);
1702+
assert(_startDragScrollbarAxisOffset != null);
1703+
assert(_startDragThumbOffset != null);
16921704

16931705
final ScrollPosition position = _currentController!.position;
16941706
late double primaryDelta;
16951707
switch (position.axisDirection) {
16961708
case AxisDirection.up:
1697-
primaryDelta = _dragScrollbarAxisOffset!.dy - updatedOffset.dy;
1709+
primaryDelta = _startDragScrollbarAxisOffset!.dy - updatedOffset.dy;
16981710
break;
16991711
case AxisDirection.right:
1700-
primaryDelta = updatedOffset.dx -_dragScrollbarAxisOffset!.dx;
1712+
primaryDelta = updatedOffset.dx -_startDragScrollbarAxisOffset!.dx;
17011713
break;
17021714
case AxisDirection.down:
1703-
primaryDelta = updatedOffset.dy -_dragScrollbarAxisOffset!.dy;
1715+
primaryDelta = updatedOffset.dy -_startDragScrollbarAxisOffset!.dy;
17041716
break;
17051717
case AxisDirection.left:
1706-
primaryDelta = _dragScrollbarAxisOffset!.dx - updatedOffset.dx;
1718+
primaryDelta = _startDragScrollbarAxisOffset!.dx - updatedOffset.dx;
17071719
break;
17081720
}
17091721

17101722
// Convert primaryDelta, the amount that the scrollbar moved since the last
1711-
// time _updateScrollPosition was called, into the coordinate space of the scroll
1723+
// time when drag started, into the coordinate space of the scroll
17121724
// position, and jump to that position.
1713-
final double scrollOffsetLocal = scrollbarPainter.getTrackToScroll(primaryDelta);
1714-
final double scrollOffsetGlobal = scrollOffsetLocal + position.pixels;
1725+
final double scrollOffsetGlobal = scrollbarPainter.getTrackToScroll(primaryDelta + _startDragThumbOffset!);
17151726
if (scrollOffsetGlobal != position.pixels) {
17161727
// Ensure we don't drag into overscroll if the physics do not allow it.
17171728
final double physicsAdjustment = position.physics.applyBoundaryConditions(position, scrollOffsetGlobal);
@@ -1784,7 +1795,8 @@ class RawScrollbarState<T extends RawScrollbar> extends State<T> with TickerProv
17841795
}
17851796
_fadeoutTimer?.cancel();
17861797
_fadeoutAnimationController.forward();
1787-
_dragScrollbarAxisOffset = localPosition;
1798+
_startDragScrollbarAxisOffset = localPosition;
1799+
_startDragThumbOffset = scrollbarPainter.getThumbScrollOffset();
17881800
}
17891801

17901802
/// Handler called when a currently active long press gesture moves.
@@ -1803,7 +1815,6 @@ class RawScrollbarState<T extends RawScrollbar> extends State<T> with TickerProv
18031815
return;
18041816
}
18051817
_updateScrollPosition(localPosition);
1806-
_dragScrollbarAxisOffset = localPosition;
18071818
}
18081819

18091820
/// Handler called when a long press has ended.
@@ -1816,7 +1827,8 @@ class RawScrollbarState<T extends RawScrollbar> extends State<T> with TickerProv
18161827
return;
18171828
}
18181829
_maybeStartFadeoutTimer();
1819-
_dragScrollbarAxisOffset = null;
1830+
_startDragScrollbarAxisOffset = null;
1831+
_startDragThumbOffset = null;
18201832
_currentController = null;
18211833
}
18221834

@@ -1958,7 +1970,7 @@ class RawScrollbarState<T extends RawScrollbar> extends State<T> with TickerProv
19581970
scrollbarPainter.update(metrics, metrics.axisDirection);
19591971
}
19601972
} else if (notification is ScrollEndNotification) {
1961-
if (_dragScrollbarAxisOffset == null) {
1973+
if (_startDragScrollbarAxisOffset == null) {
19621974
_maybeStartFadeoutTimer();
19631975
}
19641976
}

packages/flutter/test/widgets/scrollbar_test.dart

+71
Original file line numberDiff line numberDiff line change
@@ -2717,4 +2717,75 @@ void main() {
27172717

27182718
expect(scrollController.offset, 0.0);
27192719
});
2720+
2721+
testWidgets('The thumb should follow the pointer when the scroll metrics changed during dragging', (WidgetTester tester) async {
2722+
// Regressing test for https://github.com/flutter/flutter/issues/112072
2723+
final ScrollController scrollController = ScrollController();
2724+
await tester.pumpWidget(
2725+
Directionality(
2726+
textDirection: TextDirection.ltr,
2727+
child: MediaQuery(
2728+
data: const MediaQueryData(),
2729+
child: PrimaryScrollController(
2730+
controller: scrollController,
2731+
child: RawScrollbar(
2732+
isAlwaysShown: true,
2733+
controller: scrollController,
2734+
child: CustomScrollView(
2735+
controller: scrollController,
2736+
// cacheExtent: double.maxFinite,
2737+
slivers: <Widget>[
2738+
SliverList(
2739+
delegate: SliverChildBuilderDelegate(
2740+
(BuildContext context, int index) {
2741+
final double height;
2742+
if (index < 10) {
2743+
height = 100;
2744+
} else {
2745+
height = 500;
2746+
}
2747+
return SizedBox(
2748+
height: height,
2749+
child: Text('$index'),
2750+
);
2751+
},
2752+
childCount: 100,
2753+
),
2754+
),
2755+
],
2756+
),
2757+
),
2758+
),
2759+
),
2760+
),
2761+
);
2762+
await tester.pumpAndSettle();
2763+
expect(scrollController.offset, 0.0);
2764+
2765+
// Drag the thumb down to scroll down.
2766+
const double scrollAmount = 100;
2767+
final TestGesture dragScrollbarGesture = await tester.startGesture(const Offset(797.0, 5.0));
2768+
await tester.pumpAndSettle();
2769+
await dragScrollbarGesture.moveBy(const Offset(0.0, scrollAmount));
2770+
await tester.pumpAndSettle();
2771+
2772+
await dragScrollbarGesture.moveBy(const Offset(0.0, scrollAmount));
2773+
await tester.pumpAndSettle();
2774+
2775+
await dragScrollbarGesture.up();
2776+
await tester.pumpAndSettle();
2777+
2778+
// The view has scrolled more than it would have by a swipe gesture of the
2779+
// same distance.
2780+
expect(scrollController.offset, greaterThan((100.0 * 10 + 500.0 * 90) / 3));
2781+
expect(
2782+
find.byType(RawScrollbar),
2783+
paints
2784+
..rect(rect: const Rect.fromLTRB(794.0, 0.0, 800.0, 600.0))
2785+
..rect(
2786+
rect: const Rect.fromLTRB(794.0, 200.0, 800.0, 218.0),
2787+
color: const Color(0x66BCBCBC),
2788+
),
2789+
);
2790+
});
27202791
}

0 commit comments

Comments
 (0)