Visitar URL original
Material Fade Transition Configuration; showModal implementation by shihaohong · Pull Request #60 · flutter/packages · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
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
1 change: 1 addition & 0 deletions packages/animations/lib/animations.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// found in the LICENSE file.

export 'src/fade_through_transition.dart';
export 'src/fade_transition.dart';
export 'src/open_container.dart';
export 'src/page_transition_switcher.dart';
export 'src/shared_z_axis_transition.dart';
146 changes: 146 additions & 0 deletions packages/animations/lib/src/fade_transition.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
// Copyright 2019 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/material.dart';
import '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: new line between package: and non-package imports.

import 'utils/modal.dart';

/// The modal transition configuration for a 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.
///
/// ```dart
/// /// Sample widget that uses [showModal] with [FadeTransitionConfiguration].
/// class MyHomePage extends StatelessWidget {
/// @override
/// Widget build(BuildContext context) {
/// return Scaffold(
/// body: Center(
/// child: RaisedButton(
/// onPressed: () {
/// showModal(
/// context: context,
/// configuration: FadeTransitionConfiguration(),
/// builder: (BuildContext context) {
/// return CenteredFlutterLogo(),
/// },
/// );
/// },
/// child: Icon(Icons.add),
/// ),
/// ),
/// );
/// }
/// }
///
/// /// Displays a centered Flutter logo with size constraints.
/// class CenteredFlutterLogo extends StatelessWidget {
/// const _CenteredFlutterLogo();
///
/// @override
/// Widget build(BuildContext context) {
/// return Column(

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.

Why do we need the Column? Seems like it only has one child?

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.

Without the Column widget, the ConstrainedBox somehow does not respect the maximum width constraints and takes up the entire width of the screen instead. My guess is this is because it's the root widget of a new page, but I'm not entirely sure. I could investigate this and see if I could substitute in a widget that might make more sense here.

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.

That does seem odd. I would expect a Center(child: SizedBox(...)) to work as expected. Can you show me what it looks like without?

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.

SizedBox worked, but ConstrainedBox didn't when I tried. I just swapped it out

/// mainAxisAlignment: MainAxisAlignment.center,
/// children: <Widget>[
/// Center(
/// child: ConstrainedBox(

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.

Just use a SizedBox here since you're giving tight constraints?

/// constraints: const BoxConstraints(
/// maxHeight: 300,
/// maxWidth: 300,
/// minHeight: 250,
/// minWidth: 250,
/// ),
/// child: const Material(
/// child: Center(child: FlutterLogo(size: 250)),
/// ),
/// ),
/// ),
/// ],
/// );
/// }
/// }
/// ```
class FadeTransitionConfiguration extends ModalConfiguration {
/// Creates the Material fade transition configuration.

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: document that barrierDismissible cannot be null

FadeTransitionConfiguration({
bool barrierDismissible = true,
String barrierLabel,
}) : super(
barrierDismissible: barrierDismissible,
barrierLabel: barrierLabel,
);

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.

assert that barrierDismissible is not null?


@override
Color get barrierColor => Colors.black54;

@override
Duration get transitionDuration => const Duration(milliseconds: 150);

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

@override
ModalTransitionBuilder get transitionBuilder => _modalFadeTransitionBuilder;

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.

Instead of making this a getter that returns a function: Just have this be the function? You can just tear it of by passing "FadeTransitionConfiguration.transitionBuilder" around?

}

final ModalTransitionBuilder _modalFadeTransitionBuilder = (
BuildContext context,
Animation<double> animation,
Animation<double> secondaryAnimation,
Widget child,
) {
return AnimatedBuilder(
animation: animation,
builder: (BuildContext context, Widget child) {
switch (animation.status) {
case AnimationStatus.forward:
return _EnterTransition(
animation: animation,
child: child,
);
case AnimationStatus.dismissed:
case AnimationStatus.reverse:
case AnimationStatus.completed:
return FadeTransition(
opacity: animation,
child: child,
);
}
return null; // unreachable
},
child: child,
);
};

class _EnterTransition extends StatelessWidget {
const _EnterTransition({
this.animation,
this.child,
});

final Animation<double> animation;
final Widget child;

static Animatable<double> fadeInTransition = CurveTween(
curve: const Interval(0.0, 0.3),
);
static Animatable<double> scaleInTransition = Tween<double>(
begin: 0.80,
end: 1.00,
).chain(CurveTween(curve: decelerateEasing));

@override
Widget build(BuildContext context) {
return FadeTransition(
opacity: fadeInTransition.animate(animation),
child: ScaleTransition(
scale: scaleInTransition.animate(animation),
child: child,
),
);
}
}
187 changes: 187 additions & 0 deletions packages/animations/lib/src/utils/modal.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
import 'package:flutter/material.dart';

/// Signature for a function that creates a widget that builds a
/// transition.
///
/// Used by [PopupRoute.buildTransitions].

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.

PopupRoute?

typedef ModalTransitionBuilder = Widget Function(
BuildContext context,
Animation<double> animation,
Animation<double> secondaryAnimation,
Widget child,
);

/// Displays a modal above the current contents of the app.
///
/// Content below the modal is dimmed with a [ModalBarrier].
///
/// The `context` argument is used to look up the [Navigator] for the
/// modal. It is only used when the method is called. Its corresponding widget
/// can be safely removed from the tree before the modal is closed.
///
/// The `useRootNavigator` argument is used to determine whether to push the
/// modal to the [Navigator] furthest from or nearest to the given `context`.
/// By default, `useRootNavigator` is `true` and the modal route created by
/// this method is pushed to the root navigator. If the application has
/// multiple [Navigator] objects, it may be necessary to call
/// `Navigator.of(context, rootNavigator: true).pop(result)` to close the
/// modal rather than just `Navigator.pop(context, result)`.
///
/// Returns a [Future] that resolves to the value (if any) that was passed to
/// [Navigator.pop] when the modal was closed.
///
/// See also:
///
/// * [ModalConfiguration], which is the configuration object used to define
/// the modal's characteristics.
Future<T> showModal<T>({
@required BuildContext context,
@required ModalConfiguration configuration,

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.

Mention this parameter in the docs above?

bool useRootNavigator = true,
WidgetBuilder builder,
}) {
assert(configuration != null);
assert(useRootNavigator != null);
String barrierLabel = configuration.barrierLabel;
// Avoid looking up [MaterialLocalizations.of(context).modalBarrierDismissLabel]
// if there is no dismissible barrier.
if (configuration.barrierDismissible == true && configuration.barrierLabel == null) {

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.

Suggested change
if (configuration.barrierDismissible == true && configuration.barrierLabel == null) {
if (configuration.barrierDismissible && configuration.barrierLabel == null) {

barrierLabel = MaterialLocalizations.of(context).modalBarrierDismissLabel;
}
assert(!configuration.barrierDismissible || barrierLabel != null);
return Navigator.of(context, rootNavigator: useRootNavigator).push<T>(
_ModalRoute<T>(
barrierColor: configuration.barrierColor,
barrierDismissible: configuration.barrierDismissible,
barrierLabel: barrierLabel,
transitionBuilder: configuration.transitionBuilder,
transitionDuration: configuration.transitionDuration,
reverseTransitionDuration: configuration.reverseTransitionDuration,
builder: builder,
),
);
}

// A modal route that overlays a widget on the current route.
class _ModalRoute<T> extends PopupRoute<T> {
/// Creates a [_ModalRoute] route with the Material fade transition.
///
/// [barrierDismissible] is true by default.
_ModalRoute({
Color barrierColor,
bool barrierDismissible = true,
String barrierLabel,
ModalTransitionBuilder transitionBuilder,
Duration transitionDuration,
Duration reverseTransitionDuration,
@required this.builder,
}) : assert(barrierDismissible != null),
_barrierColor = barrierColor,
_barrierDismissible = barrierDismissible,
_barrierLabel = barrierLabel,
_transitionBuilder = transitionBuilder,
_transitionDuration = transitionDuration,
_reverseTransitionDuration = reverseTransitionDuration;

@override
Color get barrierColor => _barrierColor;
final Color _barrierColor;

@override
bool get barrierDismissible => _barrierDismissible;
final bool _barrierDismissible;

@override
String get barrierLabel => _barrierLabel;
final String _barrierLabel;

@override
Duration get transitionDuration => _transitionDuration;
final Duration _transitionDuration;

@override
Duration get reverseTransitionDuration => _reverseTransitionDuration;
final Duration _reverseTransitionDuration;

/// The primary contents of the modal.
final WidgetBuilder builder;

@override
Widget buildPage(
BuildContext context,
Animation<double> animation,
Animation<double> secondaryAnimation,
) {
final ThemeData theme = Theme.of(context);
return Semantics(
child: SafeArea(
child: Builder(
builder: (BuildContext context) {
final Widget child = Builder(builder: builder);
return theme != null ? Theme(data: theme, child: child) : child;
},
),
),
scopesRoute: true,
explicitChildNodes: true,
);
}

@override
Widget buildTransitions(
BuildContext context,
Animation<double> animation,
Animation<double> secondaryAnimation,
Widget child,
) => _transitionBuilder(context, animation, secondaryAnimation, child);
final ModalTransitionBuilder _transitionBuilder;

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: add blank line above?

}

/// 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 {
/// Creates a modal configuration object that provides the necessary
/// properties to implement a modal route.
ModalConfiguration({
this.barrierColor,
this.barrierDismissible,
this.barrierLabel,
this.transitionBuilder,
this.transitionDuration,
this.reverseTransitionDuration,
});

/// The color to use for the modal barrier. If this is null, the barrier will
/// be transparent.
final Color barrierColor;

/// Whether you can dismiss this route by tapping the modal barrier.
final bool barrierDismissible;

/// The semantic label used for a dismissible barrier.
final String barrierLabel;

/// A builder that defines how the route arrives on and leaves the screen.
///
/// The [buildTransitions] method is typically used to define transitions
/// that animate the new topmost route's comings and goings. When the
/// [Navigator] pushes a route on the top of its stack, the new route's
/// primary [animation] runs from 0.0 to 1.0. When the [Navigator] pops the
/// topmost route, e.g. because the use pressed the back button, the
/// primary animation runs from 1.0 to 0.0.
final ModalTransitionBuilder transitionBuilder;

/// The duration of the transition running forwards.
final Duration transitionDuration;

/// The duration of the transition running in reverse.
final Duration reverseTransitionDuration;
}
Loading