Visitar URL original
Material Fade Transition Configuration; showModal implementation by shihaohong · Pull Request #60 · flutter/packages · GitHub
Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
11d2729
WIP - Fade transition for dialogs
Jan 6, 2020
7b276fe
WIP - Refactor to extend PopupRoute
Jan 6, 2020
b652352
Implement fade_transition.dart
Jan 10, 2020
f043bff
Simple test
Jan 10, 2020
4f32441
Newline
Jan 10, 2020
2c726e0
Remove unnecessary `settings` param, API wordsmithing
Jan 10, 2020
2acc1eb
dialog -> modal
Jan 10, 2020
b28aaf5
Minor modifications to FlutterLogoModal
Jan 10, 2020
88670c2
Make Dart formatter happy
Jan 10, 2020
e8a4530
WIP - generalize showModal function
Jan 13, 2020
b3030eb
API docs and code cleanup
Jan 13, 2020
7ff4a02
Address code review feedback
Jan 14, 2020
fd4b545
Fix doc to use SizedBox instead of Column and ConstrainedBox
Jan 14, 2020
b23ca9a
Remove erroneous comma and replace with semicolon
Jan 14, 2020
b16e820
Make formatter happy
Jan 14, 2020
733084b
WIP - test scaffolding
Jan 14, 2020
33a2f35
Add fade portion of forwards transition test
Jan 14, 2020
f9b17fe
Implement forwards and reverse test for fade transition
Jan 14, 2020
9733e0f
Implement animation interrupt test - Fix bug found from writing inter…
Jan 14, 2020
5845b3f
Implement state test for fade transition
Jan 14, 2020
8474d44
modal.dart tests, comments on fade_transition_test.dart
Jan 14, 2020
69a4191
Newline at end of modal_test.dart
Jan 14, 2020
3b50849
Make formatter happy
Jan 14, 2020
0aa7422
Merge branch 'master' of github.com:flutter/packages into fade-dialog
shihaohong Jan 16, 2020
45dd4bf
Code review feedback
shihaohong Jan 16, 2020
b812d34
Code cleanup
shihaohong Jan 16, 2020
64846d8
Make formatter happy
shihaohong Jan 16, 2020
614687c
abstract getters over constructor parameters
shihaohong Jan 16, 2020
a9968c7
Abstract getter -> constructor params
shihaohong Jan 16, 2020
ae78df8
Fix incorrect reverse transition duration in modal_test.dart
shihaohong Jan 16, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Implement fade_transition.dart
  • Loading branch information
Shi Hao Hong
Shi Hao Hong committed Jan 10, 2020
commit b652352e9760cb029c019978f2ce956d443a155e
112 changes: 102 additions & 10 deletions packages/animations/lib/src/fade_transition.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,121 @@
import 'package:animations/src/utils/curves.dart';

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: this should probably be a relative import.

import 'package:flutter/material.dart';

