Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix!: 馃挜Parameter changes of the Showcase and ShowCaseWidget class #296

Conversation

HappyMakadiyaS
Copy link
Collaborator

@HappyMakadiyaS HappyMakadiyaS commented Oct 28, 2022

Description

This PR consist changes of parameter names in Showcase and ShowcaseWidget class.
Showcase class parameter:

  • shapeBorder -> targetShapeBorder
  • radius -> targetBorderRadius
  • contentPadding ->tooltipPadding
  • showcaseBackgroundColor ->tooltipBackgroundColor
  • overlayPadding -> targetPadding
  • tipBorderRadius -> tooltipBorderRadius

ShowCaseWidget class parameter:

  • autoPlayLockEnable -> enableAutoPlayLock

Some of the parameter of Showcase.withWidget() has been moved from parameter list to initializer list which are
title, description, titleAlignment, descriptionAlignment, titleTextStyle, descTextStyle, tooltipBackgroudColor, textColor, tooltipBorderRadius, tooltipPadding

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.

@@ -67,13 +67,13 @@ Showcase(
titleAlignment: TextAlign.start,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add seprate section of breaking changes

@ShwetaChauhan18
Copy link
Contributor

Currently, PR title validation workflow not merged so it will not check title but from my side I am suggesting this.
PR title should be:

fix: 馃挜Parameter changes of the Showcase and ShowCaseWidget class

@ShwetaChauhan18
Copy link
Contributor

ShwetaChauhan18 commented Oct 28, 2022

If you are mentioning the class name anywhere(description, title, commit message), use CLASSNAME as this symbol.

@HappyMakadiyaS HappyMakadiyaS changed the title 馃挜 Fix!: parameter changes of the Showcase and ShowCaseWidget class fix!: 馃挜Parameter changes of the Showcase and ShowCaseWidget class Oct 28, 2022
@HappyMakadiyaS HappyMakadiyaS changed the title fix!: 馃挜Parameter changes of the Showcase and ShowCaseWidget class 馃挜 Fix!: parameter changes of the Showcase and ShowCaseWidget class Oct 28, 2022
@HappyMakadiyaS HappyMakadiyaS changed the title 馃挜 Fix!: parameter changes of the Showcase and ShowCaseWidget class fix!: 馃挜Parameter changes of the Showcase and ShowCaseWidget class Oct 28, 2022
@mobile-simformsolutions mobile-simformsolutions changed the title fix!: 馃挜Parameter changes of the Showcase and ShowCaseWidget class fix: 馃挜Parameter changes of the Showcase and ShowCaseWidget class Oct 31, 2022
README.md Outdated
<tr><td>tipBorderRadius</td><td>tooltipBorderRadius</td></tr>
</table>

Unused parameters of `Showcase.withWidget()` which are not impacting view of showcase widget that has been removed from parameter list of the named constructor `Showcase.withWidget()`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused parameters of Showcase.withWidget() which do not impact the UI of showcase have been removed from the parameter list of the named constructor Showcase.withWidget().

@HappyMakadiyaS HappyMakadiyaS force-pushed the fix/parameter-changes branch 2 times, most recently from aea45fe to 9848050 Compare November 2, 2022 09:04
@HappyMakadiyaS HappyMakadiyaS changed the title fix: 馃挜Parameter changes of the Showcase and ShowCaseWidget class fix!: 馃挜Parameter changes of the Showcase and ShowCaseWidget class Nov 2, 2022
@vatsaltanna vatsaltanna merged commit c3c7d18 into SimformSolutionsPvtLtd:master Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants