Deprecate leadingGlowVisible and trailingGlowVisible arguments

Author: gonuit

CHANGELOG.md

@@ -1,4 +1,4 @@
-## 1.1.0
+## 1.1.0-dev.1
 
 - Fixes:
   - Handle errors thrown from the `onRefresh` method.
@@ -13,6 +13,7 @@
   - The `IndicatorStateHelper` class is now deprecated in favor of `onStateChange` function and `IndicatorStateChange` class.
   - Initial support for programmatically-controlled indicators has been added. Added the `show`,` hide` and `refresh` methods to the` CustomRefreshIndicatorState` class. It can be accessed via GlobalKey. Take a look at an [programmatically-controlled screen example](/example/lib/screens/programmatically_controlled_indicator_screen.dart).
   - Use the `flutter_lints` package for analysis.
+  - Deprecate `leadingGlowVisible` and `trailingGlowVisible` in favor of `leadingScrollIndicatorVisible` and `trailingScrollIndicatorVisible` arguments.
 
 ## 1.0.0
 

example/lib/indicators/warp_indicator.dart

@@ -120,8 +120,8 @@ class _WarpIndicatorState extends State<WarpIndicator>
       key: widget.indicatorKey,
       controller: widget.controller,
       offsetToArmed: _indicatorSize,
-      leadingGlowVisible: false,
-      trailingGlowVisible: false,
+      leadingScrollIndicatorVisible: false,
+      trailingScrollIndicatorVisible: false,
       onRefresh: widget.onRefresh,
       onStateChanged: (change) {
         if (change.didChange(to: IndicatorState.loading)) {

example/lib/screens/example_indicator_screen.dart

@@ -16,9 +16,9 @@ class ExampleIndicatorScreen extends StatelessWidget {
       appBar: const ExampleAppBar(),
       body: SafeArea(
         child: CustomRefreshIndicator(
-          leadingGlowVisible: false,
+          leadingScrollIndicatorVisible: false,
+          trailingScrollIndicatorVisible: false,
           offsetToArmed: 200.0,
-          trailingGlowVisible: false,
           builder: customIndicator.builder,
           onRefresh: () => Future.delayed(const Duration(seconds: 2)),
           child: const ExampleList(),

example/lib/screens/presentation_screen.dart

@@ -27,8 +27,8 @@ class _PresentationScreenState extends State<PresentationScreen> {
           loadingToIdleDuration: const Duration(seconds: 1),
           armedToLoadingDuration: const Duration(seconds: 1),
           draggingToIdleDuration: const Duration(seconds: 1),
-          leadingGlowVisible: false,
-          trailingGlowVisible: false,
+          leadingScrollIndicatorVisible: false,
+          trailingScrollIndicatorVisible: false,
           offsetToArmed: 100.0,
           controller: _controller,
           onRefresh: () => Future.delayed(const Duration(seconds: 2)),

example/pubspec.lock

@@ -49,7 +49,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.1.0"
+    version: "1.1.0-dev.1"
   fake_async:
     dependency: transitive
     description:

lib/src/custom_refresh_indicator.dart

@@ -38,10 +38,10 @@ class CustomRefreshIndicator extends StatefulWidget {
   final ScrollNotificationPredicate notificationPredicate;
 
   /// Whether to display leading glow
-  final bool leadingGlowVisible;
+  final bool leadingScrollIndicatorVisible;
 
   /// Whether to display trailing glow
-  final bool trailingGlowVisible;
+  final bool trailingScrollIndicatorVisible;
 
   /// Number of pixels that user should drag to change [IndicatorState] from idle to armed.
   final double? offsetToArmed;
@@ -98,13 +98,21 @@ class CustomRefreshIndicator extends StatefulWidget {
     this.armedToLoadingDuration = const Duration(milliseconds: 200),
     this.loadingToIdleDuration = const Duration(milliseconds: 100),
     this.completeStateDuration,
-    this.leadingGlowVisible = false,
-    this.trailingGlowVisible = true,
+    @Deprecated('Deprecated in favor of leadingScrollIndicatorVisible argument.')
+        bool leadingGlowVisible = false,
+    @Deprecated('Deprecated in favor of trailingScrollIndicatorVisible argument.')
+        bool trailingGlowVisible = true,
+    bool? leadingScrollIndicatorVisible,
+    bool? trailingScrollIndicatorVisible,
   })  : assert(
           extentPercentageToArmed == null || offsetToArmed == null,
           'Providing `extentPercentageToArmed` argument take no effect when `offsetToArmed` is provided. '
           'Remove redundant argument.',
         ),
+        leadingScrollIndicatorVisible =
+            leadingScrollIndicatorVisible ?? leadingGlowVisible,
+        trailingScrollIndicatorVisible =
+            trailingScrollIndicatorVisible ?? trailingGlowVisible,
         super(key: key);
 
   @override
@@ -171,12 +179,18 @@ class CustomRefreshIndicatorState extends State<CustomRefreshIndicator>
   void _updateCustomRefreshIndicatorValue() =>
       _customRefreshIndicatorController.setValue(_animationController.value);
 
-  bool _handleGlowNotification(OverscrollIndicatorNotification notification) {
+  bool _handleScrollIndicatorNotification(
+    OverscrollIndicatorNotification notification,
+  ) {
     if (notification.depth != 0) return false;
     if (notification.leading) {
-      if (!widget.leadingGlowVisible) notification.disallowIndicator();
+      if (!widget.leadingScrollIndicatorVisible) {
+        notification.disallowIndicator();
+      }
     } else {
-      if (!widget.trailingGlowVisible) notification.disallowIndicator();
+      if (!widget.trailingScrollIndicatorVisible) {
+        notification.disallowIndicator();
+      }
     }
     return true;
   }
@@ -418,7 +432,7 @@ class CustomRefreshIndicatorState extends State<CustomRefreshIndicator>
       NotificationListener<ScrollNotification>(
         onNotification: _handleScrollNotification,
         child: NotificationListener<OverscrollIndicatorNotification>(
-          onNotification: _handleGlowNotification,
+          onNotification: _handleScrollIndicatorNotification,
           child: widget.child,
         ),
       ),

pubspec.yaml

@@ -1,6 +1,6 @@
 name: custom_refresh_indicator
 description: Flutter Widget that make it easy to implement custom refresh indicator.
-version: 1.1.0
+version: 1.1.0-dev.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