release/v2.2.1

Author: gonuit

CHANGELOG.md

@@ -1,3 +1,5 @@
+## 2.2.1
+- Fixed typos in documentation
 ## 2.2.0
 - Added *clipBehavior* and the *elevation* arguments of the *MaterialIndicatorDelegate* class.
 ## 2.1.0
@@ -9,11 +11,11 @@
 - Added `autoRebuild` flag which is by default set to `true`.
   From now on, there is no need to wrap widgets in the builder function with the `AnimatedBuilder` widget, as it will be automatically rebuilt. For optimization purposes, you can use the old behavior by setting the `autoRebuild` argument to false.
 - Remove *IndicatorState.hiding* state. Instead introduced *IndicatorState.finalizing* and *IndicatorState.canceling*.
-- Splited *IndicatorState.loading* state into two phases: *IndicatorState.settling* and *IndicatorState.loading*.
+- Split *IndicatorState.loading* state into two phases: *IndicatorState.settling* and *IndicatorState.loading*.
 - Renamed `extentPercentageToArmed` argument to `containerExtentPercentageToArmed` which better describes what it exactly does.
 - Changed the default value of the `defaultContainerExtentPercentageToArmed` from `0.20` to `0.1(6)` to match the behavior of the built-in indicator widget.
 - Removed deprecated **IndicatorStateHelper** class. Instead use **CustomRefreshIndicator.onStateChanged** method.
-- Removed deprecated **leadingGlowVisible** and **trailingGlowVisible** arguments. Instead use **leadingScrollIndicatorVisible** and  **trailingScrollIndicatorVisible** accoringly.
+- Removed deprecated **leadingGlowVisible** and **trailingGlowVisible** arguments. Instead use **leadingScrollIndicatorVisible** and  **trailingScrollIndicatorVisible** accordingly.
 - Allow setting the edge of the list that will trigger the pull to refresh action.
   - Introduced **IndicatorEdge**, **IndicatorTrigger**, **IndicatorSide** and **IndicatorTriggerMode** classes.
   - Replaced **reversed** argument of the **CustomRefreshIndicator** class with **trigger**.
@@ -86,8 +88,8 @@
 ## 0.9.0-dev.1
 
 - Added optional `complete` indicator state together with `completeStateDuration` parameter.
-- `IndicatorControler` changes:
-  - Added `prevoiusState` property.
+- `IndicatorController` changes:
+  - Added `previousState` property.
   - Added `didStateChange` helper method.
   - Added `wasArmed`, `wasDragging`, `wasLoading`, `wasHiding` and `wasIdle` properties.
 - Added `notificationPredicate` property to the `CustomRefreshIndicator` widget.
@@ -103,7 +105,7 @@
   - `CustomRefreshIndicatorState` => `IndicatorState`
 - `indicatorBuilder` argument is no longer present. Instead use `builder` argument which has some significant changes.
 
-To animate indicator based on `IndicatorControler` you can use `AnimationBuilder` widget and pass `IndicatorData` object as `animation` argument. Because of that you can implement your own widget rebuild system what can improve your custom indicator performance (instead of building indicator eg. 300 times you can decide when you want to do it). Example:
+To animate indicator based on `IndicatorController` you can use `AnimationBuilder` widget and pass `IndicatorData` object as `animation` argument. Because of that you can implement your own widget rebuild system what can improve your custom indicator performance (instead of building indicator eg. 300 times you can decide when you want to do it). Example:
 
 ```dart
 return CustomRefreshIndicator(
@@ -123,7 +125,7 @@ return CustomRefreshIndicator(
         // IndicatorData extends ChangeNotifier class so it is possible to
         // assign it to an AnimationBuilder widget and take advantage of subtree rebuild
         animation: controller,
-        child: MyPrebuildWidget(),
+        child: MyWidget(),
         child: child,
         builder: (BuildContext context, Widget child) {
           /// TODO: Implement your custom refresh indicator
@@ -141,7 +143,7 @@ return CustomRefreshIndicator(
 
 ## 0.2.0
 
-- Added support for `BouncingScrollPhysics` - ios default sroll physics
+- Added support for `BouncingScrollPhysics` - ios default scroll physics
 - Improved readme
 
 ## 0.1.1

README.md

@@ -227,7 +227,7 @@ The following table describes each state of the indicator controller.
 | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **idle**       | In this state, the indicator is not visible. No user action is performed. Value remains at *0.0*.                                                                                                                                  |
 | **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*.                                        |
-| **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*.                                                                                         |
+| **canceling**  | The function *onRefresh* **has not been executed**, and the indicator is hiding from its current value that is lower than *1.0* to *0.0*.                                                                                         |
 | **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. |
 | **settling**   | The user has released the indicator in the armed state. The indicator settles on its target value *1.0*.                                                                                                                           |
 | **loading**    | The indicator has a target value of *1.0*. The *onRefresh* function is triggered.                                                                                                                                                  |

example/pubspec.lock

@@ -47,7 +47,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.2.0"
+    version: "2.2.1"
   fake_async:
     dependency: transitive
     description:

lib/src/custom_refresh_indicator.dart

@@ -185,7 +185,7 @@ class CustomRefreshIndicatorState extends State<CustomRefreshIndicator>
   // bool _canStart = false;
 
   /// Indicating that indicator is currently stopping drag.
-  /// When true, user is not able to performe any action.
+  /// When true, user is not able to perform any action.
   bool _isStopingDrag = false;
 
   late double _dragOffset;
@@ -450,7 +450,7 @@ class CustomRefreshIndicatorState extends State<CustomRefreshIndicator>
 
     final offsetToArmed = widget.offsetToArmed;
 
-    /// If [offestToArmed] is provided then it will be used otherwise
+    /// If [offsetToArmed] is provided then it will be used otherwise
     /// [extentPercentageToArmed]
     if (offsetToArmed != null) {
       newValue = _dragOffset / offsetToArmed;

pubspec.yaml

@@ -1,6 +1,6 @@
 name: custom_refresh_indicator
-description: Flutter Widget that make it easy to implement custom refresh indicator.
-version: 2.2.0
+description: Widget that makes it easy to implement a custom pull to refresh effect.
+version: 2.2.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