Improvement: Simplified slide indicator customization with new SlideIndicatorOptions class

ProV1X · ProV1X · commit 1edc580a3bc1 · 2024-07-01T13:37:51.000-04:00
Refactored all slide indicator properties into a new SlideIndicatorOptions class. This centralizes configuration, improving code readability, maintainability, and future extensibility.
diff --git a/lib/flutter_carousel_widget.dart b/lib/flutter_carousel_widget.dart
@@ -11,5 +11,6 @@ export 'package:flutter_carousel_widget/src/helpers/flutter_expandable_carousel_
 export 'package:flutter_carousel_widget/src/indicators/circular_slide_indicator.dart';
 export 'package:flutter_carousel_widget/src/indicators/circular_static_indicator.dart';
 export 'package:flutter_carousel_widget/src/indicators/circular_wave_slide_indicator.dart';
+export 'package:flutter_carousel_widget/src/indicators/models/slide_indicator_options_model.dart';
 export 'package:flutter_carousel_widget/src/indicators/sequential_fill_indicator.dart';
 export 'package:flutter_carousel_widget/src/indicators/slide_indicator.dart';
diff --git a/lib/src/indicators/circular_slide_indicator.dart b/lib/src/indicators/circular_slide_indicator.dart
@@ -1,62 +1,41 @@
 import 'package:flutter/material.dart';
+import 'package:flutter_carousel_widget/src/indicators/models/slide_indicator_options_model.dart';
 
 import 'slide_indicator.dart';
 
 class CircularSlideIndicator implements SlideIndicator {
   const CircularSlideIndicator(
-      {this.itemSpacing = 20,
-      this.indicatorRadius = 6,
-      this.indicatorBorderWidth = 1,
-      this.indicatorBorderColor,
-      this.padding,
-      this.alignment = Alignment.bottomCenter,
-      this.currentIndicatorColor,
-      this.indicatorBackgroundColor,
-      this.haloDecoration,
-      this.haloPadding});
+      {this.slideIndicatorOptions = const SlideIndicatorOptions()});
 