/// TODO: add documentation
Future<T> showDialogWithFadeTransition<T>({
/// Displays a modal above the current contents of the app.
///
/// This function displays the [FadeModalRoute], which transitions in
/// with the Material fade transition.
///
/// Content below the dialog is dimmed with a [ModalBarrier].
///
/// ```dart
/// /// Sample widget that uses [showModalWithFadeTransition].
/// class MyHomePage extends StatelessWidget {
/// @override
/// Widget build(BuildContext context) {
/// return Scaffold(
/// body: Center(
/// child: RaisedButton(
/// onPressed: () {
/// showModalWithFadeTransition(
/// context: context,
/// child: FlutterLogoDialog(),
/// );
/// },
/// child: Icon(Icons.add),
/// ),
/// ),
/// );
/// }
/// }
///
/// /// Displays a modal with the FlutterLogo on it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This comment is kinda strange, nothing in this class seems to imply that it is a modal. It's only one because it was rendered with showModalWithFadeTransition, no?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Right, that makes sense. I'll rename the widget

/// class FlutterLogoDialog extends StatelessWidget {
/// FlutterLogoDialog();
///
/// @override
/// Widget build(BuildContext context) {
/// return Center(
/// child: ConstrainedBox(
/// constraints: BoxConstraints(
/// maxHeight: 500,
/// maxWidth: 500,
/// minHeight: 250,
/// minWidth: 250,
/// ),
/// child: Material(
/// child: Center(child: FlutterLogo(size: 250)),
/// ),
/// ),
/// );
/// }
/// }
/// ```
///
/// The `context` argument is used to look up the [Navigator] for the
/// dialog. It is only used when the method is called. Its corresponding widget
/// can be safely removed from the tree before the dialog is closed.
///
/// The `useRootNavigator` argument is used to determine whether to push the
/// dialog to the [Navigator] furthest from or nearest to the given `context`.
/// By default, `useRootNavigator` is `true` and the dialog route created by
/// this method is pushed to the root navigator.
///
/// If the application has multiple [Navigator] objects, it may be necessary to

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: it seems like this paragraph should just be a continuation of the previous one?

/// call `Navigator.of(context, rootNavigator: true).pop(result)` to close the
/// dialog rather than just `Navigator.pop(context, result)`.
///
/// 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".
///
/// Returns a [Future] that resolves to the value (if any) that was passed to
/// [Navigator.pop] when the dialog was closed.
///
/// See also:
///
/// * [FadeModalRoute], which is the route that is built by this function.
Future<T> showModalWithFadeTransition<T>({

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

From an API point of view: Would it be maybe better to have a showModal function that can be configured with different transitions, e.g. by passing in a transition object of some kind?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'll look into it. I think it'd take some refactoring of the existing FadeModalRoute into something more generic and have some "route configurations" class that passes along all information used by the new general ModalRoute, such as transition duration, barrier label, etc.

@required BuildContext context,
bool barrierDismissible = true,
String barrierLabel,
bool useRootNavigator = true,
Widget child,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I believe in the other showDialog type methods we deprecated the child in favor of a builder. We should probably just have a builder argument here?

}) {
barrierLabel = barrierLabel ?? MaterialLocalizations.of(context).modalBarrierDismissLabel;
// TODO: somehow control the scrim exit duration as well
assert(useRootNavigator != null);
assert(!barrierDismissible || barrierLabel != null);
return Navigator.of(context, rootNavigator: useRootNavigator).push<T>(FadeDialogRoute<T>(
return Navigator.of(context, rootNavigator: useRootNavigator).push<T>(FadeModalRoute<T>(
barrierDismissible: barrierDismissible,
barrierLabel: barrierLabel,
child: child,
));
}

class FadeDialogRoute<T> extends PopupRoute<T> {
FadeDialogRoute({
/// A modal route that overlays a widget on the current route with the Material
/// fade transition.
///
/// The fade pattern is used for UI elements that enter or exit from within
/// the screen bounds. Elements that enter use a quick fade in and scale from
/// 80% to 100%. Elements that exit simply fade out. The scale animation is
/// only applied to entering elements to emphasize new content over old.
///
/// See also:
///
/// * [showDialogWithFadeTransition], which displays the dialog popup.
class FadeModalRoute<T> extends PopupRoute<T> {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Wondering if we should just keep this class private and only make showModalWithFadeTransition the entry point?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think my original thought process here was that I felt that the Material library's _DialogRoute would have been nice to use here if it were public and more extensible.

Thinking about it now, I guess it wouldn't really matter since we're taking a similar approach as _DialogRoute with the _FadeModalRoute. I'll change this back to private.

/// Creates a [FadeModalRoute] route with the Material fade transition.
///
/// [barrierDismissible] is true by default.
FadeModalRoute({
bool barrierDismissible = true,
String barrierLabel,
RouteSettings settings,
this.child,
@required this.child,
}) : assert(barrierDismissible != null),
_barrierDismissible = barrierDismissible,
_barrierLabel = barrierLabel,
Expand All @@ -50,6 +140,10 @@ class FadeDialogRoute<T> extends PopupRoute<T> {
@override
Duration get transitionDuration => const Duration(milliseconds: 150);

@override
Duration get reverseTransitionDuration => const Duration(milliseconds: 75);

/// Builds the primary contents of the route.
final Widget child;

@override
Expand Down Expand Up @@ -85,9 +179,7 @@ class FadeDialogRoute<T> extends PopupRoute<T> {
case AnimationStatus.reverse:
case AnimationStatus.completed:
return FadeTransition(
opacity: CurveTween(
curve: const Interval(0.5, 1.0),
).animate(animation), // should be over 75ms
opacity: animation,
child: child,
);
}
Expand Down