feat: ✨ Multiple showcase at the same time and improvement #514

Sahil-Simform · 2025-03-19T10:31:32Z

Description

A feature was added to show multiple showcases at the same time.
Added controller to manage showcase functionality
Removed inherited widget, setState and key for improvement
Shifted overlay to showcase widget to effectively manage overlay for all showcases (Previously every showcase had its own overlay which was loaded whenever showcase was enabled)

Checklist

The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
I have followed the Contributor Guide when preparing my PR.
I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation in docs and added dartdoc comments with ///.
I have updated/added relevant examples in examples or docs.

Breaking Change?

Yes, this PR is a breaking change.
No, this PR is not a breaking change.

Related Issues

Closes #113

aditya-css · 2025-03-25T10:21:07Z

lib/src/get_position.dart

-    var renderBox = key.currentContext?.findRenderObject() as RenderBox?;
-
+  void _getRenderBox() {
+    final renderBox = context.findRenderObject() as RenderBox?;


Please take the box directly.

aditya-css · 2025-03-25T10:21:28Z

lib/src/constants.dart

+    borderRadius: BorderRadius.all(Radius.circular(8)),
+  );
+
+  static const Widget defaultProgressIndicator = CircularProgressIndicator(


Please use adaptive version.

README.md

aditya-css · 2025-03-25T10:27:12Z

lib/src/layout_overlays.dart

  void didUpdateWidget(OverlayBuilder oldWidget) {
    super.didUpdateWidget(oldWidget);
-    WidgetsBinding.instance.addPostFrameCallback((_) => syncWidgetAndOverlay());
+    if (oldWidget.showOverlay != widget.showOverlay && widget.showOverlay) {


Please simplify this.

aditya-css · 2025-03-25T10:29:51Z

lib/src/layout_overlays.dart

+  final bool showOverlay;
+  final WidgetBuilder? overlayBuilder;
+  final Widget child;
+  final ValueSetter<VoidCallback> updateOverlay;


Please convert this to static method.

When we convert this to a static method, it is causing an error in the showcase view widget, so we are keeping it the same.

aditya-css · 2025-03-25T12:37:40Z

lib/src/showcase_widget.dart

+    return Container(
+      alignment: Alignment.center,
+      decoration: BoxDecoration(
+        color: overlayColor
+
+            //TODO: Update when we remove support for older version
+            //ignore: deprecated_member_use
+            .withOpacity(overlayOpacity),
+      ),
+    );


Please switch to Align and ColoredBox.

aditya-css · 2025-03-25T12:39:04Z

lib/src/showcase_widget.dart

+      (_) {
+        updateOverlay?.call();
+      },


Please use expression body. And ensure that this call is needed twice.

lib/src/showcase_widget.dart

aditya-css · 2025-03-25T12:41:55Z

lib/src/showcase_widget.dart

+    }
+  }
+
+  void _stopTimer() {


This should be renamed I believe.

lib/src/tooltip/render_position_delegate.dart

aditya-css · 2025-03-27T06:30:51Z

lib/src/showcase/showcase.dart

+    showcaseController = ShowcaseController(
+      showcaseId: widget.hashCode,
+      showcaseKey: widget.showcaseKey,
+      showcaseConfig: widget,
+      scrollIntoView: _scrollIntoView,
+    )..startShowcase = startShowcase;
+
+    showCaseWidgetState.registerShowcaseController(
+      controller: showcaseController,
+      key: widget.showcaseKey,
+    );


Please keep single source of truth.

aditya-css · 2025-03-27T06:31:25Z

lib/src/showcase/showcase.dart

-      );
-      showOverlay();
-    }
+    showcaseController.showcaseConfig = widget;


Please see if this is absolutely required.

aditya-css · 2025-03-27T06:32:56Z

lib/src/showcase/showcase.dart

+
+    recalculateRootWidgetSize();
+
+    if (enableShowcase) {


Please invert this condition and return early.

aditya-css · 2025-03-27T06:38:09Z

lib/src/showcase/showcase.dart

        const TooltipActionConfig();
  }