-  final AlignmentGeometry alignment;
-  final Color? currentIndicatorColor;
-  final Color? indicatorBackgroundColor;
-  final Color? indicatorBorderColor;
-  final double indicatorBorderWidth;
-  final double indicatorRadius;
-  final double itemSpacing;
-  final EdgeInsets? padding;
-  final BoxDecoration? haloDecoration;
-  final EdgeInsets? haloPadding;
+  final SlideIndicatorOptions slideIndicatorOptions;
 
   @override
   Widget build(int currentPage, double pageDelta, int itemCount) {
-    var activeColor = const Color(0xFFFFFFFF);
-    var backgroundColor = const Color(0x66FFFFFF);
-
-    // if (SchedulerBinding.instance.window.platformBrightness ==
-    //     Brightness.light) {
-    //   activeColor = const Color(0xFF000000);
-    //   backgroundColor = const Color.fromARGB(255, 163, 159, 159);
-    // }
-
     return Container(
-      alignment: alignment,
-      padding: padding,
+      alignment: slideIndicatorOptions.alignment,
+      padding: slideIndicatorOptions.padding,
       child: Container(
-        decoration: haloDecoration,
-        padding: haloPadding,
+        decoration: slideIndicatorOptions.enableHalo
+            ? slideIndicatorOptions.haloDecoration
+            : null,
+        padding: slideIndicatorOptions.enableHalo
+            ? slideIndicatorOptions.haloPadding
+            : null,
         child: SizedBox(
-          width: itemCount * itemSpacing,
-          height: indicatorRadius * 2,
+          width: itemCount * slideIndicatorOptions.itemSpacing,
+          height: slideIndicatorOptions.indicatorRadius * 2,
           child: CustomPaint(
             painter: CircularIndicatorPainter(
-              currentIndicatorColor: currentIndicatorColor ?? activeColor,
+              currentIndicatorColor:
+                  slideIndicatorOptions.currentIndicatorColor,
               indicatorBackgroundColor:
-                  indicatorBackgroundColor ?? backgroundColor,
+                  slideIndicatorOptions.indicatorBackgroundColor,
               currentPage: currentPage,
               pageDelta: pageDelta,
               itemCount: itemCount,
-              radius: indicatorRadius,
-              indicatorBorderColor: indicatorBorderColor,
-              borderWidth: indicatorBorderWidth,
+              radius: slideIndicatorOptions.indicatorRadius,
+              indicatorBorderColor: slideIndicatorOptions.indicatorBorderColor,
+              borderWidth: slideIndicatorOptions.indicatorBorderWidth,
             ),
           ),
         ),
diff --git a/lib/src/indicators/circular_static_indicator.dart b/lib/src/indicators/circular_static_indicator.dart
@@ -1,65 +1,37 @@
 import 'package:flutter/material.dart';
-
-import 'slide_indicator.dart';
+import 'package:flutter_carousel_widget/flutter_carousel_widget.dart';
 
 class CircularStaticIndicator extends SlideIndicator {
-  CircularStaticIndicator(
-      {this.itemSpacing = 20,
-      this.indicatorRadius = 6,
-      this.padding,
-      this.alignment = Alignment.bottomCenter,
-      this.currentIndicatorColor,
-      this.indicatorBackgroundColor,
-      this.enableAnimation = false,
-      this.indicatorBorderWidth = 1,
-      this.indicatorBorderColor,
-      this.haloDecoration,
-      this.haloPadding});
+  CircularStaticIndicator({
+    this.slideIndicatorOptions = const SlideIndicatorOptions(),
+  });
 
-  final AlignmentGeometry alignment;
-  final Color? currentIndicatorColor;
-  final bool enableAnimation;
-  final Color? indicatorBackgroundColor;
-  final Color? indicatorBorderColor;
-  final double indicatorBorderWidth;
-  final double indicatorRadius;
-  final double itemSpacing;
-  final EdgeInsets? padding;
-  final BoxDecoration? haloDecoration;
-  final EdgeInsets? haloPadding;
+  final SlideIndicatorOptions slideIndicatorOptions;
 
   @override
   Widget build(int currentPage, double pageDelta, int itemCount) {
-    var activeColor = const Color(0xFFFFFFFF);
-    var backgroundColor = const Color(0x66FFFFFF);
-
-    // if (SchedulerBinding.instance.window.platformBrightness ==
-    //     Brightness.light) {
-    //   activeColor = const Color(0xFF000000);
-    //   backgroundColor = const Color(0xFF878484);
-    // }
-
     return Container(
-      alignment: alignment,
-      padding: padding,
+      alignment: slideIndicatorOptions.alignment,
+      padding: slideIndicatorOptions.padding,
       child: Container(
-        decoration: haloDecoration,
-        padding: haloPadding,
+        decoration: slideIndicatorOptions.haloDecoration,
+        padding: slideIndicatorOptions.haloPadding,
         child: SizedBox(
-          width: itemCount * itemSpacing,
-          height: indicatorRadius * 2,
+          width: itemCount * slideIndicatorOptions.itemSpacing,
+          height: slideIndicatorOptions.indicatorRadius * 2,
           child: CustomPaint(
             painter: CircularStaticIndicatorPainter(
-              currentIndicatorColor: currentIndicatorColor ?? activeColor,
+              currentIndicatorColor:
+                  slideIndicatorOptions.currentIndicatorColor,
               indicatorBackgroundColor:
-                  indicatorBackgroundColor ?? backgroundColor,
+                  slideIndicatorOptions.indicatorBackgroundColor,
               currentPage: currentPage,
               pageDelta: pageDelta,
               itemCount: itemCount,
-              radius: indicatorRadius,
-              enableAnimation: enableAnimation,
-              indicatorBorderColor: indicatorBorderColor,
-              borderWidth: indicatorBorderWidth,
+              radius: slideIndicatorOptions.indicatorRadius,
+              enableAnimation: slideIndicatorOptions.enableAnimation,
+              indicatorBorderColor: slideIndicatorOptions.indicatorBorderColor,
+              borderWidth: slideIndicatorOptions.indicatorBorderWidth,
             ),
           ),
         ),
diff --git a/lib/src/indicators/circular_wave_slide_indicator.dart b/lib/src/indicators/circular_wave_slide_indicator.dart
@@ -1,62 +1,40 @@
 import 'package:flutter/material.dart';
-
-import 'slide_indicator.dart';
+import 'package:flutter_carousel_widget/flutter_carousel_widget.dart';
 
 class CircularWaveSlideIndicator implements SlideIndicator {
-  CircularWaveSlideIndicator(
-      {this.itemSpacing = 20,
-      this.indicatorRadius = 6,
-      this.padding,
-      this.alignment = Alignment.bottomCenter,
-      this.currentIndicatorColor,
-      this.indicatorBackgroundColor,
-      this.indicatorBorderWidth = 1,
-      this.indicatorBorderColor,
-      this.haloDecoration,
-      this.haloPadding});
+  CircularWaveSlideIndicator({
+    this.slideIndicatorOptions = const SlideIndicatorOptions(),
+  });
 
-  final AlignmentGeometry alignment;
-  final Color? currentIndicatorColor;
-  final Color? indicatorBackgroundColor;
-  final Color? indicatorBorderColor;
-  final double indicatorBorderWidth;
-  final double indicatorRadius;
-  final double itemSpacing;
-  final EdgeInsets? padding;
-  final BoxDecoration? haloDecoration;
-  final EdgeInsets? haloPadding;
+  final SlideIndicatorOptions slideIndicatorOptions;
 
   @override
   Widget build(int currentPage, double pageDelta, int itemCount) {
-    var activeColor = const Color(0xFFFFFFFF);
-    var backgroundColor = const Color(0x66FFFFFF);
-
-    // if (SchedulerBinding.instance.window.platformBrightness ==
-    //     Brightness.light) {
-    //   activeColor = const Color(0xFF000000);
-    //   backgroundColor = const Color(0xFF878484);
-    // }
-
     return Container(
-      alignment: alignment,
-      padding: padding,
+      alignment: slideIndicatorOptions.alignment,
+      padding: slideIndicatorOptions.padding,
       child: Container(
-        decoration: haloDecoration,
-        padding: haloPadding,
+        decoration: slideIndicatorOptions.enableHalo
+            ? slideIndicatorOptions.haloDecoration
+            : null,
+        padding: slideIndicatorOptions.enableHalo
+            ? slideIndicatorOptions.haloPadding
+            : null,
         child: SizedBox(
-          width: itemCount * itemSpacing,
-          height: indicatorRadius * 2,
+          width: itemCount * slideIndicatorOptions.itemSpacing,
+          height: slideIndicatorOptions.indicatorRadius * 2,
           child: CustomPaint(
             painter: CircularWaveIndicatorPainter(
-              currentIndicatorColor: currentIndicatorColor ?? activeColor,
+              currentIndicatorColor:
+                  slideIndicatorOptions.currentIndicatorColor,
               indicatorBackgroundColor:
-                  indicatorBackgroundColor ?? backgroundColor,
+                  slideIndicatorOptions.indicatorBackgroundColor,
               currentPage: currentPage,
               pageDelta: pageDelta,
               itemCount: itemCount,
-              radius: indicatorRadius,
-              indicatorBorderColor: indicatorBorderColor,
-              borderWidth: indicatorBorderWidth,
+              radius: slideIndicatorOptions.indicatorRadius,
+              indicatorBorderColor: slideIndicatorOptions.indicatorBorderColor,
+              borderWidth: slideIndicatorOptions.indicatorBorderWidth,
             ),
           ),
         ),
diff --git a/lib/src/indicators/models/slide_indicator_options_model.dart b/lib/src/indicators/models/slide_indicator_options_model.dart
@@ -0,0 +1,127 @@
+import 'package:flutter/cupertino.dart';
+import 'package:flutter/material.dart';
+
+/// A class that holds the options for the slide indicators.
+class SlideIndicatorOptions {
+  const SlideIndicatorOptions({
+    this.alignment = Alignment.bottomCenter,
+    this.currentIndicatorColor = const Color(0xFFFFFFFF),
+    this.indicatorBackgroundColor = const Color(0x66FFFFFF),
+    this.indicatorBorderColor,
+    this.indicatorBorderWidth = 1,
+    this.indicatorRadius = 6,
+    this.itemSpacing = 20,
+    this.padding,
+    this.haloDecoration = const BoxDecoration(
+      color: Color(0x33000000),
+      borderRadius: BorderRadius.all(Radius.circular(15.0)),
+    ),
+    this.haloPadding = const EdgeInsets.all(8.0),
+    this.enableHalo = false,
+    this.enableAnimation = false,
+  })  : assert(indicatorRadius > 0),
+        assert(itemSpacing >= 0),
+        assert(indicatorBorderWidth >= 0);
+
+  /// The alignment of the indicator.
+  final AlignmentGeometry alignment;
+
+  /// The color of the currently active item indicator.
+  final Color currentIndicatorColor;
+
+  /// The background color of all inactive item indicators.
+  final Color indicatorBackgroundColor;
+
+  /// The border color of all item indicators.
+  final Color? indicatorBorderColor;
+
+  /// The border width of all item indicators.
+  final double indicatorBorderWidth;
+
+  /// The radius of all item indicators.
+  final double indicatorRadius;
+
+  /// The spacing between each item indicator.
+  final double itemSpacing;
+
+  /// The padding of the indicator.
+  final EdgeInsets? padding;
+
+  /// The decoration of the indicator halo.
+  final BoxDecoration haloDecoration;
+
+  /// The padding of the indicator halo.
+  final EdgeInsets haloPadding;
+
+  /// Whether to enable the indicator halo.
+  final bool enableHalo;
+
+  /// Whether to enable the animation. Only used in [CircularStaticIndicator] and [andSequentialFillIndicator].
+  final bool enableAnimation;
+
+  /// Returns a copy of this [SlideIndicatorOptions] but with the given fields replaced with the new values.
+  SlideIndicatorOptions copyWith({
+    AlignmentGeometry? alignment,
+    Color? currentIndicatorColor,
+    Color? indicatorBackgroundColor,
+    Color? indicatorBorderColor,
+    double? indicatorBorderWidth,
+    double? indicatorRadius,
+    double? itemSpacing,
+    EdgeInsets? padding,
+    BoxDecoration? haloDecoration,
+    EdgeInsets? haloPadding,
+    bool? enableHalo,
+  }) {
+    return SlideIndicatorOptions(
+      alignment: alignment ?? this.alignment,
+      currentIndicatorColor:
+          currentIndicatorColor ?? this.currentIndicatorColor,
+      indicatorBackgroundColor:
+          indicatorBackgroundColor ?? this.indicatorBackgroundColor,
+      indicatorBorderColor: indicatorBorderColor ?? this.indicatorBorderColor,
+      indicatorBorderWidth: indicatorBorderWidth ?? this.indicatorBorderWidth,
+      indicatorRadius: indicatorRadius ?? this.indicatorRadius,
+      itemSpacing: itemSpacing ?? this.itemSpacing,
+      padding: padding ?? this.padding,
+      haloDecoration: haloDecoration ?? this.haloDecoration,
+      haloPadding: haloPadding ?? this.haloPadding,
+      enableHalo: enableHalo ?? this.enableHalo,
+    );
+  }
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+
+    return other is SlideIndicatorOptions &&
+        other.alignment == alignment &&
+        other.currentIndicatorColor == currentIndicatorColor &&
+        other.indicatorBackgroundColor == indicatorBackgroundColor &&
+        other.indicatorBorderColor == indicatorBorderColor &&
+        other.indicatorBorderWidth == indicatorBorderWidth &&
+        other.indicatorRadius == indicatorRadius &&
+        other.itemSpacing == itemSpacing &&
+        other.padding == padding &&
+        other.haloDecoration == haloDecoration &&
+        other.haloPadding == haloPadding &&
+        other.enableHalo == enableHalo;
+  }
+
+  @override
+  int get hashCode {
+    return Object.hash(
+      alignment,
+      currentIndicatorColor,
+      indicatorBackgroundColor,
+      indicatorBorderColor,
+      indicatorBorderWidth,
+      indicatorRadius,
+      itemSpacing,
+      padding,
+      haloDecoration,
+      haloPadding,
+      enableHalo,
+    );
+  }
+}
diff --git a/lib/src/indicators/sequential_fill_indicator.dart b/lib/src/indicators/sequential_fill_indicator.dart
