fix: 🐛 Fix clipper and documentation issues

Sahil-Simform · Sahil-Simform · commit 8e075ce61de9 · 2025-07-09T14:49:59.000+05:30
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -120,7 +120,8 @@ class _MailPageState extends State<MailPage> {
     //Start showcase view after current widget frames are drawn.
     WidgetsBinding.instance.addPostFrameCallback(
       (_) => ShowcaseView.get().startShowCase(
-          [_firstShowcaseWidget, _two, _three, _four, _lastShowcaseWidget]),
+        [_firstShowcaseWidget, _two, _three, _four, _lastShowcaseWidget],
+      ),
     );
     mails = [
       Mail(
@@ -192,6 +193,8 @@ class _MailPageState extends State<MailPage> {
   @override
   void dispose() {
     scrollController.dispose();
+    // Unregister the showcase view when the widget is disposed
+    ShowcaseView.get().unregister();
     super.dispose();
   }
 
diff --git a/lib/src/models/tooltip_action_config.dart b/lib/src/models/tooltip_action_config.dart
@@ -21,7 +21,7 @@
  */
 import 'package:flutter/material.dart';
 
-import '../../showcaseview.dart';
+import '../utils/enum.dart';
 
 class TooltipActionConfig {
   /// Configuration options for tooltip action buttons.
diff --git a/lib/src/showcase/showcase.dart b/lib/src/showcase/showcase.dart
@@ -25,7 +25,6 @@ import 'package:flutter/material.dart';
 import '../models/showcase_scope.dart';
 import '../models/tooltip_action_button.dart';
 import '../models/tooltip_action_config.dart';
-import '../showcase_widget.dart';
 import '../utils/constants.dart';
 import '../utils/enum.dart';
 import '../utils/overlay_manager.dart';
@@ -251,7 +250,7 @@ class Showcase extends StatefulWidget {
   /// A key that is unique across the entire app.
   ///
   /// This Key will be used to control state of individual showcase and also
-  /// used in [ShowcaseView.startShowcase] to define position of current
+  /// used in [ShowcaseView.setupShowcase] to define position of current
   /// target widget while showcasing.
   final GlobalKey showcaseKey;
 
diff --git a/lib/src/showcase/showcase_controller.dart b/lib/src/showcase/showcase_controller.dart
@@ -119,7 +119,7 @@ class ShowcaseController {
   /// tree.
   bool get _mounted => getState().mounted;
 
-  /// Callback to start the showcase.
+  /// Callback to setup the showcase.
   ///
   /// Initializes the showcase by calculating positions and preparing visual
   /// elements.
@@ -134,7 +134,7 @@ class ShowcaseController {
   ///
   /// This method is typically called internally by the showcase system but
   /// can also be called manually to force a recalculation of showcase elements.
-  void startShowcase({bool shouldUpdateOverlay = true}) {
+  void setupShowcase({bool shouldUpdateOverlay = true}) {
     if (!showcaseView.enableShowcase || !_mounted) return;
 
     recalculateRootWidgetSize(
@@ -144,13 +144,6 @@ class ShowcaseController {
     globalFloatingActionWidget = showcaseView
         .getFloatingActionWidget(config.showcaseKey)
         ?.call(_context);
-    // final size = rootWidgetSize ?? MediaQuery.sizeOf(_context);
-    // position ??= TargetPositionService(
-    //   rootRenderObject: rootRenderObject,
-    //   screenSize: size,
-    //   renderBox: _context.findRenderObject() as RenderBox?,
-    //   padding: config.targetPadding,
-    // );
   }
 
   /// Used to scroll the target into view.
@@ -175,25 +168,15 @@ class ShowcaseController {
     }
 
     isScrollRunning = true;
-    // updateControllerData();
-    startShowcase(shouldUpdateOverlay: shouldUpdateOverlay);
-    // OverlayManager.instance.update(
-    //   show: showcaseView.isShowcaseRunning,
-    //   scope: showcaseView.scope,
-    // );
+    setupShowcase(shouldUpdateOverlay: shouldUpdateOverlay);
     await Scrollable.ensureVisible(
       _context,
       duration: showcaseView.scrollDuration,
       alignment: config.scrollAlignment,
     );
 
     isScrollRunning = false;
-    // updateControllerData();
-    startShowcase(shouldUpdateOverlay: shouldUpdateOverlay);
-    // OverlayManager.instance.update(
-    //   show: showcaseView.isShowcaseRunning,
-    //   scope: showcaseView.scope,
-    // );
+    setupShowcase(shouldUpdateOverlay: shouldUpdateOverlay);
   }
 
   /// Handles tap on barrier area.
@@ -231,8 +214,6 @@ class ShowcaseController {
 
       _initRootWidget();
 
-      updateControllerData();
-
       if (shouldUpdateOverlay) {
         OverlayManager.instance.update(
           show: showcaseView.isShowcaseRunning,
diff --git a/lib/src/showcase/showcase_service.dart b/lib/src/showcase/showcase_service.dart
@@ -21,11 +21,11 @@
  */
 import 'package:flutter/widgets.dart';
 
-import '../../showcaseview.dart';
 import '../models/showcase_scope.dart';
 import '../utils/constants.dart';
 import '../utils/extensions.dart';
 import 'showcase_controller.dart';
+import 'showcase_view.dart';
 
 /// A scoped service locator for showcase functionality.
 ///
diff --git a/lib/src/showcase/showcase_view.dart b/lib/src/showcase/showcase_view.dart
@@ -62,20 +62,20 @@ class ShowcaseView {
   /// options like auto-play, animation, and many more.
   ShowcaseView.register({
     this.scope = Constants.defaultScope,
-    this.onFinish,
     this.onStart,
+    this.onFinish,
     this.onComplete,
     this.onDismiss,
+    this.enableShowcase = true,
     this.autoPlay = false,
     this.autoPlayDelay = Constants.defaultAutoPlayDelay,
     this.enableAutoPlayLock = false,
-    this.blurValue = 0,
-    this.scrollDuration = Constants.defaultScrollDuration,
-    this.disableMovingAnimation = false,
-    this.disableScaleAnimation = false,
     this.enableAutoScroll = false,
+    this.scrollDuration = Constants.defaultScrollDuration,
     this.disableBarrierInteraction = false,
-    this.enableShowcase = true,
+    this.disableScaleAnimation = false,
+    this.disableMovingAnimation = false,
+    this.blurValue = 0,
     this.globalTooltipActionConfig,
     this.globalTooltipActions,
     this.globalFloatingActionWidget,
@@ -263,10 +263,6 @@ class ShowcaseView {
     if (!_mounted) return;
 
     _cleanupAfterSteps();
-    OverlayManager.instance.update(
-      show: isShowcaseRunning,
-      scope: scope,
-    );
   }
 
   /// Cleans up resources when unregistering the showcase view.
@@ -321,7 +317,6 @@ class ShowcaseView {
       _ids = widgetIds;
       _activeWidgetId = 0;
       _onStart();
-      // OverlayManager.instance.update(show: isShowcaseRunning, scope: scope);
     } else {
       Future.delayed(delay, () => _startShowcase(Duration.zero, widgetIds));
     }
@@ -344,12 +339,13 @@ class ShowcaseView {
       (_) {
         if (!_mounted) return;
         _activeWidgetId = id;
-        _onStart();
+
         if (_activeWidgetId! >= _ids!.length) {
           _cleanupAfterSteps();
           onFinish?.call();
+        } else {
+          _onStart();
         }
-        OverlayManager.instance.update(show: isShowcaseRunning, scope: scope);
       },
     );
   }
@@ -418,7 +414,7 @@ class ShowcaseView {
         await firstController?.scrollIntoView();
       } else {
         for (var i = 0; i < controllerLength; i++) {
-          controllers[i].startShowcase(shouldUpdateOverlay: i == 0);
+          controllers[i].setupShowcase(shouldUpdateOverlay: i == 0);
         }
       }
     }
@@ -468,6 +464,7 @@ class ShowcaseView {
   void _cleanupAfterSteps() {
     _ids = _activeWidgetId = null;
     _cancelTimer();
+    OverlayManager.instance.update(show: isShowcaseRunning, scope: scope);
   }
 
   @override
diff --git a/lib/src/tooltip/render_position_delegate.dart b/lib/src/tooltip/render_position_delegate.dart
@@ -162,48 +162,10 @@ class _RenderPositionDelegate extends RenderBox
     // Final layout and positioning
     _performFinalChildLayout();
 
-    // _calculateAndSetFinalSize();
-
     // Cleanup
     RenderObjectManager.clear();
   }
 
-  /// Calculate and set the final size of the render object based on the bounds of its children
-  void _calculateAndSetFinalSize() {
-    // Start with an empty Rect to track the bounds
-    Rect bounds = Rect.zero;
-    bool firstChild = true;
-
-    // Iterate through all children to calculate the bounding box
-    var child = this.firstChild;
-    while (child != null) {
-      final childParentData = child.parentData! as MultiChildLayoutParentData;
-      final childRect = Rect.fromPoints(
-        childParentData.offset + Offset(child.size.width, child.size.height),
-        childParentData.offset + Offset(child.size.width, child.size.height),
-      );
-
-      // For the first child, initialize bounds; for others, expand it
-      if (firstChild) {
-        bounds = childRect;
-        firstChild = false;
-      } else {
-        bounds = bounds.expandToInclude(childRect);
-      }
-
-      child = childParentData.nextSibling;
-    }
-
-    // Add a small padding to ensure we don't clip any content
-    bounds = bounds.inflate(2.0);
-
-    // Constrain the size to the available constraints
-    final constrainedSize = constraints.constrain(bounds.size);
-
-    // Set the size of this render object to the calculated bounds
-    size = constrainedSize;
-  }
-
   /// Initialize layout variables and set size
   void _initializeLayout() {
     // Set size for this render object
diff --git a/lib/src/tooltip/tooltip_widget.dart b/lib/src/tooltip/tooltip_widget.dart
@@ -183,7 +183,7 @@ class _ToolTipWidgetState extends State<ToolTipWidget>
             child: GestureDetector(
               onTap: widget.onTooltipTap,
               child: Container(
-                padding: widget.tooltipPadding?.copyWith(left: 0, right: 0),
+                padding: widget.tooltipPadding.copyWith(left: 0, right: 0),
                 decoration: BoxDecoration(
                   color: widget.tooltipBackgroundColor,
                   borderRadius: widget.tooltipBorderRadius ??
@@ -195,8 +195,9 @@ class _ToolTipWidgetState extends State<ToolTipWidget>
                     if (widget.title case final title?)
                       DefaultTooltipTextWidget(
                         padding: (widget.titlePadding ?? EdgeInsets.zero).add(
-                          EdgeInsets.symmetric(
-                            horizontal: widget.tooltipPadding?.horizontal ?? 0,
+                          EdgeInsets.only(
+                            left: widget.tooltipPadding.left,
+                            right: widget.tooltipPadding.right,
                           ),
                         ),
                         text: title,
@@ -214,8 +215,8 @@ class _ToolTipWidgetState extends State<ToolTipWidget>
                         padding:
                             (widget.descriptionPadding ?? EdgeInsets.zero).add(
                           EdgeInsets.only(
-                            left: widget.tooltipPadding?.left ?? 0,
-                            right: widget.tooltipPadding?.right ?? 0,
+                            left: widget.tooltipPadding.left,
+                            right: widget.tooltipPadding.right,
                           ),
                         ),
                         text: desc,
@@ -233,8 +234,8 @@ class _ToolTipWidgetState extends State<ToolTipWidget>
                       ActionWidget(
                         tooltipActionConfig: widget.tooltipActionConfig,
                         outsidePadding: EdgeInsets.only(
-                          left: widget.tooltipPadding?.left ?? 0,
-                          right: widget.tooltipPadding?.right ?? 0,
+                          left: widget.tooltipPadding.left,
+                          right: widget.tooltipPadding.right,
                         ),
                         alignment: widget.tooltipActionConfig.alignment,
                         crossAxisAlignment:
@@ -295,8 +296,9 @@ class _ToolTipWidgetState extends State<ToolTipWidget>
             _TooltipLayoutId(
               id: TooltipLayoutSlot.arrow,
               child: CustomPaint(
-                painter:
-                    _ArrowPainter(strokeColor: widget.tooltipBackgroundColor!),
+                painter: _ArrowPainter(
+                  strokeColor: widget.tooltipBackgroundColor,
+                ),
                 size: const Size(Constants.arrowWidth, Constants.arrowHeight),
               ),
             ),
diff --git a/lib/src/utils/overlay_manager.dart b/lib/src/utils/overlay_manager.dart
@@ -24,10 +24,11 @@ import 'dart:ui';
 
 import 'package:flutter/material.dart';
 
-import '../../showcaseview.dart';
 import '../models/linked_showcase_data_model.dart';
+import '../showcase/showcase.dart';
 import '../showcase/showcase_controller.dart';
 import '../showcase/showcase_service.dart';
+import '../showcase/showcase_view.dart';
 import 'extensions.dart';
 import 'shape_clipper.dart';
 
diff --git a/lib/src/utils/shape_clipper.dart b/lib/src/utils/shape_clipper.dart
diff --git a/lib/src/widget/action_widget.dart b/lib/src/widget/action_widget.dart
diff --git a/lib/src/widget/tooltip_action_button_widget.dart b/lib/src/widget/tooltip_action_button_widget.dart