+
+  void _updateControllerData(BuildContext context) {


Please keep functions testable.

aditya-css · 2025-03-27T09:37:40Z

lib/src/showcase_widget.dart

+    if (!disableBarrierInteraction &&
+        !firstShowcaseConfig.disableBarrierInteraction) {
+      next();
+    }


Please invert this condition and return early.

aditya-css · 2025-03-27T09:40:52Z

lib/src/showcase_widget.dart

+    if (_showcaseControllers.containsKey(key)) {
+      _showcaseControllers[key]!.add(controller);
+    } else {
+      _showcaseControllers[key] = [controller];
+    }


Please utilise putIfAbsent method.

aditya-css · 2025-03-27T09:44:30Z

lib/src/showcase_widget.dart

+    final currentControllers =
+        (_showcaseControllers[getCurrentActiveShowcaseKey] ??
+            <ShowcaseController>[]);


Please create a private getter for this.

aditya-css · 2025-03-31T05:50:54Z

lib/src/get_position.dart

-    var renderBox = key.currentContext?.findRenderObject() as RenderBox?;
+  Offset? _boxOffset;

+  void _getRenderBox() {


Please rename this to match the work its doing.

lib/src/layout_overlays.dart

aditya-css · 2025-03-31T05:54:02Z

lib/src/layout_overlays.dart

  Widget build(BuildContext context) {
-    buildOverlay();
-
-    return widget.child!;
+    return widget.child;
  }


Please make this expression body.

lib/src/showcase_widget.dart

aditya-css · 2025-03-31T06:02:52Z

lib/src/showcase_widget.dart

+              //ignore: deprecated_member_use
+              .withOpacity(firstShowcaseConfig.overlayOpacity),
+          child: const Align(
+            alignment: Alignment.center,


This might be the default parameter please check and remove if so.

aditya-css · 2025-03-31T06:08:14Z

lib/src/showcase_widget.dart

+      if (controllers.length == 1 &&
+          (controllers.first.showcaseConfig.enableAutoScroll ??


You can use firstOrNull here

This API has been available since SDK 3.0.0, but our constraints is '>=2.18.0 <4.0.0' so can not use that.
For now added TODO for the same

aditya-css · 2025-03-31T06:12:56Z

lib/src/showcase_widget.dart

+    int showcaseId,
+  ) {
+    assert(
+      _showcaseControllers.containsKey(key) &&


This can be avoided.

aditya-css · 2025-03-31T06:17:00Z

lib/src/showcase/showcase.dart

+    showCaseWidgetState
+        .getControllerForShowcase(
+          widget.showcaseKey,
+          _uniqueId,
+        )


Please use the created getter for this.

aditya-css · 2025-03-31T06:19:35Z

lib/src/showcase/showcase.dart

+    _globalFloatingActionWidget = showCaseWidgetState
+        .globalFloatingActionWidget(widget.showcaseKey)
+        ?.call(context);
+    final size = _controller.rootWidgetSize ?? MediaQuery.sizeOf(context);


Please ensure compatibility to the lowest version supported by this package.

aditya-css · 2025-03-31T06:22:47Z

lib/src/showcase/showcase.dart

  Future<void> _nextIfAny() async {
    if (showCaseWidgetState.isShowCaseCompleted) return;
-
-    if (timer != null && timer!.isActive) {
-      if (showCaseWidgetState.enableAutoPlayLock) {
-        return;
-      }
-      timer!.cancel();
-    } else if (timer != null && !timer!.isActive) {
-      timer = null;
-    }
-    await _reverseAnimateTooltip();
-    if (showCaseWidgetState.isShowCaseCompleted) return;
-    showCaseWidgetState.completed(widget.key);
+    showCaseWidgetState.completed(widget.showcaseKey);
  }


This can easily be moved to controller. Please check for other such methods and make the move.

related: feat: ✨ Multiple showcase at the same time and improvement SimformSolutionsPvtLtd#514 SimformSolutionsPvtLtd#514

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 4 times, most recently from dce2a62 to ce0b324 Compare March 21, 2025 06:21

feat: ✨ Added Multi Showcase functionality and improvements

67879cf

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 5 times, most recently from 93f75e4 to 407aa26 Compare March 25, 2025 09:12

fix: 🔨Fixed PR issue

c55862f

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from 407aa26 to c55862f Compare March 25, 2025 09:44

aditya-css requested changes Mar 25, 2025

View reviewed changes

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from ef77c3c to f5ea659 Compare March 26, 2025 06:34

fix: 🔨Fixed PR comments

228af1d

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from f5ea659 to 228af1d Compare March 27, 2025 05:39

aditya-css requested changes Mar 27, 2025

View reviewed changes

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 7 times, most recently from 14bdf3b to d50a933 Compare March 31, 2025 00:56

fix: 🔨Fixed PR comments

b476dc8

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from d50a933 to b476dc8 Compare March 31, 2025 04:38

aditya-css requested changes Mar 31, 2025

View reviewed changes

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 3 times, most recently from 3c7679d to e2721d8 Compare April 1, 2025 14:44

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 2 times, most recently from a70b882 to 01473f3 Compare April 2, 2025 06:46

fix: 🔨Fixed PR comments

1aa080d

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 9 times, most recently from e99bb01 to 0a6652b Compare April 3, 2025 11:11

fix: 🔨Fixed PR comments

9a94177

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from 0a6652b to 9a94177 Compare April 3, 2025 11:14

aditya-css approved these changes Apr 3, 2025

View reviewed changes

chore: 💥 Update min dart sdk to 2.19.6

5405eee

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from 5723af9 to 5405eee Compare April 3, 2025 12:07

fix: 🩹 Fixed the page transition issue

35ec3f7

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch 2 times, most recently from 3a8f599 to 703bfd8 Compare April 4, 2025 09:44

fix: 🩹 Shifted everything to showcase controller

ec0d57c

Sahil-Simform force-pushed the feature/multishowcase_and_improvement branch from 703bfd8 to ec0d57c Compare April 4, 2025 09:52

aditya-css approved these changes Apr 4, 2025

View reviewed changes

aditya-css merged commit 46c0dfc into master Apr 4, 2025
2 checks passed

aditya-css deleted the feature/multishowcase_and_improvement branch April 4, 2025 09:56

thanhle1547 added a commit to thanhle1547/flutter_showcaseview that referenced this pull request Dec 11, 2025

♻️🎨 Improve structure

65c7729

related: feat: ✨ Multiple showcase at the same time and improvement SimformSolutionsPvtLtd#514 SimformSolutionsPvtLtd#514

		if (controllers.length == 1 &&
		(controllers.first.showcaseConfig.enableAutoScroll ??

feat: ✨ Multiple showcase at the same time and improvement #514

feat: ✨ Multiple showcase at the same time and improvement #514

Uh oh!

Conversation

Sahil-Simform commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Breaking Change?

Related Issues

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sahil-Simform commented Mar 19, 2025 •

edited

Loading