fix: 🔨Fixed PR comments

Author: Sahil-Simform

lib/src/showcase/showcase.dart

@@ -559,8 +559,8 @@ class Showcase extends StatefulWidget {
 class _ShowcaseState extends State<Showcase> {
   ShowcaseController get _controller =>
       _showCaseWidgetState.getControllerForShowcase(
-        widget.showcaseKey,
-        _uniqueId,
+        key: widget.showcaseKey,
+        showcaseId: _uniqueId,
       );
 
   late var _showCaseWidgetState = ShowCaseWidget.of(context);

lib/src/showcase/showcase_controller.dart

@@ -283,40 +283,33 @@ class ShowcaseController {
   ///
   /// @return List of tooltip action widgets
   List<Widget> _getTooltipActions() {
-    final actionData = (config.tooltipActions?.isNotEmpty ?? false)
+    final doesHaveLocalActions = config.tooltipActions?.isNotEmpty ?? false;
+    final actionData = doesHaveLocalActions
         ? config.tooltipActions!
         : showCaseWidgetState.globalTooltipActions ?? [];
-
-    final actionWidgets = <Widget>[];
     final actionDataLength = actionData.length;
-    for (var i = 0; i < actionDataLength; i++) {
-      final action = actionData[i];
-
-      // Skip actions that should be hidden for this specific showcase key
-      // when no local actions are defined (using global actions)
-      if (action.hideActionWidgetForShowcase.contains(config.showcaseKey) &&
-          (config.tooltipActions?.isEmpty ?? true)) {
-        continue;
-      }
-
-      actionWidgets.add(
-        Padding(
-          padding: EdgeInsetsDirectional.only(
-            end: action == actionData.last
-                ? 0
-                : _getTooltipActionConfig().actionGap,
-          ),
-          child: TooltipActionButtonWidget(
-            config: action,
-            // We have to pass showcaseState from here because
-            // [TooltipActionButtonWidget] is not direct child of showcaseWidget
-            // so it won't be able to get the state by using it's context
-            showCaseState: showCaseWidgetState,
+
+    return [
+      for (var i = 0; i < actionDataLength; i++)
+        if (doesHaveLocalActions ||
+            !actionData[i]
+                .hideActionWidgetForShowcase
+                .contains(config.showcaseKey))
+          Padding(
+            padding: EdgeInsetsDirectional.only(
+              end: actionData[i] == actionData.last
+                  ? 0
+                  : _getTooltipActionConfig().actionGap,
+            ),
+            child: TooltipActionButtonWidget(
+              config: actionData[i],
+              // We have to pass showcaseState from here because
+              // [TooltipActionButtonWidget] is not direct child of showcaseWidget
+              // so it won't be able to get the state by using it's context
+              showCaseState: showCaseWidgetState,
+            ),
           ),
-        ),
-      );
-    }
-    return actionWidgets;
+    ];
   }
 
   /// Gets the tooltip action configuration

lib/src/showcase_widget.dart

@@ -170,6 +170,10 @@ class ShowCaseWidget extends StatefulWidget {
     this.hideFloatingActionWidgetForShowcase = const [],
   });
 
+  static GlobalKey? activeTargetWidget(BuildContext context) => context
+      .findAncestorStateOfType<ShowCaseWidgetState>()
+      ?.getCurrentActiveShowcaseKey;
+
   static ShowCaseWidgetState of(BuildContext context) {
     final state = context.findAncestorStateOfType<ShowCaseWidgetState>();
     if (state != null) {
@@ -270,7 +274,7 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
     super.initState();
     globalTooltipActions = widget.globalTooltipActions;
     globalTooltipActionConfig = widget.globalTooltipActionConfig;
-    initRootWidget();
+    _initRootWidget();
   }
 
   @override
@@ -369,7 +373,7 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
     next();
   }
 
-  void initRootWidget() {
+  void _initRootWidget() {
     WidgetsBinding.instance.addPostFrameCallback((_) {
       if (!mounted) return;
       final rootWidget = context.findRootAncestorStateOfType<State<Overlay>>();
@@ -383,34 +387,50 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
   /// Starts Showcase view from the beginning of specified list of widget ids.
   /// If this function is used when showcase has been disabled then it will
   /// throw an exception.
-  void startShowCase(List<GlobalKey> widgetIds) {
+  ///
+  /// [delay] is optional and it will be used to delay the start of showcase
+  /// which is useful when animation may take some time to complete.
+  ///
+  /// Refer this issue https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/issues/378
+  void startShowCase(
+    List<GlobalKey> widgetIds, {
+    Duration delay = Duration.zero,
+  }) {
     if (!enableShowcase) {
       throw Exception(
         "You are trying to start Showcase while it has been disabled with "
         "`enableShowcase` parameter to false from ShowCaseWidget",
       );
     }
-    if (!mounted) return;
-    ids = widgetIds;
-    activeWidgetId = 0;
-    _onStart();
-    updateOverlay?.call(isShowcaseRunning);
+    Future.delayed(
+      delay,
+      () {
+        if (!mounted) return;
+        ids = widgetIds;
+        activeWidgetId = 0;
+        _onStart();
+        updateOverlay?.call(isShowcaseRunning);
+      },
+    );
   }
 
   /// Completes showcase of given key and starts next one
   /// otherwise will finish the entire showcase view
-  Future<void> completed(GlobalKey? key) async {
+  void completed(GlobalKey? key) {
     if (ids != null && ids![activeWidgetId!] == key && mounted) {
-      await _onComplete();
-      if (!mounted) return;
-      activeWidgetId = activeWidgetId! + 1;
-      _onStart();
+      _onComplete().then(
+        (_) {
+          if (!mounted) return;
+          activeWidgetId = activeWidgetId! + 1;
+          _onStart();
 
-      if (activeWidgetId! >= ids!.length) {
-        _cleanupAfterSteps();
-        widget.onFinish?.call();
-      }
-      updateOverlay?.call(isShowcaseRunning);
+          if (activeWidgetId! >= ids!.length) {
+            _cleanupAfterSteps();
+            widget.onFinish?.call();
+          }
+          updateOverlay?.call(isShowcaseRunning);
+        },
+      );
     }
   }
 
@@ -446,18 +466,21 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
 
   /// Completes current active showcase and starts previous one
   /// otherwise will finish the entire showcase view
-  Future<void> previous() async {
+  void previous() {
     if (ids != null && ((activeWidgetId ?? 0) - 1) >= 0 && mounted) {
-      await _onComplete();
-      if (!mounted) return;
+      _onComplete().then(
+        (_) {
+          if (!mounted) return;
 
-      activeWidgetId = activeWidgetId! - 1;
-      _onStart();
-      if (activeWidgetId! >= ids!.length) {
-        _cleanupAfterSteps();
-        widget.onFinish?.call();
-      }
-      updateOverlay?.call(isShowcaseRunning);
+          activeWidgetId = activeWidgetId! - 1;
+          _onStart();
+          if (activeWidgetId! >= ids!.length) {
+            _cleanupAfterSteps();
+            widget.onFinish?.call();
+          }
+          updateOverlay?.call(isShowcaseRunning);
+        },
+      );
     }
   }
 
@@ -502,24 +525,18 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
   }
 
   Future<void> _onComplete() async {
-    final futures = <Future>[];
     final currentControllers = _getCurrentActiveControllers;
     final controllerLength = currentControllers.length;
 
-    for (var i = 0; i < controllerLength; i++) {
-      final controller = currentControllers[i];
-      if ((controller.config.disableScaleAnimation ??
-              widget.disableScaleAnimation) ||
-          controller.reverseAnimationCallback == null) {
-        continue;
-      }
-      futures.add(controller.reverseAnimationCallback!.call());
-    }
-    await Future.wait(futures);
+    await Future.wait([
+      for (var i = 0; i < controllerLength; i++)
+        if (!(currentControllers[i].config.disableScaleAnimation ??
+                widget.disableScaleAnimation) &&
+            currentControllers[i].reverseAnimationCallback != null)
+          currentControllers[i].reverseAnimationCallback!.call(),
+    ]);
     widget.onComplete?.call(activeWidgetId, ids![activeWidgetId!]);
-    if (widget.autoPlay) {
-      _cancelTimer();
-    }
+    if (widget.autoPlay) _cancelTimer();
   }
 
   void _cancelTimer() {
@@ -550,6 +567,13 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
     required ShowcaseController controller,
     required int showcaseId,
   }) {
+    assert(
+      () {
+        final stackTrace = StackTrace.current.toString();
+        return stackTrace.contains('_ShowcaseState');
+      }(),
+      'This method should only be called from Showcase class',
+    );
     _showcaseControllers
         .putIfAbsent(
           key,
@@ -566,16 +590,31 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
     required GlobalKey key,
     required int uniqueShowcaseKey,
   }) {
+    assert(
+      () {
+        final stackTrace = StackTrace.current.toString();
+        return stackTrace.contains('_ShowcaseState');
+      }(),
+      'This method should only be called from Showcase class',
+    );
     _showcaseControllers[key]?.remove(uniqueShowcaseKey);
   }
 
-  ShowcaseController getControllerForShowcase(
-    GlobalKey key,
-    int showcaseId,
-  ) {
+  ShowcaseController getControllerForShowcase({
+    required GlobalKey key,
+    required int showcaseId,
+  }) {
+    assert(
+      () {
+        final stackTrace = StackTrace.current.toString();
+        return stackTrace.contains('_ShowcaseState');
+      }(),
+      'This method should only be called from Showcase class',
+    );
     assert(
       _showcaseControllers[key]?[showcaseId] != null,
-      'Please register showcase controller first',
+      'Please register showcase controller first by calling '
+      'registerShowcaseController',
     );
     return _showcaseControllers[key]![showcaseId]!;
   }