Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Commit c905a09

Browse files
authored
Add documentation for drag/fling offset in WidgetController. (#118288)
* Documentation for drag/fling offset * Fix typo * Fix typo 2 * Fix the docs_test * Fix the grammar
1 parent db8d1a4 commit c905a09

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

packages/flutter_test/lib/src/controller.dart

+14
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,16 @@ abstract class WidgetController {
562562
///
563563
/// {@macro flutter.flutter_test.WidgetController.tap.warnIfMissed}
564564
///
565+
/// {@template flutter.flutter_test.WidgetController.fling.offset}
566+
/// The `offset` represents a distance the pointer moves in the global
567+
/// coordinate system of the screen.
568+
///
569+
/// Positive [Offset.dy] values mean the pointer moves downward. Negative
570+
/// [Offset.dy] values mean the pointer moves upwards. Accordingly, positive
571+
/// [Offset.dx] values mean the pointer moves towards the right. Negative
572+
/// [Offset.dx] values mean the pointer moves towards left.
573+
/// {@endtemplate}
574+
///
565575
/// {@template flutter.flutter_test.WidgetController.fling}
566576
/// This can pump frames.
567577
///
@@ -817,6 +827,8 @@ abstract class WidgetController {
817827
/// The operation happens at once. If you want the drag to last for a period
818828
/// of time, consider using [timedDrag].
819829
///
830+
/// {@macro flutter.flutter_test.WidgetController.fling.offset}
831+
///
820832
/// {@template flutter.flutter_test.WidgetController.drag}
821833
/// By default, if the x or y component of offset is greater than
822834
/// [kDragSlopDefault], the gesture is broken up into two separate moves
@@ -953,6 +965,8 @@ abstract class WidgetController {
953965
///
954966
/// {@macro flutter.flutter_test.WidgetController.tap.warnIfMissed}
955967
///
968+
/// {@macro flutter.flutter_test.WidgetController.fling.offset}
969+
///
956970
/// This is the timed version of [drag]. This may or may not result in a
957971
/// [fling] or ballistic animation, depending on the speed from
958972
/// `offset/duration`.

0 commit comments

Comments
 (0)