v2.0.1

Author: Kamil Klyta

CHANGELOG.md

@@ -1,3 +1,5 @@
+## 2.0.1
+- Added missing *isCanceling* and *isSettling* getters for *IndicatorState* and *IndicatorController* enum.
 ## 2.0.0
 ## Breaking changes
 - Added `autoRebuild` flag which is by default set to `true`.

example/pubspec.lock

@@ -42,7 +42,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.0.0"
+    version: "2.0.1"
   fake_async:
     dependency: transitive
     description:

lib/src/controller.dart

@@ -134,12 +134,30 @@ class IndicatorController extends ChangeNotifier {
 
   /// Describes current [CustomRefreshIndicator] state
   IndicatorState get state => _currentState;
-  bool get isArmed => _currentState.isArmed;
+
+  /// {@macro custom_refresh_indicator.indicator_state.idle}
+  bool get isIdle => _currentState.isIdle;
+
+  /// {@macro custom_refresh_indicator.indicator_state.dragging}
   bool get isDragging => _currentState.isDragging;
+
+  /// {@macro custom_refresh_indicator.indicator_state.canceling}
+  bool get isCanceling => _currentState.isCanceling;
+
+  /// {@macro custom_refresh_indicator.indicator_state.armed}
+  bool get isArmed => _currentState.isArmed;
+
+  /// {@macro custom_refresh_indicator.indicator_state.settling}
+  bool get isSettling => _currentState.isSettling;
+
+  /// {@macro custom_refresh_indicator.indicator_state.loading}
   bool get isLoading => _currentState.isLoading;
+
+  /// {@macro custom_refresh_indicator.indicator_state.complete}
   bool get isComplete => _currentState.isComplete;
+
+  /// {@macro custom_refresh_indicator.indicator_state.finalizing}
   bool get isFinalizing => _currentState.isFinalizing;
-  bool get isIdle => _currentState.isIdle;
 
   bool _shouldStopDrag;
 

lib/src/data/indicator_state.dart

@@ -1,50 +1,82 @@
 /// Describes state of CustomRefreshIndicator widget.
 enum IndicatorState {
-  ///In this state, the indicator is not visible.
-  ///No user action is performed. Value remains at *0.0*.
+  /// {@template custom_refresh_indicator.indicator_state.idle}
+  /// In this state, the indicator is not visible.
+  /// No user action is performed. Value remains at *0.0*.
+  /// {@endtemplate}
   idle,
 
+  /// {@template custom_refresh_indicator.indicator_state.dragging}
   /// The user starts scrolling/dragging the pointer to refresh.
   /// Releasing the pointer in this state will not trigger
   /// the *onRefresh* function. The controller value changes
   /// from *0.0* to *1.0*.
+  /// {@endtemplate}
   dragging,
 
+  /// {@template custom_refresh_indicator.indicator_state.canceling}
   /// The function *onRefresh* **has not been executed**,
   /// and the indicator is hidding from its current value
   /// that is lower than *1.0* to *0.0*.
+  /// {@endtemplate}
   canceling,
 
+  /// {@template custom_refresh_indicator.indicator_state.armed}
   /// The user has dragged the pointer further than the distance
   /// declared by *containerExtentPercentageToArmed* or *offsetToArmed*
   /// (over the value of *1.0*). Releasing the pointer in this state will
   /// trigger the *onRefresh* function.
+  /// {@endtemplate}
   armed,
 
+  /// {@template custom_refresh_indicator.indicator_state.settling}
   /// The user has released the indicator in the armed state.
   /// The indicator settles on its target value *1.0*.
+  /// {@endtemplate}
   settling,
 
+  /// {@template custom_refresh_indicator.indicator_state.loading}
   /// The indicator is in its target value *1.0*.
   /// The *onRefresh* function is triggered.
+  /// {@endtemplate}
   loading,
 
+  /// {@template custom_refresh_indicator.indicator_state.complete}
   /// **OPTIONAL** - Provide `completeStateDuration` argument to enable it.
   /// The *onRefresh* callback has completed and the pointer remains
   /// at value *1.0* for the specified duration.
+  /// {@endtemplate}
   complete,
 
+  /// {@template custom_refresh_indicator.indicator_state.finalizing}
   /// The *onRefresh* function **has been executed**, and the indicator
   /// hides from the value *1.0* to *0.0*.
+  /// {@endtemplate}
   finalizing,
 }
 
 extension IndicatorStateGetters on IndicatorState {
+  /// {@macro custom_refresh_indicator.indicator_state.idle}
   bool get isIdle => this == IndicatorState.idle;
+
+  /// {@macro custom_refresh_indicator.indicator_state.dragging}
   bool get isDragging => this == IndicatorState.dragging;
-  bool get isArmed => this == IndicatorState.armed;
-  bool get isFinalizing => this == IndicatorState.finalizing;
+
+  /// {@macro custom_refresh_indicator.indicator_state.canceling}
   bool get isCanceling => this == IndicatorState.canceling;
+
+  /// {@macro custom_refresh_indicator.indicator_state.armed}
+  bool get isArmed => this == IndicatorState.armed;
+
+  /// {@macro custom_refresh_indicator.indicator_state.settling}
+  bool get isSettling => this == IndicatorState.settling;
+
+  /// {@macro custom_refresh_indicator.indicator_state.loading}
   bool get isLoading => this == IndicatorState.loading;
+
+  /// {@macro custom_refresh_indicator.indicator_state.complete}
   bool get isComplete => this == IndicatorState.complete;
+
+  /// {@macro custom_refresh_indicator.indicator_state.finalizing}
+  bool get isFinalizing => this == IndicatorState.finalizing;
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: custom_refresh_indicator
 description: Flutter Widget that make it easy to implement custom refresh indicator.
-version: 2.0.0
+version: 2.0.1
 repository: https://github.com/gonuit/flutter-custom-refresh-indicator
 issue_tracker: https://github.com/gonuit/flutter-custom-refresh-indicator/issues
 homepage: https://github.com/gonuit/flutter-custom-refresh-indicator

test/src/controller_test.dart

@@ -38,6 +38,8 @@ void main() {
     expect(controller.isArmed, isFalse);
     expect(controller.isLoading, isFalse);
     expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
     expect(controller.isRefreshEnabled, isTrue);
     expect(controller.isScrollIdle, isTrue);
     expect(controller.isScrollingForward, isFalse);
@@ -66,6 +68,8 @@ void main() {
     expect(controller.isArmed, isFalse);
     expect(controller.isLoading, isFalse);
     expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
 
     controller.setIndicatorState(IndicatorState.dragging);
     expect(controller.isIdle, isFalse);
@@ -74,6 +78,8 @@ void main() {
     expect(controller.isArmed, isFalse);
     expect(controller.isLoading, isFalse);
     expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
 
     controller.setIndicatorState(IndicatorState.finalizing);
     expect(controller.isIdle, isFalse);
@@ -82,6 +88,8 @@ void main() {
     expect(controller.isArmed, isFalse);
     expect(controller.isLoading, isFalse);
     expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
 
     controller.setIndicatorState(IndicatorState.armed);
     expect(controller.isIdle, isFalse);
@@ -90,6 +98,8 @@ void main() {
     expect(controller.isArmed, isTrue);
     expect(controller.isLoading, isFalse);
     expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
 
     controller.setIndicatorState(IndicatorState.loading);
     expect(controller.isIdle, isFalse);
@@ -98,6 +108,8 @@ void main() {
     expect(controller.isArmed, isFalse);
     expect(controller.isLoading, isTrue);
     expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
 
     controller.setIndicatorState(IndicatorState.complete);
     expect(controller.isIdle, isFalse);
@@ -106,6 +118,28 @@ void main() {
     expect(controller.isArmed, isFalse);
     expect(controller.isLoading, isFalse);
     expect(controller.isComplete, isTrue);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isFalse);
+
+    controller.setIndicatorState(IndicatorState.settling);
+    expect(controller.isIdle, isFalse);
+    expect(controller.isDragging, isFalse);
+    expect(controller.isFinalizing, isFalse);
+    expect(controller.isArmed, isFalse);
+    expect(controller.isLoading, isFalse);
+    expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isFalse);
+    expect(controller.isSettling, isTrue);
+
+    controller.setIndicatorState(IndicatorState.canceling);
+    expect(controller.isIdle, isFalse);
+    expect(controller.isDragging, isFalse);
+    expect(controller.isFinalizing, isFalse);
+    expect(controller.isArmed, isFalse);
+    expect(controller.isLoading, isFalse);
+    expect(controller.isComplete, isFalse);
+    expect(controller.isCanceling, isTrue);
+    expect(controller.isSettling, isFalse);
   });
 
   test("refresh changes correctly and notifies listeners", () {