[animations] Set FadeScaleTransitionConfiguration to configuration default value #136

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.

Sign up for GitHub

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

Jump to bottom

Merged

shihaohong merged 4 commits into flutter:master from mono0926:show-modal-configuration-default

Apr 23, 2020

Contributor

mono0926 commented Apr 11, 2020

showModal works well with configuration: const FadeScaleTransitionConfiguration() for typical use cases.

#124 made it possible to set FadeScaleTransitionConfiguration to configuration default value.
With this change, showModal can be just as easy to handle as showDialog.

mono0926 changed the title ~~[animations] Set FadeScaleTransitionConfiguration to configuration default value~~ [animations] Set FadeScaleTransitionConfiguration to configuration default value

goderbauer requested a review from shihaohong

April 14, 2020 20:38

shihaohong reviewed

View reviewed changes

shihaohong left a comment

Hi, thank you for the PR! I have some comments about some of the changes, but the bigger task would be to write unit tests to ensure that the default configuration used is respected.

packages/animations/lib/src/modal.dart

		@@ -45,7 +47,7 @@ typedef _ModalTransitionBuilder = Widget Function(
		/// the modal's characteristics.

shihaohong Apr 15, 2020

Specify in the API documentation for showModal that FadeScaleTransitionConfiguration will be used by default if it not specified.

shihaohong Apr 15, 2020

You need to add new tests to packages/animations/test/modal.dart ensuring that configuration is FadeScaleTransitionConfiguration by default.

What I would do is call showModal without specifying a configuration, but making sure that the animations forwards and reverse are the ones for FadeScaleTransitionConfiguration. Another thing that would be good to test here is that the barrier properties for FadeScaleTransitionConfiguration are used as well.

You can use some of the existing tests in that test file and the tests from packages/animations/test/fade_scale_transition_test.dart to guide you.

Contributor Author

mono0926 Apr 15, 2020

Thanks, I've added the tests: b158029

packages/animations/test/fade_scale_transition_test.dart Outdated

@@ @@ -21,7 +20,6 @@ void main() { @@
                                 onPressed: () {
                                   showModal<void>(
                                     context: context,
-                                    configuration: const FadeScaleTransitionConfiguration(),

shihaohong Apr 15, 2020

I would not take this line out of the test, since we still want to explicitly test that when FadeScaleTransitionConfiguration is used, we have the expected behavior. For example, if the default configuration for showModal were to ever change, this test would break

Contributor Author

mono0926 Apr 15, 2020

Okay, I'll revert this 👍

packages/animations/test/fade_scale_transition_test.dart Outdated

@@ @@ -53,7 +51,6 @@ void main() { @@
                                 onPressed: () {
                                   showModal<void>(
                                     context: context,
-                                    configuration: const FadeScaleTransitionConfiguration(),

shihaohong Apr 15, 2020

Ditto

packages/animations/test/fade_scale_transition_test.dart Outdated

@@ @@ -121,7 +118,6 @@ void main() { @@
                                 onPressed: () {
                                   showModal<void>(
                                     context: context,
-                                    configuration: const FadeScaleTransitionConfiguration(),

shihaohong Apr 15, 2020

Ditto

packages/animations/test/fade_scale_transition_test.dart Outdated

@@ @@ -186,7 +182,6 @@ void main() { @@
                                 onPressed: () {
                                   showModal<void>(
                                     context: context,
-                                    configuration: const FadeScaleTransitionConfiguration(),

shihaohong Apr 15, 2020

Ditto

packages/animations/test/fade_scale_transition_test.dart Outdated

@@ @@ -287,8 +282,6 @@ void main() { @@
                                     onPressed: () {
                                       showModal<void>(
                                         context: context,
-                                        configuration:

shihaohong Apr 15, 2020

Ditto

packages/animations/example/lib/fade_scale_transition.dart

                                 onPressed: () {
                                   showModal<void>(
                                     context: context,
-                                    configuration: const FadeScaleTransitionConfiguration(),

shihaohong Apr 15, 2020

I think we can just leave this here, but it's up to you if this becomes the default behavior

Contributor Author

mono0926 Apr 15, 2020

Thanks, I think the sample code should be simple, so omitting default value is better 🤔

mono0926 force-pushed the show-modal-configuration-default branch from b0b5d92 to a9430dc Compare

April 15, 2020 04:38

mono0926 added 3 commits

April 15, 2020 13:39


          Set showModal configuration default FadeScaleTransitionConfiguration

bb3a9fb


          Add documentation about configuration default value.

4c9f4d2


          Add test for modal with default configuration(FadeScaleTransitionConf…

b158029

…iguration)

mono0926 force-pushed the show-modal-configuration-default branch from a9430dc to b158029 Compare

April 15, 2020 04:39

mono0926 requested a review from shihaohong

April 15, 2020 04:42

Contributor Author

mono0926 commented Apr 15, 2020

Thanks for the polite review. I've reflected the points you've made, so please review it again 🙏

shihaohong approved these changes

View reviewed changes

shihaohong left a comment

Sorry for the delay in my code review, I've been busy with some other work lately and had not had the chance to look at the animations library PRs.

The changes look good! Just a small nit on the API documentation :)

packages/animations/lib/src/modal.dart Outdated

@@ @@ -27,6 +29,7 @@ typedef _ModalTransitionBuilder = Widget Function( @@
               /// modal route that will be displayed, such as the enter and exit
               /// transitions, the duration of the transitions, and modal barrier
               /// properties.
+              /// By default, `configuration` is [FadeScaleTransitionConfiguration].

shihaohong Apr 22, 2020

We usually specify the default at the end of the API doc. Could you shift this to be the last line? Thank you!

Contributor Author

mono0926 Apr 23, 2020

Thanks for the review again 🙏

But, I don't understand what change is desired 🤔

I think current default position is same as like this:

packages/packages/animations/lib/src/modal.dart

Lines 157 to 167 in f5411da

    
           /// A configuration object containing the properties needed to implement a 
        
           /// modal route. 
        
           /// 
        
           /// The `barrierDismissible` argument is used to determine whether this route 
        
           /// can be dismissed by tapping the modal barrier. This argument defaults 
        
           /// to true. If `barrierDismissible` is true, a non-null `barrierLabel` must be 
        
           /// provided. 
        
           /// 
        
           /// The `barrierLabel` argument is the semantic label used for a dismissible 
        
           /// barrier. This argument defaults to "Dismiss". 
        
           abstract class ModalConfiguration {

Could you suggest the change by using multi-line code suggestions?

shihaohong reviewed

View reviewed changes

packages/animations/lib/src/modal.dart Outdated Show resolved Hide resolved

mono0926 force-pushed the show-modal-configuration-default branch 2 times, most recently from 27f7511 to 41ae76a Compare

April 23, 2020 05:43


          Shift default sentence to be the last line

0bd1dcf

Co-Authored-By: Shi-Hao Hong <[email protected]>

mono0926 force-pushed the show-modal-configuration-default branch from 41ae76a to 0bd1dcf Compare

April 23, 2020 05:46

Contributor Author

mono0926 commented Apr 23, 2020

Thanks for the suggestion 🙏
I reflect it: 0bd1dcf

shihaohong approved these changes

View reviewed changes

shihaohong left a comment

LGTM! Thank you for working on this!

shihaohong merged commit bf3f380 into flutter:master

stuartmorgan-g pushed a commit to stuartmorgan-g/packages that referenced this pull request


          Fixing missing meta dependency (flutter#136)

860b42f

stuartmorgan-g pushed a commit that referenced this pull request


          add a hidden debugging format --dump-debug (#136)

49c97ec

stuartmorgan-g pushed a commit that referenced this pull request


          Transform clip path when applied to a group (#794)

c114581

* Transform clip path when applied to a group

Fix #136, #343, #566

* Golden test added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet