feat: ✨Add staticContainer into ToolTipWidget for a custom tooltip th… #396

MichaelCadavillo · 2023-09-21T10:23:38Z

feat: ✨Provided a parameter to add a static widget which can be placed anywhere on the screen and is not affected by the animation.

Description

Implemented a FloatingActionWidget to show static widget at any place on the screen. Primarily used for when we want to show another widget (perhaps a 'Skip Showcases' button) which is not affected by the animation that is given to the tooltip.
We have also added a directional constructor for the use cases where directionality is important.

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 #395

Sample implementation

Screen_recording_20241203_180104.webm

erperejildo · 2024-04-26T08:49:42Z

I need to integrate a skip button and I don't want to rely on custom buttons for now if this is going to be implemented. This was opened 7 months ago. Any plan to merge this soon?

erperejildo · 2024-05-15T14:58:56Z

@aditya-css any update?

mgaucher · 2024-06-04T13:50:09Z

Is it possible to add it for the Showcase() constructor too ? (when container is null)

omi-jeybsbaterna · 2024-10-17T01:55:36Z

any update on this PR?

aditya-css

Please also consider providing an option to disable the global floating action widget for particular showcase.

aditya-css · 2024-12-03T05:14:07Z

README.md

Please update for globalFloatingActionWidget as well.

aditya-css · 2024-12-03T05:14:25Z

example/lib/main.dart

+                          child: ElevatedButton(
+                            style: ButtonStyle(
+                              backgroundColor: MaterialStateProperty.all<Color>(
+                                  Theme.of(context).primaryColor),
+                              shape: MaterialStateProperty.all<
+                                  RoundedRectangleBorder>(
+                                RoundedRectangleBorder(
+                                  borderRadius: BorderRadius.circular(18.0),
+                                  side: BorderSide(
+                                    color: Theme.of(context).primaryColor,
+                                    width: 2.0,
+                                  ),
+                                ),
+                              ),
+                            ),


Please keep this minimal.

aditya-css · 2024-12-03T05:28:02Z

lib/src/widget/floating_action_widget.dart

+    double? left;
+    double? right;


Please have default values.

aditya-css · 2024-12-03T07:59:49Z

lib/src/showcase.dart

@@ -777,6 +785,8 @@ class _ShowcaseState extends State<Showcase> {
            titleTextStyle: widget.titleTextStyle,
            descTextStyle: widget.descTextStyle,
            container: widget.container,
+            floatingActionWidget: widget.floatingActionWidget ??
+                showCaseWidgetState.globalFloatingActionWidget?.call(context),


Please take this as late class member as to avoid calling this function over and over again.

aditya-css · 2024-12-03T08:00:54Z

lib/src/showcase_widget.dart

+  /// Hides [globalFloatingActionWidget] for the provided showcase widgets. Add key of
+  /// showcase in which [globalFloatingActionWidget] should be hidden this list.
+  /// Defaults to [].
+  final List<GlobalKey> hideFloatingActionWidgetForShowcase;


This should rather be a function as to make it more dynamic.

aditya-css · 2024-12-03T08:01:27Z

lib/src/showcase_widget.dart

+  /// Return a [widget.globalFloatingActionWidget] if not need to hide this for
+  /// current showcase
+  FloatingActionWidget Function(BuildContext)? get globalFloatingActionWidget =>
+      widget.hideFloatingActionWidgetForShowcase.contains(ids![activeWidgetId!])


Please avoid force null checks.

aditya-css · 2024-12-03T08:02:24Z

lib/src/tooltip_widget.dart

@@ -651,8 +654,22 @@ class _ToolTipWidgetState extends State<ToolTipWidget>
          ),
        ),
      );
