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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: Replace Offset with opacityFrom and opacityTo in ColorEffect #2876

Merged
merged 6 commits into from
Nov 27, 2023

Conversation

ufrshubham
Copy link
Member

Description

ColorEffect's API was a bit confusing because it used Offset for getting values of opacity start and end from user. This PR changes that to use optional opacityFrom and opacityTo double parameters. It also adds validate checks on these value to make sure that are between 0 and 1.

Checklist

  • 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.

Migration instructions

To specify start and end opacities for ColorEffect use the optional named parameters opacityFrom and opacityTo. So offset.dx should be set as opacityFrom and offset.dy should be set as opacityTo.

Related Issues

NA

@spydon
Copy link
Member

spydon commented Nov 27, 2023

This is on the #1938 list, but maybe it is worth doing this directly, because it is indeed really confusing.

@ufrshubham
Copy link
Member Author

This is on the #1938 list, but maybe it is worth doing this directly, because it is indeed really confusing.

Didn't know this was already in that list 😅

Copy link
Member

@spydon spydon left a comment

Choose a reason for hiding this comment

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

Lgtm!

@spydon spydon merged commit 0fd2662 into main Nov 27, 2023
8 checks passed
@spydon spydon deleted the devkage/color-effect-minor-changes branch November 27, 2023 13:21
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.

2 participants