Unverified Commit 03683bf6 authored by xster's avatar xster Committed by GitHub

Add more doc linking the material and cupertino refresh controls (#15842)

* Add more doc linking the material and cupertino refresh controls

* review
parent 3a93061e
...@@ -242,7 +242,9 @@ typedef Future<void> RefreshCallback(); ...@@ -242,7 +242,9 @@ typedef Future<void> RefreshCallback();
/// Only one refresh can be triggered until the previous refresh has completed /// Only one refresh can be triggered until the previous refresh has completed
/// and the indicator sliver has retracted at least 90% of the way back. /// and the indicator sliver has retracted at least 90% of the way back.
/// ///
/// Can only be used in downward scrolling vertical lists. /// Can only be used in downward-scrolling vertical lists that overscrolls. In
/// other words, refreshes can't be triggered with lists using
/// [ClampingScrollPhysics].
/// ///
/// See also: /// See also:
/// ///
......
...@@ -74,7 +74,12 @@ enum _RefreshIndicatorMode { ...@@ -74,7 +74,12 @@ enum _RefreshIndicatorMode {
/// ///
/// * <https://material.google.com/patterns/swipe-to-refresh.html> /// * <https://material.google.com/patterns/swipe-to-refresh.html>
/// * [RefreshIndicatorState], can be used to programmatically show the refresh indicator. /// * [RefreshIndicatorState], can be used to programmatically show the refresh indicator.
/// * [RefreshProgressIndicator]. /// * [RefreshProgressIndicator], widget used by [RefreshIndicator] to show
/// the inner circular progress spinner during refreshes.
/// * [CupertinoRefreshControl], an iOS equivalent of the pull-to-refresh pattern.
/// Must be used as a sliver inside a [CustomScrollView] instead of wrapping
/// around a [ScrollView] because it's a part of the scrollable instead of
/// being overlaid on top of it.
class RefreshIndicator extends StatefulWidget { class RefreshIndicator extends StatefulWidget {
/// Creates a refresh indicator. /// Creates a refresh indicator.
/// ///
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment