refactor: 🔨 Refactor considering Dart 3 support

Author: aditya-css

CHANGELOG.md

@@ -1,4 +1,4 @@
-## [4.1.0] - (UnRelease)
+## [5.0.0] - (UnRelease)
 - Feature [#500](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/issues/500) -
   Added `onDismiss` callback in `ShowCaseWidget` which will trigger whenever `onDismiss` method is
   called.
@@ -35,6 +35,8 @@
   `toolTipMargin` support for `Showcase.withWidget`
 - Feature [#520](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/issues/520) - Added
   `targetTooltipGap` to manage space between tooltip and target widget
+- Improvement [#530](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/pull/530) - 
+  Upgraded minimum dart sdk version to 3.0.0 and utilised Dart 3 features accordingly.
 
 ## [4.0.1]
 - Fixed [#493](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/issues/493) - ShowCase.withWidget not showing issue 

lib/showcaseview.dart

@@ -28,6 +28,6 @@ export 'src/models/tooltip_action_config.dart';
 export 'src/showcase/showcase.dart';
 export 'src/showcase/showcase_view.dart';
 export 'src/showcase_widget.dart';
-export 'src/utils/enum.dart';
+export 'src/utils/enum.dart' hide ShowcaseProgressType, TooltipLayoutSlot;
 export 'src/widget/floating_action_widget.dart';
 export 'src/widget/tooltip_action_button_widget.dart';

lib/src/models/showcase_scope.dart

@@ -25,7 +25,8 @@ import '../showcase/showcase_controller.dart';
 import '../showcase/showcase_view.dart';
 
 class ShowcaseScope {
-  /// A container class that manages showcase views within a specific named scope.
+  /// A container class that manages showcase views within a specific named
+  /// scope.
   ///
   /// This class is responsible for:
   /// - Maintain a reference to a named scope and its associated [ShowcaseView].

lib/src/models/tooltip_action_button.dart

@@ -24,48 +24,39 @@ import 'package:flutter/material.dart';
 import '../../showcaseview.dart';
 
 class TooltipActionButton {
-  /// A configuration for a tooltip action button or Provide a custom tooltip
-  /// action.
+  /// A class that defines interactive action buttons within showcase tooltips.
   ///
-  /// This class allows you to define predefined actions like "Next,"
-  /// "Previous," and "Close," or specify a custom action widget.
+  /// Provides a way to add interactive buttons to tooltips in the showcase
+  /// view. These buttons can perform standard navigation actions also
+  /// supports custom actions through callback functions and fully custom
+  /// button widgets.
   ///
-  /// **Required arguments:**
+  /// There are two ways to create tooltip action buttons:
+  /// 1. Using the default constructor for standard buttons with predefined
+  /// styles and standard action types (next, previous, skip).
+  /// 2. Using the [TooltipActionButton.custom] constructor for fully custom
+  /// button widgets.
   ///
-  /// - `type`: The type of the action button (e.g.,
-  /// `TooltipDefaultActionType.next`).
+  /// Tooltip action buttons can be used in two contexts:
+  /// - As local actions specific to a single showcase tooltip by providing
+  /// them in [Showcase.tooltipActions].
+  /// - As global actions that appear in all showcase tooltips by providing
+  /// them in [ShowcaseView.globalTooltipActions].
   ///
-  /// **Optional arguments:**
-  ///
-  /// - `backgroundColor`: The background color of the button
-  /// - `textStyle`: The text style for the button label.
-  /// - `borderRadius`: The border radius of the button. Defaults to a
-  /// rounded shape.
-  /// - `padding`: The padding around the button content.
-  /// - `leadIcon`: An optional leading icon for the button.
-  /// - `tailIcon`: An optional trailing icon for the button.
-  /// - `name`: The text for the button label (ignored if `type` is provided).
-  /// - `onTap`: A callback function triggered when the button is tapped.
-  /// - `border`: A border to draw around the button.
-  /// - `hideActionWidgetForShowcase`: A list of `GlobalKey`s of showcases
-  /// where this action widget should be hidden. This only works for global
-  /// action widgets.
+  /// The appearance and position of these buttons are controlled by the
+  /// [TooltipActionConfig] class, which can define whether the buttons appear
+  /// inside or outside the tooltip container and how they are aligned.
   const TooltipActionButton({
     required this.type,
+    this.borderRadius = const BorderRadius.all(Radius.circular(50)),
+    this.padding = const EdgeInsets.symmetric(horizontal: 15, vertical: 4),
+    this.hideActionWidgetForShowcase = const [],
     this.backgroundColor,
     this.textStyle,
-    this.borderRadius = const BorderRadius.all(
-      Radius.circular(50),
-    ),
-    this.padding = const EdgeInsets.symmetric(
-      horizontal: 15,
-      vertical: 4,
-    ),
     this.leadIcon,
     this.tailIcon,
     this.name,
     this.onTap,
-    this.hideActionWidgetForShowcase = const [],
     this.border,
   }) : button = null;
 
@@ -83,45 +74,51 @@ class TooltipActionButton {
         onTap = null,
         border = null;
 
-  /// To Provide Background color to the action
+  /// Background color for the action button.
+  ///
+  /// If not provided, theme's primary color will be used as default.
   final Color? backgroundColor;
 
-  /// To Provide borderRadius to the action
+  /// Border radius for the action button.
   ///
-  /// Defaults to const BorderRadius.all(Radius.circular(50)),
+  /// Defaults to a rounded shape with circular radius of 50.
   final BorderRadius? borderRadius;
 
-  /// To Provide textStyle to the action text
+  /// Text style for the button label.
+  ///
+  /// Controls the appearance of the text inside the button.
   final TextStyle? textStyle;
 
-  /// To Provide padding to the action widget
-  ///
-  /// Defaults to const EdgeInsets.symmetric(horizontal: 15,vertical: 4,)
+  /// Padding inside the action button.
   final EdgeInsets? padding;
 
-  /// To Provide a custom widget for the action in [TooltipActionButton.custom]
+  /// A custom widget to use instead of the default button appearance.
+  ///
+  /// When provided, most other appearance properties are ignored.
   final Widget? button;
 
-  /// To Provide a leading icon for the action
+  /// Icon to display before the button text.
   final ActionButtonIcon? leadIcon;
 
-  /// To Provide a tail icon for the action
+  /// Icon to display after the button text.
   final ActionButtonIcon? tailIcon;
 
-  /// To Provide a action type
+  /// Predefined action type that determines the button's default behavior.
   final TooltipDefaultActionType? type;
 
-  /// To Provide a text for action
+  /// Display text for the button.
   ///
-  /// If type is provided then it will take type name
+  /// If not provided, uses the name from the action type.
   final String? name;
 
-  /// To Provide a onTap for action
+  /// Callback function triggered when the button is tapped.
   ///
-  /// If type is provided then it will take type's OnTap
+  /// When provided, this overrides the default behavior of the action type.
   final VoidCallback? onTap;
 
-  /// To Provide a border for action
+  /// Border to apply around the button.
+  ///
+  /// Allows for custom border styling such as color, width, and style.
   final Border? border;
 
   /// Hides action widgets for the showcase. Add key of particular showcase

lib/src/models/tooltip_action_config.dart

@@ -36,40 +36,27 @@ class TooltipActionConfig {
     this.crossAxisAlignment = CrossAxisAlignment.start,
     this.textBaseline,
   }) : assert(
-          !identical(crossAxisAlignment, CrossAxisAlignment.stretch),
+          crossAxisAlignment != CrossAxisAlignment.stretch,
           'Can not use stretch as height is unbounded',
         );
 
-  /// Defines tooltip action widget position.
-  /// It can be inside the tooltip widget or outside.
-  ///
-  /// Default to [TooltipActionPosition.inside]
+  /// Defines tooltip action widget position. It can be inside the tooltip
+  /// widget or outside.
   final TooltipActionPosition position;
 
-  /// Defines the alignment of actions buttons of tooltip action widget
-  ///
-  /// Default to [MainAxisAlignment.spaceBetween]
+  /// Defines the alignment of actions buttons of tooltip action widget.
   final MainAxisAlignment alignment;
 
-  /// Defines the gap between the actions buttons of tooltip action widget
-  ///
-  /// Default to 5.0
+  /// Defines the gap between the actions buttons of tooltip action widget.
   final double actionGap;
 
   /// Defines vertically gap between tooltip content and actions.
-  ///
-  /// Default to 10.0
   final double gapBetweenContentAndAction;
 
   /// Defines running direction alignment for the Action widgets.
-  ///
-  /// Default to [CrossAxisAlignment.start]
   final CrossAxisAlignment crossAxisAlignment;
 
   /// If aligning items according to their baseline, which baseline to use.
-  ///
-  /// This must be set if using baseline alignment. There is no default
-  /// because there is no way for the framework to know the correct baseline
-  /// _a priori_.
+  /// This must be set if using baseline alignment.
   final TextBaseline? textBaseline;
 }