💥 Fix!: parameter changes of the Showcase and ShowCaseWidget class

HappyMakadiyaS · HappyMakadiyaS · commit fe2d20c2d12b · 2022-10-28T19:08:59.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Fixed [#253](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/issues/253) - Add TextAlign attribute for title and description
 - `pull_request_template.md.` file updated with proper document
 - `CONTRIBUTING.md` file updated with proper document
+- Updated parameter name of `ShowCaseWidget` and `Showcase` class
 
 ## [1.1.8] - August 5, 2022
 - Fixed [#237](https://github.com/SimformSolutionsPvtLtd/flutter_showcaseview/issues/237) - Feature added to enable/disable overlay click using `disableBarrierInteraction` parameters
diff --git a/README.md b/README.md
@@ -67,13 +67,13 @@ Showcase(
   titleAlignment: TextAlign.start,
   descriptionAlignment: TextAlign.start,
   disableAnimation: true,
-  shapeBorder: CircleBorder(),
-  radius: BorderRadius.all(Radius.circular(40)),
+  targetShapeBorder: CircleBorder(),
+  targetBorderRadius: BorderRadius.all(Radius.circular(40)),
   showArrow: false,
-  tipBorderRadius: BorderRadius.all(Radius.circular(8)),
-  overlayPadding: EdgeInsets.all(5),
+  tooltipBorderRadius: BorderRadius.all(Radius.circular(8)),
+  targetPadding: EdgeInsets.all(5),
   slideDuration: Duration(milliseconds: 1500),
-  tooltipColor: Colors.blueGrey,
+  tooltipBackgroundColor: Colors.blueGrey,
   blurValue: 2,
   disableDefaultTargetGestures: true,
   child: ...,
@@ -85,9 +85,9 @@ Showcase(
 ```dart
 Showcase.withWidget(
   key: _three,
-  cHeight: 80,
-  cWidth: 140,
-  shapeBorder: CircleBorder(),
+  height: 80,
+  width: 140,
+  targetShapeBorder: CircleBorder(),
   container: Column(
     crossAxisAlignment: CrossAxisAlignment.start,
     children: <Widget>[
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -216,14 +216,14 @@ class _MailPageState extends State<MailPage> {
                       ),
                     ),
                     Showcase(
-                      overlayPadding: const EdgeInsets.all(5),
+                      targetPadding: const EdgeInsets.all(5),
                       key: _two,
                       title: 'Profile',
                       description:
                           "Tap to see profile which contains user's name, profile picture, mobile number and country",
-                      showcaseBackgroundColor: Theme.of(context).primaryColor,
+                      tooltipBackgroundColor: Theme.of(context).primaryColor,
                       textColor: Colors.white,
-                      shapeBorder: const CircleBorder(),
+                      targetShapeBorder: const CircleBorder(),
                       child: Container(
                         padding: const EdgeInsets.all(5),
                         width: 45,
@@ -278,7 +278,7 @@ class _MailPageState extends State<MailPage> {
         key: _five,
         title: 'Compose Mail',
         description: 'Click here to compose mail',
-        shapeBorder: const CircleBorder(),
+        targetShapeBorder: const CircleBorder(),
         child: FloatingActionButton(
           backgroundColor: Theme.of(context).primaryColor,
           onPressed: () {
@@ -413,8 +413,10 @@ class MailTile extends StatelessWidget {
                     key: showCaseKey!,
                     height: 50,
                     width: 140,
-                    shapeBorder: const CircleBorder(),
-                    radius: const BorderRadius.all(Radius.circular(150)),
+                    targetShapeBorder: const CircleBorder(),
+                    targetBorderRadius: const BorderRadius.all(
+                      Radius.circular(150),
+                    ),
                     container: Column(
                       crossAxisAlignment: CrossAxisAlignment.start,
                       children: <Widget>[
diff --git a/lib/src/showcase.dart b/lib/src/showcase.dart
@@ -39,17 +39,17 @@ class Showcase extends StatefulWidget {
 
   final Widget child;
   final String? title;
-  final TextAlign? titleAlignment;
+  final TextAlign titleAlignment;
   final String? description;
-  final ShapeBorder? shapeBorder;
-  final BorderRadius? radius;
+  final ShapeBorder targetShapeBorder;
+  final BorderRadius? targetBorderRadius;
   final TextStyle? titleTextStyle;
   final TextStyle? descTextStyle;
-  final EdgeInsets contentPadding;
+  final EdgeInsets tooltipPadding;
   final Color overlayColor;
   final double overlayOpacity;
   final Widget? container;
-  final Color showcaseBackgroundColor;
+  final Color tooltipBackgroundColor;
   final Color textColor;
   final Widget scrollLoadingWidget;
   final bool showArrow;
@@ -60,10 +60,10 @@ class Showcase extends StatefulWidget {
   final VoidCallback? onTargetClick;
   final bool? disposeOnTap;
   final bool? disableAnimation;
-  final EdgeInsets overlayPadding;
+  final EdgeInsets targetPadding;
   final VoidCallback? onTargetDoubleTap;
   final VoidCallback? onTargetLongPress;
-  final BorderRadius? tipBorderRadius;
+  final BorderRadius? tooltipBorderRadius;
   final TextAlign descriptionAlignment;
 
   /// if disableDefaultTargetGestures parameter is true
@@ -87,12 +87,16 @@ class Showcase extends StatefulWidget {
     this.titleAlignment = TextAlign.start,
     required this.description,
     this.descriptionAlignment = TextAlign.start,
-    this.shapeBorder,
+    this.targetShapeBorder = const RoundedRectangleBorder(
+      borderRadius: BorderRadius.all(
+        Radius.circular(8),
+      ),
+    ),
     this.overlayColor = Colors.black45,
     this.overlayOpacity = 0.75,
     this.titleTextStyle,
     this.descTextStyle,
-    this.showcaseBackgroundColor = Colors.white,
+    this.tooltipBackgroundColor = Colors.white,
     this.textColor = Colors.black,
     this.scrollLoadingWidget = const CircularProgressIndicator(
         valueColor: AlwaysStoppedAnimation(Colors.white)),
@@ -101,15 +105,15 @@ class Showcase extends StatefulWidget {
     this.disposeOnTap,
     this.animationDuration = const Duration(milliseconds: 2000),
     this.disableAnimation,
-    this.contentPadding =
+    this.tooltipPadding =
         const EdgeInsets.symmetric(vertical: 8, horizontal: 8),
     this.onToolTipClick,
-    this.overlayPadding = EdgeInsets.zero,
+    this.targetPadding = EdgeInsets.zero,
     this.blurValue,
-    this.radius,
+    this.targetBorderRadius,
     this.onTargetLongPress,
     this.onTargetDoubleTap,
-    this.tipBorderRadius,
+    this.tooltipBorderRadius,
     this.disableDefaultTargetGestures = false,
   })  : height = null,
         width = null,
@@ -133,33 +137,37 @@ class Showcase extends StatefulWidget {
     required this.container,
     required this.height,
     required this.width,
-    this.title,
-    this.titleAlignment = TextAlign.start,
-    this.description,
-    this.descriptionAlignment = TextAlign.start,
-    this.shapeBorder,
+    this.targetShapeBorder = const RoundedRectangleBorder(
+      borderRadius: BorderRadius.all(
+        Radius.circular(8),
+      ),
+    ),
     this.overlayColor = Colors.black45,
-    this.radius,
+    this.targetBorderRadius,
     this.overlayOpacity = 0.75,
-    this.titleTextStyle,
-    this.descTextStyle,
-    this.showcaseBackgroundColor = Colors.white,
-    this.textColor = Colors.black,
     this.scrollLoadingWidget = const CircularProgressIndicator(
         valueColor: AlwaysStoppedAnimation(Colors.white)),
     this.onTargetClick,
     this.disposeOnTap,
     this.animationDuration = const Duration(milliseconds: 2000),
     this.disableAnimation,
-    this.contentPadding = const EdgeInsets.symmetric(vertical: 8),
-    this.overlayPadding = EdgeInsets.zero,
+    this.targetPadding = EdgeInsets.zero,
     this.blurValue,
     this.onTargetLongPress,
     this.onTargetDoubleTap,
-    this.tipBorderRadius,
     this.disableDefaultTargetGestures = false,
   })  : showArrow = false,
         onToolTipClick = null,
+        title = null,
+        description = null,
+        titleAlignment = TextAlign.start,
+        descriptionAlignment = TextAlign.start,
+        titleTextStyle = null,
+        descTextStyle = null,
+        tooltipBackgroundColor = Colors.white,
+        textColor = Colors.black,
+        tooltipBorderRadius = null,
+        tooltipPadding = const EdgeInsets.symmetric(vertical: 8),
         assert(overlayOpacity >= 0.0 && overlayOpacity <= 1.0,
             "overlay opacity must be between 0 and 1.");
 
@@ -180,7 +188,7 @@ class _ShowcaseState extends State<Showcase> {
     super.didChangeDependencies();
     position ??= GetPosition(
       key: widget.key,
-      padding: widget.overlayPadding,
+      padding: widget.targetPadding,
       screenWidth: MediaQuery.of(context).size.width,
       screenHeight: MediaQuery.of(context).size.height,
     );
@@ -231,7 +239,7 @@ class _ShowcaseState extends State<Showcase> {
         final size = MediaQuery.of(context).size;
         position = GetPosition(
           key: widget.key,
-          padding: widget.overlayPadding,
+          padding: widget.targetPadding,
           screenWidth: size.width,
           screenHeight: size.height,
         );
@@ -244,7 +252,7 @@ class _ShowcaseState extends State<Showcase> {
 
   void _nextIfAny() {
     if (timer != null && timer!.isActive) {
-      if (showCaseWidgetState.autoPlayLockEnable) {
+      if (showCaseWidgetState.enableAutoPlayLock) {
         return;
       }
       timer!.cancel();
@@ -297,12 +305,13 @@ class _ShowcaseState extends State<Showcase> {
                 child: ClipPath(
                   clipper: RRectClipper(
                     area: _isScrollRunning ? Rect.zero : rectBound,
-                    isCircle: widget.shapeBorder == const CircleBorder(),
-                    radius:
-                        _isScrollRunning ? BorderRadius.zero : widget.radius,
+                    isCircle: widget.targetShapeBorder == const CircleBorder(),
+                    radius: _isScrollRunning
+                        ? BorderRadius.zero
+                        : widget.targetBorderRadius,
                     overlayPadding: _isScrollRunning
                         ? EdgeInsets.zero
-                        : widget.overlayPadding,
+                        : widget.targetPadding,
                   ),
                   child: blur != 0
                       ? BackdropFilter(
@@ -332,10 +341,10 @@ class _ShowcaseState extends State<Showcase> {
                   offset: offset,
                   size: size,
                   onTap: _getOnTargetTap,
-                  radius: widget.radius,
+                  radius: widget.targetBorderRadius,
                   onDoubleTap: widget.onTargetDoubleTap,
                   onLongPress: widget.onTargetLongPress,
-                  shapeBorder: widget.shapeBorder,
+                  shapeBorder: widget.targetShapeBorder,
                   disableDefaultChildGestures:
                       widget.disableDefaultTargetGestures,
                 ),
@@ -351,17 +360,17 @@ class _ShowcaseState extends State<Showcase> {
                   titleTextStyle: widget.titleTextStyle,
                   descTextStyle: widget.descTextStyle,
                   container: widget.container,
-                  tooltipColor: widget.showcaseBackgroundColor,
+                  tooltipBackgroundColor: widget.tooltipBackgroundColor,
                   textColor: widget.textColor,
                   showArrow: widget.showArrow,
                   contentHeight: widget.height,
                   contentWidth: widget.width,
                   onTooltipTap: _getOnTooltipTap,
-                  contentPadding: widget.contentPadding,
+                  tooltipPadding: widget.tooltipPadding,
                   disableAnimation: widget.disableAnimation ??
                       showCaseWidgetState.disableAnimation,
                   animationDuration: widget.animationDuration,
-                  borderRadius: widget.tipBorderRadius,
+                  tooltipBorderRadius: widget.tooltipBorderRadius,
                 ),
             ],
           )
diff --git a/lib/src/showcase_widget.dart b/lib/src/showcase_widget.dart
@@ -31,7 +31,7 @@ class ShowCaseWidget extends StatefulWidget {
   final Function(int?, GlobalKey)? onComplete;
   final bool autoPlay;
   final Duration autoPlayDelay;
-  final bool autoPlayLockEnable;
+  final bool enableAutoPlayLock;
   final bool disableAnimation;
   final bool disableBarrierInteraction;
   final Duration scrollDuration;
@@ -50,7 +50,7 @@ class ShowCaseWidget extends StatefulWidget {
     this.onComplete,
     this.autoPlay = false,
     this.autoPlayDelay = const Duration(milliseconds: 2000),
-    this.autoPlayLockEnable = false,
+    this.enableAutoPlayLock = false,
     this.blurValue = 0,
     this.scrollDuration = const Duration(milliseconds: 300),
     this.disableAnimation = false,
@@ -83,7 +83,7 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
   late bool autoPlay;
   late bool disableAnimation;
   late Duration autoPlayDelay;
-  late bool autoPlayLockEnable;
+  late bool enableAutoPlayLock;
   late bool enableAutoScroll;
   late bool disableBarrierInteraction;
 
@@ -106,7 +106,7 @@ class ShowCaseWidgetState extends State<ShowCaseWidget> {
     autoPlayDelay = widget.autoPlayDelay;
     autoPlay = widget.autoPlay;
     disableAnimation = widget.disableAnimation;
-    autoPlayLockEnable = widget.autoPlayLockEnable;
+    enableAutoPlayLock = widget.enableAutoPlayLock;
     enableAutoScroll = widget.enableAutoScroll;
     disableBarrierInteraction = widget.disableBarrierInteraction;
   }
diff --git a/lib/src/tooltip_widget.dart b/lib/src/tooltip_widget.dart
