feat: ✨ Added dynamic onComplete callback registration with addOnCompleteCallback and removeOnCompleteCallback methods (#601)

Author: vasu-nageshri

CHANGELOG.md

@@ -3,6 +3,7 @@
 - Fixed [#590](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/590) - Fixed Rendering issues with scrollable showcase views inside withWidget
 - Fixed [#587](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/587) - Fixed ShowcaseView.withWidget container positioning issues on web
 - Fixed [#588](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/588) & [#593](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/593) - Fixed incorrect ShowcaseView callback scope by adding optional scope parameter
+- Feature [#600](https://github.com/SimformSolutionsPvtLtd/showcaseview/issues/600) - Added dynamic onComplete callback registration with `addOnCompleteCallback` and `removeOnCompleteCallback` methods
 
 ## [5.0.1]
 

doc/documentation.md

@@ -570,6 +570,79 @@ ShowcaseView.register(
 )
 ```
 
+### Dynamic Callbacks
+
+You can also add and remove event callbacks dynamically at runtime. This is particularly useful when you need to register callbacks from widgets deeper in the tree or when using named scopes.
+
+#### OnComplete Callback
+
+Add or remove callbacks that trigger when each showcase step completes:
+
+```dart
+// Add a callback for when each showcase step completes
+ShowcaseView.get().addOnCompleteCallback((index, key) {
+  print('Showcase step $index completed with key: $key');
+  // Perform custom actions here
+});
+
+// Remove a previously added callback
+ShowcaseView.get().removeOnCompleteCallback(callbackFunction);
+```
+
+**Example with named scope:**
+
+```dart
+ShowcaseView.getNamed('profile').addOnCompleteCallback((index, key) {
+  print('Profile showcase completed at step $index');
+});
+```
+
+#### OnFinish Callback
+
+Add or remove callbacks that trigger when the entire showcase tour is finished:
+
+```dart
+// Add a callback for when the showcase tour is finished
+ShowcaseView.get().addOnFinishCallback(() {
+  print('Showcase tour finished');
+  // Perform custom actions here
+});
+
+// Remove a previously added callback
+ShowcaseView.get().removeOnFinishCallback(callbackFunction);
+```
+
+**Example with named scope:**
+
+```dart
+ShowcaseView.getNamed('profile').addOnFinishCallback(() {
+  print('Profile showcase tour finished');
+});
+```
+
+#### OnDismiss Callback
+
+Add or remove callbacks that trigger when the showcase is dismissed:
+
+```dart
+// Add a callback for when the showcase tour is dismissed
+ShowcaseView.get().addOnDismissCallback((reason) {
+  print('Showcase dismissed because: $reason');
+  // Perform custom actions here
+});
+
+// Remove a previously added callback
+ShowcaseView.get().removeOnDismissCallback(callbackFunction);
+```
+
+**Example with named scope:**
+
+```dart
+ShowcaseView.getNamed('profile').addOnDismissCallback((reason) {
+  print('Profile showcase dismissed because: $reason');
+});
+```
+
 ## Overriding Showcase View Configuration
 
 You can set global configurations for all showcases in your app by using ShowcaseView.register()

lib/src/showcase/showcase_view.dart

@@ -179,6 +179,9 @@ class ShowcaseView {
   /// Stores functions to call when a onDismiss event occurs.
   final List<OnDismissCallback> _onDismissCallbacks = [];
 
+  /// Stores functions to call when a onComplete event occurs.
+  final List<OnShowcaseCallback> _onCompleteCallbacks = [];
+
   /// Returns whether showcase is completed or not.
   bool get isShowCaseCompleted => _ids == null && _activeWidgetId == null;
 
@@ -287,6 +290,7 @@ class ShowcaseView {
 
     _onFinishCallbacks.clear();
     _onDismissCallbacks.clear();
+    _onCompleteCallbacks.clear();
   }
 
   /// Updates the overlay to reflect current showcase state.
@@ -335,6 +339,16 @@ class ShowcaseView {
     _onDismissCallbacks.remove(listener);
   }
 
+  /// Adds a listener that will be called when each showcase step completes.
+  void addOnCompleteCallback(OnShowcaseCallback listener) {
+    _onCompleteCallbacks.add(listener);
+  }
+
+  /// Removes a listener that was previously added via [addOnCompleteCallback].
+  void removeOnCompleteCallback(OnShowcaseCallback listener) {
+    _onCompleteCallbacks.remove(listener);
+  }
+
   void _startShowcase(
     Duration delay,
     List<GlobalKey<State<StatefulWidget>>> widgetIds,
@@ -491,6 +505,10 @@ class ShowcaseView {
     final activeId = _activeWidgetId ?? -1;
     if (activeId < (_ids?.length ?? activeId)) {
       onComplete?.call(activeId, _ids![activeId]);
+      // Call all registered onComplete callbacks
+      for (final callback in _onCompleteCallbacks) {
+        callback.call(activeId, _ids![activeId]);
+      }
     }
 
     if (autoPlay) _cancelTimer();