Skip to content

Commit 7f3f057

Browse files
author
Kamil Klyta
committed
Update offsetToArmed docs
1 parent df6a5d4 commit 7f3f057

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/src/custom_refresh_indicator.dart

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,10 @@ class CustomRefreshIndicator extends StatefulWidget {
6969
/// Whether to display trailing scroll indicator
7070
final bool trailingScrollIndicatorVisible;
7171

72-
/// Number of pixels that user should drag to change [IndicatorState] from idle to armed.
72+
/// The distance in number of pixels that the user should drag to arm the indicator.
73+
/// The armed indicator will trigger the [onRefresh] function when the gesture is completed.
74+
///
75+
/// If not specified, [containerExtentPercentageToArmed] will be used instead.
7376
final double? offsetToArmed;
7477

7578
/// The distance the user must scroll for the indicator to be armed,

0 commit comments

Comments
 (0)