feat: add CustomMaterialIndicator.adaptive constructor

Author: gonuit

lib/src/custom_refresh_indicator.dart

@@ -154,7 +154,7 @@ class CustomRefreshIndicator extends StatefulWidget {
     return notification.depth == 0;
   }
 
-  CustomRefreshIndicator({
+  const CustomRefreshIndicator({
     super.key,
     required this.child,
     required this.onRefresh,

lib/src/indicator_controller.dart

@@ -235,7 +235,7 @@ class IndicatorController extends Animation<double>
   ///
   /// - [min] represents the smallest value the animation can have.
   /// - [max] represents the largest value the animation can have.
-  /// 
+  ///
   /// If instead of transforming the entire range of controller values, you want to use only a specific range, see the [clamp] method.
   Animation<double> transform(double min, double max) => TransformedAnimation(
         parent: this,

lib/src/widgets/custom_material_indicator.dart

@@ -1,5 +1,6 @@
 import 'package:custom_refresh_indicator/custom_refresh_indicator.dart';
 import 'package:custom_refresh_indicator/src/custom_refresh_indicator.dart';
+import 'package:flutter/cupertino.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
@@ -111,6 +112,9 @@ class CustomMaterialIndicator extends StatefulWidget {
   /// [ColorScheme.primary] by default.
   final Color? color;
 
+  /// when true, the appropriate indicator should be selected depending on the platform.
+  final bool _isAdaptive;
+
   const CustomMaterialIndicator({
     super.key,
     required this.child,
@@ -140,7 +144,40 @@ class CustomMaterialIndicator extends StatefulWidget {
               (color == null && semanticsValue == null && semanticsLabel == null && strokeWidth == null),
           'When a custom indicatorBuilder is provided, the parameters color, semanticsValue, semanticsLabel and strokeWidth are unused and can be safely removed.',
         ),
-        strokeWidth = strokeWidth ?? RefreshProgressIndicator.defaultStrokeWidth;
+        strokeWidth = strokeWidth ?? RefreshProgressIndicator.defaultStrokeWidth,
+        _isAdaptive = false;
+
+  const CustomMaterialIndicator.adaptive({
+    super.key,
+    required this.child,
+    required this.onRefresh,
+    this.indicatorBuilder,
+    this.scrollableBuilder = _defaultBuilder,
+    this.notificationPredicate = CustomRefreshIndicator.defaultScrollNotificationPredicate,
+    this.backgroundColor,
+    this.displacement = 40.0,
+    this.edgeOffset = 0.0,
+    this.elevation = 2.0,
+    this.clipBehavior = Clip.none,
+    this.autoRebuild = true,
+    this.trigger = IndicatorTrigger.leadingEdge,
+    this.triggerMode = IndicatorTriggerMode.onEdge,
+    this.controller,
+    this.durations = const RefreshIndicatorDurations(),
+    this.onStateChanged,
+    this.leadingScrollIndicatorVisible = false,
+    this.trailingScrollIndicatorVisible = true,
+    double? strokeWidth,
+    this.semanticsLabel,
+    this.semanticsValue,
+    this.color,
+  })  : assert(
+          indicatorBuilder == null ||
+              (color == null && semanticsValue == null && semanticsLabel == null && strokeWidth == null),
+          'When a custom indicatorBuilder is provided, the parameters color, semanticsValue, semanticsLabel and strokeWidth are unused and can be safely removed.',
+        ),
+        strokeWidth = strokeWidth ?? RefreshProgressIndicator.defaultStrokeWidth,
+        _isAdaptive = true;
 
   static Widget _defaultBuilder(BuildContext context, Widget child, IndicatorController controller) => child;
 
@@ -182,7 +219,7 @@ class _CustomMaterialIndicatorState extends State<CustomMaterialIndicator> {
     );
   }
 
-  Widget _defaultIndicatorBuilder(BuildContext context, IndicatorController controller) {
+  Widget _defaultMaterialIndicatorBuilder(BuildContext context, IndicatorController controller) {
     final bool showIndeterminateIndicator = controller.isLoading || controller.isComplete || controller.isFinalizing;
 
     return RefreshProgressIndicator(
@@ -195,6 +232,12 @@ class _CustomMaterialIndicatorState extends State<CustomMaterialIndicator> {
     );
   }
 
+  Widget _defaultCupertinoIndicatorBuilder(BuildContext context, IndicatorController controller) {
+    return CupertinoActivityIndicator(
+      color: widget.color,
+    );
+  }
+
   late Animation<double> _valueAnimation;
   late Animation<Color?> _colorAnimation;
   late Color _indicatorColor;
@@ -242,7 +285,25 @@ class _CustomMaterialIndicatorState extends State<CustomMaterialIndicator> {
 
   @override
   Widget build(BuildContext context) {
-    final indicatorBuilder = widget.indicatorBuilder ?? _defaultIndicatorBuilder;
+    bool useMaterial = true;
+    if (widget._isAdaptive) {
+      final ThemeData theme = Theme.of(context);
+      switch (theme.platform) {
+        case TargetPlatform.android:
+        case TargetPlatform.fuchsia:
+        case TargetPlatform.linux:
+        case TargetPlatform.windows:
+          useMaterial = true;
+          break;
+        case TargetPlatform.iOS:
+        case TargetPlatform.macOS:
+          useMaterial = false;
+          break;
+      }
+    }
+
+    final MaterialIndicatorBuilder indicatorBuilder =
+        widget.indicatorBuilder ?? (useMaterial ? _defaultMaterialIndicatorBuilder : _defaultCupertinoIndicatorBuilder);
 
     return CustomRefreshIndicator(
       autoRebuild: false,
@@ -269,13 +330,15 @@ class _CustomMaterialIndicatorState extends State<CustomMaterialIndicator> {
             width: 41,
             height: 41,
             margin: const EdgeInsets.all(4.0),
-            child: Material(
-              type: MaterialType.circle,
-              clipBehavior: widget.clipBehavior,
-              color: _backgroundColor,
-              elevation: widget.elevation,
-              child: indicator,
-            ),
+            child: useMaterial
+                ? Material(
+                    type: MaterialType.circle,
+                    clipBehavior: widget.clipBehavior,
+                    color: _backgroundColor,
+                    elevation: widget.elevation,
+                    child: indicator,
+                  )
+                : indicator,
           );
         }