feat: ❇️ Provide tooltip action buttons #466

harsh-u-simform · 2024-08-02T12:50:24Z

Description

This PR allows us to provide the list of tooltip action button with configurations.

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.

Video of the new feature

379697654-ed82cee2-f283-49e8-bfe5-a79f66e151eb.webm

- Added `toolTipAction` parameter in `Showcase` which is used to get action widget configuration and defaults to `null` - Added `DefaultToolTipActionWidget` class for default tooltip action widgets

- Added `ToolTipActionButton` class for tooltip action buttons

vatsaltanna-simformsolutions · 2024-08-27T13:10:09Z

example/ios/Runner.xcodeproj/project.pbxproj

@@ -1,500 +0,0 @@
-// !$*UTF8*$!


this file should not be changed.

CHANGELOG.md

vatsaltanna-simformsolutions · 2024-10-25T07:15:18Z

example/lib/main.dart

@@ -221,7 +236,34 @@ class _MailPageState extends State<MailPage> {
                          "Tap to see profile which contains user's name, profile picture, mobile number and country",
                      tooltipBackgroundColor: Theme.of(context).primaryColor,
                      textColor: Colors.white,
+                      onTargetClick: () {


remove unrelated changes from this PR.

vatsaltanna-simformsolutions · 2024-10-25T07:15:50Z

example/lib/main.dart

+                backgroundColor: Colors.pink.shade50,
+                textStyle: const TextStyle(
+                  color: Colors.pink,
+                )),


format the code.

vatsaltanna-simformsolutions · 2024-10-25T07:21:19Z

lib/src/showcase.dart

@@ -26,11 +26,10 @@ import 'dart:ui';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';

-import 'enum.dart';
+import '../showcaseview.dart';


any reason for this import?

No particular reason for this import; it just reduces the number of other imports needed.

Removing this and adding individual file imports.

vatsaltanna-simformsolutions · 2024-10-25T07:22:13Z

lib/src/showcase.dart

@@ -299,12 +309,14 @@ class Showcase extends StatefulWidget {
    this.tooltipPosition,
    this.titlePadding,
    this.descriptionPadding,
+    this.tooltipActions,


put action and config together in constructor

vatsaltanna-simformsolutions · 2024-10-25T07:26:48Z

lib/src/showcase.dart

+        : widget.tooltipActions ?? [];
+
+    final actionWidgets = <Widget>[];
+    for (var action = 0; action < actionData.length; action++) {


should use for in loop

vatsaltanna-simformsolutions · 2024-10-25T07:28:39Z

lib/src/showcase.dart

          ),
        ],
      ],
    );
  }