+
+      if (widget.floatingActionWidget != null) {


Please prefer positive condition.

aditya-css · 2024-12-03T08:04:10Z

lib/src/showcase_widget.dart

@@ -187,6 +202,13 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
  /// Returns value of [ShowCaseWidget.blurValue]
  double get blurValue => widget.blurValue;

+  /// Return a [widget.globalFloatingActionWidget] if not need to hide this for
+  /// current showcase
+  FloatingActionWidget Function(BuildContext)? get globalFloatingActionWidget =>


Please use typedef.

…at can be placed anywhere on screen and is not affected by the animation Signed-off-by: Michael Angelo Cadavillo <[email protected]>

…oatingAction Widget for the default showcase widget

JanakMistry2000 · 2024-12-03T11:27:42Z

example/lib/main.dart

+            child: Padding(
+              padding: const EdgeInsets.all(16.0),
+              child: ElevatedButton(
+                onPressed: () => ShowCaseWidget.of(showcaseContext).dismiss(),


Use tear-off

lib/src/tooltip_widget.dart

aditya-css · 2024-12-04T04:16:04Z

lib/src/showcase_widget.dart

+  /// This Stores keys of showcase for which we will hide the
+  /// [globalFloatingActionWidget].
+  late var _hideFloatingWidgetKeys = {
+    for (var item in widget.hideFloatingActionWidgetForShowcase) item: true


Please make this final.

aditya-css · 2024-12-04T04:17:46Z

lib/src/showcase_widget.dart

@@ -184,9 +203,37 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {

  bool get isShowCaseCompleted => ids == null && activeWidgetId == null;

+  List<GlobalKey> get hideFloatingActionWidgetForShowcase =>


Please rename this as to make it differ from the function.

aditya-css · 2024-12-04T04:20:13Z

lib/src/showcase_widget.dart

+  void hideFloatingActionWidgetForKeys(
+    List<GlobalKey> updatedList,
+  ) {
+    _hideFloatingWidgetKeys = {for (var item in updatedList) item: true};


Please make this final.

aditya-css added the enhancement New feature or request label Mar 5, 2024

aditya-css mentioned this pull request Mar 7, 2024

I request a skip button to stop showcasing the widgets. #99

Closed

erperejildo approved these changes Apr 26, 2024

View reviewed changes

mgaucher approved these changes May 1, 2024

View reviewed changes

erperejildo approved these changes May 7, 2024

View reviewed changes

Juliocsreis mentioned this pull request Sep 4, 2024

feat: Global Skip showcase #472

Closed

7 tasks

Sahil-Simform force-pushed the feature/custom_static_widget branch 3 times, most recently from 8a55dac to f2d362e Compare October 22, 2024 09:24

Sahil-Simform force-pushed the feature/custom_static_widget branch 2 times, most recently from 716860e to e612eb9 Compare December 2, 2024 13:10

aditya-css requested changes Dec 3, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/custom_static_widget branch 5 times, most recently from bff83f1 to 1e054f1 Compare December 3, 2024 07:03

aditya-css requested changes Dec 3, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/custom_static_widget branch from 1e054f1 to e0a2d12 Compare December 3, 2024 09:26

MichaelCadavillo and others added 2 commits December 3, 2024 16:48

feat: ✨Add staticContainer into ToolTipWidget for a custom tooltip th…

895c376

…at can be placed anywhere on screen and is not affected by the animation Signed-off-by: Michael Angelo Cadavillo <[email protected]>

🩹Updated: Updated name of parameter and also added support for the fl…

e4a0b04

…oatingAction Widget for the default showcase widget

Sahil-Simform force-pushed the feature/custom_static_widget branch from e0a2d12 to 7dfee8b Compare December 3, 2024 11:26

JanakMistry2000 requested changes Dec 3, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/custom_static_widget branch 3 times, most recently from d85829f to 5db4ffd Compare December 3, 2024 12:44

Sahil-Simform force-pushed the feature/custom_static_widget branch from 5db4ffd to 0ea94f5 Compare December 3, 2024 13:36

aditya-css requested changes Dec 4, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/custom_static_widget branch from 0ea94f5 to da37b4e Compare December 4, 2024 05:12

feat: ✨Added Hide functionality for global floating action widget

b55f5cf

Sahil-Simform force-pushed the feature/custom_static_widget branch from da37b4e to b55f5cf Compare December 4, 2024 05:27

aditya-css approved these changes Dec 4, 2024

View reviewed changes

JanakMistry2000 approved these changes Dec 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ✨Add staticContainer into ToolTipWidget for a custom tooltip th… #396

feat: ✨Add staticContainer into ToolTipWidget for a custom tooltip th… #396

MichaelCadavillo commented Sep 21, 2023 •

edited by Sahil-Simform

Loading

erperejildo commented Apr 26, 2024

erperejildo commented May 15, 2024

mgaucher commented Jun 4, 2024

omi-jeybsbaterna commented Oct 17, 2024

aditya-css left a comment

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

aditya-css Dec 3, 2024

JanakMistry2000 Dec 3, 2024

aditya-css Dec 4, 2024

aditya-css Dec 4, 2024

aditya-css Dec 4, 2024

		@@ -184,9 +203,37 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {

		bool get isShowCaseCompleted => ids == null && activeWidgetId == null;

		List<GlobalKey> get hideFloatingActionWidgetForShowcase =>

feat: ✨Add staticContainer into ToolTipWidget for a custom tooltip th… #396

Are you sure you want to change the base?

feat: ✨Add staticContainer into ToolTipWidget for a custom tooltip th… #396

Conversation

MichaelCadavillo commented Sep 21, 2023 • edited by Sahil-Simform Loading

Description

Checklist

Breaking Change?

Related Issues

Sample implementation

erperejildo commented Apr 26, 2024

erperejildo commented May 15, 2024

mgaucher commented Jun 4, 2024

omi-jeybsbaterna commented Oct 17, 2024

aditya-css left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MichaelCadavillo commented Sep 21, 2023 •

edited by Sahil-Simform

Loading