fix: 🐛 Add ShowcaseView.isTargetRendered method to check if a target is currently rendered

Author: vatsaltanna

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Fixed [#650](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/650) - Fix null-check crash in ShowcaseService.getController during didUpdateWidget.
 - Fixed [#633](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/633) - Improve showcase flow by consolidating finish logic and handling missing targets
+- Fixed [#633](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/633) - Added `ShowcaseView.isTargetRendered` to detect whether a showcase target is currently rendered, replacing the 4.x.x `key.currentContext` / `key.currentWidget` check.
 
 ## [5.0.2]
 

doc/documentation.md

@@ -550,6 +550,33 @@ ShowcaseView.get().previous();
 ShowcaseView.get().dismiss();
 ```
 
+### Detecting Whether a Target Is Rendered
+
+Since 5.x.x, the `GlobalKey` passed to a `Showcase` is used only as a registry
+identifier and is no longer attached to the widget element. As a result,
+`key.currentContext` / `key.currentWidget` can no longer be used to detect
+whether a target widget is currently built (this worked in 4.x.x).
+
+Use `isTargetRendered` instead to check whether a showcase target exists before
+advancing — for example, to avoid stepping through targets that are not present
+in the widget tree:
+
+```dart
+final showcaseView = ShowcaseView.get();
+
+if (showcaseView.isTargetRendered(nextKey)) {
+  showcaseView.next();
+} else {
+  // The next target is not rendered yet — handle it (e.g. dismiss or wait).
+  showcaseView.dismiss();
+}
+```
+
+> Note: `isTargetRendered` reports whether the `Showcase` for the given key is
+> currently mounted in the widget tree, not whether it is visible on screen.
+> If you only want missing targets to be skipped automatically while the
+> showcase advances, use the `skipIfTargetNotPresent` parameter instead.
+
 ## Event Callbacks
 
 Handle showcase events:

lib/src/showcase/showcase_service.dart

@@ -128,6 +128,19 @@ class ShowcaseService {
   }) =>
       getScope(scope: scope).controllers;
 
+  /// Returns whether a [Showcase] registered with the given [key] is currently
+  /// mounted in the widget tree for the given [scope].
+  ///
+  /// A controller is registered in [Showcase]'s `initState` and removed in its
+  /// `dispose`, so the presence of a controller for [key] reflects whether the
+  /// target widget is currently built. This is useful to detect whether the
+  /// next showcase target exists before advancing the showcase.
+  ///
+  /// * [key] - The GlobalKey passed to the [Showcase] to check.
+  /// * [scope] - Optional scope name (defaults to [currentScope]).
+  bool isTargetRendered(GlobalKey key, {String? scope}) =>
+      getControllers(scope: scope ?? currentScope)[key]?.isNotEmpty ?? false;
+
   /// Returns the [ShowcaseView] from the specified scope.
   ///
   /// * [scope] - Optional scope name (defaults to [currentScope])

lib/src/showcase/showcase_view.dart

@@ -255,6 +255,26 @@ class ShowcaseView {
     _findEnclosingShowcaseView(widgetIds)._startShowcase(delay, widgetIds);
   }
 
+  /// Returns whether the [Showcase] registered with the given [key] is
+  /// currently rendered (mounted in the widget tree) within this scope.
+  ///
+  /// Since version 5.x.x the [GlobalKey] passed to [Showcase] is used as a
+  /// registry identifier and is no longer attached to the widget element, so
+  /// `key.currentContext` / `key.currentWidget` can no longer be used to detect
+  /// whether the target is built. Use this method instead, for example to check
+  /// if the next showcase target exists before calling [next]:
+  ///
+  /// ```dart
+  /// final showcaseView = ShowcaseView.get();
+  /// if (showcaseView.isTargetRendered(nextKey)) {
+  ///   showcaseView.next();
+  /// }
+  /// ```
+  ///
+  /// * [key] - The GlobalKey passed to the [Showcase] to check.
+  bool isTargetRendered(GlobalKey key) =>
+      ShowcaseService.instance.isTargetRendered(key, scope: scope);
+
   /// Moves to next showcase if possible.
   ///
   /// Will finish entire showcase if no more widgets to show.