+
+  List<Widget> _getTooltipActions() {
+    final showCaseState = ShowCaseWidget.of(context);


use context check before this

vatsaltanna-simformsolutions · 2024-10-25T07:30:33Z

lib/src/showcase.dart

+          ),
+          child: TooltipActionButtonWidget(
+            config: actionData[action],
+            showCaseState: ShowCaseWidget.of(context),


Any reason to pass this state? We can access it directly from the widget.

ToolTip is not a child of the ShowCaseWidget, so we won't get the showCaseState directly in the tooltip action using the context. Therefore, we passed that as an argument.

lib/src/showcase.dart

ujas-m-simformsolutions · 2024-10-28T08:05:13Z

lib/src/tooltip_widget.dart

+    var maxTextWidth =
+        max(toolTipActionSize?.width ?? 0, max(titleLength, descriptionLength));


At line 242, you have considered textPadding for condition but not here. Why is that?

ujas-m-simformsolutions · 2024-10-28T08:05:59Z

lib/src/tooltip_widget.dart

+      if ((toolTipActionSize?.width ?? 0) >=
+          (max(titleLength, descriptionLength) + textPadding)) {
+        tooltipWidth = toolTipActionSize?.width ?? 0;
+      } else {
+        tooltipWidth = maxTextWidth + textPadding;


Here can we use maxTextWidth in some to simplify this?

lib/src/tooltip_widget.dart

ujas-m-simformsolutions · 2024-10-28T08:28:12Z

lib/src/tooltip_widget.dart

    tempPos = Offset(position!.dx, position!.dy + size!.height);
    setState(() => position = tempPos);


Add mounted check and use ??

lib/src/tooltip_widget.dart

ujas-m-simformsolutions · 2024-10-28T08:36:26Z

lib/src/widget/action_widget.dart

+        padding: EdgeInsets.only(
+          top: isArrowUp ? tooltipActionConfig.gapBetweenContentAndAction : 0.0,
+          bottom:
+              !isArrowUp ? tooltipActionConfig.gapBetweenContentAndAction : 0.0,
+        ).add(outSidePadding),


Do add operation in build.

ujas-m-simformsolutions · 2024-10-28T08:37:38Z

lib/src/tooltip_widget.dart

+          (widget.tooltipPadding ?? EdgeInsets.zero).horizontal +
+              max((widget.titlePadding ?? EdgeInsets.zero).horizontal,
+                  (widget.descriptionPadding ?? EdgeInsets.zero).horizontal);


at this point just create a variable named zeroPadding.

lib/src/showcase.dart

JanakMistry2000 · 2024-11-27T11:38:51Z

lib/src/tooltip_action_button_widget.dart

+
+    return config.button ??
+        GestureDetector(
+          onTap: handleOnTap,


Can we check if the onTap working with the button containing a transparent background. Here there chance the tap event might be received by the background barrier tap.

Yes it will work on transparent part for that user has to provide the padding as needed.
Updated Example application for this.

JanakMistry2000 · 2024-11-27T11:42:18Z

lib/src/tooltip_widget.dart

+    }
+
+    final availableSpaceForText =
+        (widget.position?.screenWidth ?? MediaQuery.of(context).size.width) -


Please add a documentation comment here explaining the logic of getting available space for text

harsh-u-simform requested a review from vatsaltanna-simformsolutions August 2, 2024 12:50

harsh-u-simform self-assigned this Aug 2, 2024

harsh-u-simform force-pushed the feature/tooltip_button_action_widget branch 2 times, most recently from 3507ecb to 2408212 Compare August 2, 2024 12:52

faiyaz-shaikh and others added 6 commits October 24, 2024 15:01

feature: ✨ Tooltip action widget

4bd624f

- Added `toolTipAction` parameter in `Showcase` which is used to get action widget configuration and defaults to `null` - Added `DefaultToolTipActionWidget` class for default tooltip action widgets

feat: ✨ Tooltip action widget

5de0853

- Added `ToolTipActionButton` class for tooltip action buttons

feat: ❇️ Provide custom widget in tooltip action

64d7496

feat: ✨ Provide custom position for tooltip action

2055107

fix: 🩹 Fix tooltip and it's action margin issue

f7faf91

feat: ❇️ Provide tooltip action buttons

2c7ab28

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch 6 times, most recently from 34cb40f to 685adf3 Compare October 25, 2024 06:36

vatsaltanna-simformsolutions reviewed Oct 25, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch 7 times, most recently from f2180b7 to 8b2c1fe Compare October 28, 2024 04:32

ujas-m-simformsolutions requested changes Oct 28, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch 2 times, most recently from b425f85 to a2fd3db Compare October 28, 2024 11:00

ujas-m-simformsolutions approved these changes Oct 28, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch from a2fd3db to 17af25d Compare October 28, 2024 12:56

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch 3 times, most recently from 52b6ca7 to ac00df9 Compare November 21, 2024 13:40

Sahil-Simform mentioned this pull request Nov 21, 2024

Positioning of tooltip over the screen #174

Closed

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch 2 times, most recently from 706a9f3 to bcf824a Compare November 25, 2024 12:39

JanakMistry2000 requested changes Nov 27, 2024

View reviewed changes

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch from bcf824a to da9b99b Compare November 27, 2024 14:11

JanakMistry2000 approved these changes Nov 28, 2024

View reviewed changes

feat:✨Added feature to add action buttons for the tooltip

2dad8a5

Sahil-Simform force-pushed the feature/tooltip_button_action_widget branch from da9b99b to 2dad8a5 Compare November 29, 2024 12:59

vatsaltanna-simformsolutions merged commit c1eb606 into master Dec 2, 2024
2 checks passed

This was referenced Dec 3, 2024

feat: ✨ Tooltip action widget #358

Closed

Feature/tip navigation: New optional navigation options for the Showcase() widget #273

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ❇️ Provide tooltip action buttons #466

feat: ❇️ Provide tooltip action buttons #466

harsh-u-simform commented Aug 2, 2024 •

edited by Sahil-Simform

Loading

vatsaltanna-simformsolutions Aug 27, 2024

vatsaltanna-simformsolutions Oct 25, 2024

vatsaltanna-simformsolutions Oct 25, 2024

vatsaltanna-simformsolutions Oct 25, 2024

Sahil-Simform Oct 25, 2024

vatsaltanna-simformsolutions Oct 25, 2024

vatsaltanna-simformsolutions Oct 25, 2024

vatsaltanna-simformsolutions Oct 25, 2024

vatsaltanna-simformsolutions Oct 25, 2024 •

edited

Loading

Sahil-Simform Oct 25, 2024

ujas-m-simformsolutions Oct 28, 2024

ujas-m-simformsolutions Oct 28, 2024

ujas-m-simformsolutions Oct 28, 2024

ujas-m-simformsolutions Oct 28, 2024

ujas-m-simformsolutions Oct 28, 2024

JanakMistry2000 Nov 27, 2024

Sahil-Simform Nov 27, 2024

JanakMistry2000 Nov 27, 2024

		var maxTextWidth =
		max(toolTipActionSize?.width ?? 0, max(titleLength, descriptionLength));

		tempPos = Offset(position!.dx, position!.dy + size!.height);
		setState(() => position = tempPos);

feat: ❇️ Provide tooltip action buttons #466

feat: ❇️ Provide tooltip action buttons #466

Conversation

harsh-u-simform commented Aug 2, 2024 • edited by Sahil-Simform Loading

Description

Checklist

Breaking Change?

Video of the new feature

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

vatsaltanna-simformsolutions Oct 25, 2024 • edited Loading

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

harsh-u-simform commented Aug 2, 2024 •

edited by Sahil-Simform

Loading

vatsaltanna-simformsolutions Oct 25, 2024 •

edited

Loading