page.dart 6.31 KB
Newer Older
1 2 3 4
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'package:flutter/cupertino.dart';
6
import 'package:flutter/foundation.dart';
7
import 'package:flutter/widgets.dart';
8

9
import 'theme.dart';
10

11
// Fractional offset from 1/4 screen below the top to fully on screen.
12 13 14
final Tween<Offset> _kBottomUpTween = new Tween<Offset>(
  begin: const Offset(0.0, 0.25),
  end: Offset.zero,
15 16
);

17
// Used for Android and Fuchsia.
18
class _MountainViewPageTransition extends StatelessWidget {
19
  _MountainViewPageTransition({
20
    Key key,
21
    @required bool fade,
22 23 24 25 26 27
    @required Animation<double> routeAnimation,
    @required this.child,
  }) : _positionAnimation = _kBottomUpTween.animate(new CurvedAnimation(
         parent: routeAnimation, // The route's linear 0.0 - 1.0 animation.
         curve: Curves.fastOutSlowIn,
       )),
28
       _opacityAnimation = fade ? new CurvedAnimation(
29 30
         parent: routeAnimation,
         curve: Curves.easeIn, // Eyeballed from other Material apps.
31
       ) : const AlwaysStoppedAnimation<double>(1.0),
32
       super(key: key);
33

34
  final Animation<Offset> _positionAnimation;
35
  final Animation<double> _opacityAnimation;
36
  final Widget child;
37

38
  @override
39
  Widget build(BuildContext context) {
40 41
    // TODO(ianh): tell the transform to be un-transformed for hit testing
    return new SlideTransition(
42
      position: _positionAnimation,
43 44 45 46
      child: new FadeTransition(
        opacity: _opacityAnimation,
        child: child,
      ),
47 48 49 50
    );
  }
}

51 52
/// A modal route that replaces the entire screen with a platform-adaptive
/// transition.
53
///
54 55
/// For Android, the entrance transition for the page slides the page upwards
/// and fades it in. The exit transition is the same, but in reverse.
56
///
57 58 59 60
/// The transition is adaptive to the platform and on iOS, the page slides in
/// from the right and exits in reverse. The page also shifts to the left in
/// parallax when another page enters to cover it. (These directions are flipped
/// in environements with a right-to-left reading direction.)
61
///
62 63 64
/// By default, when a modal route is replaced by another, the previous route
/// remains in memory. To free all the resources when this is not necessary, set
/// [maintainState] to false.
65
///
66 67 68
/// The `fullscreenDialog` property specifies whether the incoming page is a
/// fullscreen modal dialog. On iOS, those pages animate from the bottom to the
/// top rather than horizontally.
69
///
70
/// The type `T` specifies the return type of the route which can be supplied as
71 72
/// the route is popped from the stack via [Navigator.pop] by providing the
/// optional `result` argument.
73
///
74 75
/// See also:
///
76 77
///  * [CupertinoPageRoute], which this [PageRoute] delegates transition
///    animations to for iOS.
Hixie's avatar
Hixie committed
78
class MaterialPageRoute<T> extends PageRoute<T> {
79
  /// Creates a page route for use in a material design app.
80
  MaterialPageRoute({
81
    @required this.builder,
82
    RouteSettings settings,
83
    this.maintainState: true,
84
    bool fullscreenDialog: false,
85
  }) : assert(builder != null),
86
       super(settings: settings, fullscreenDialog: fullscreenDialog) {
87
    // ignore: prefer_asserts_in_initializer_lists , https://github.com/dart-lang/sdk/issues/31223
88 89
    assert(opaque);
  }
90

91 92 93 94 95 96 97 98
  /// Turns on the fading of routes during page transitions.
  ///
  /// This is currently disabled by default because of performance issues on
  /// low-end phones. Eventually these issues will be resolved and this flag
  /// will be removed.
  @Deprecated('This flag will eventually be removed once the performance issues are resolved. See: https://github.com/flutter/flutter/issues/13736')
  static bool debugEnableFadingRoutes = false;

99
  /// Builds the primary contents of the route.
100
  final WidgetBuilder builder;
Adam Barth's avatar
Adam Barth committed
101

102 103 104
  @override
  final bool maintainState;

105 106 107
  /// A delegate PageRoute to which iOS themed page operations are delegated to.
  /// It's lazily created on first use.
  CupertinoPageRoute<T> get _cupertinoPageRoute {
108
    assert(_useCupertinoTransitions);
109 110 111
    _internalCupertinoPageRoute ??= new CupertinoPageRoute<T>(
      builder: builder, // Not used.
      fullscreenDialog: fullscreenDialog,
112
      hostRoute: this,
113 114 115
    );
    return _internalCupertinoPageRoute;
  }
116
  CupertinoPageRoute<T> _internalCupertinoPageRoute;
117

118 119 120 121 122 123
  /// Whether we should currently be using Cupertino transitions. This is true
  /// if the theme says we're on iOS, or if we're in an active gesture.
  bool get _useCupertinoTransitions {
    return _internalCupertinoPageRoute?.popGestureInProgress == true
        || Theme.of(navigator.context).platform == TargetPlatform.iOS;
  }
124

125
  @override
126
  Duration get transitionDuration => const Duration(milliseconds: 300);
127 128

  @override
129
  Color get barrierColor => null;
130

131 132 133
  @override
  String get barrierLabel => null;

134
  @override
135
  bool canTransitionFrom(TransitionRoute<dynamic> previousRoute) {
136
    return previousRoute is MaterialPageRoute || previousRoute is CupertinoPageRoute;
137 138
  }

139 140 141
  @override
  bool canTransitionTo(TransitionRoute<dynamic> nextRoute) {
    // Don't perform outgoing animation if the next route is a fullscreen dialog.
142 143
    return (nextRoute is MaterialPageRoute && !nextRoute.fullscreenDialog)
        || (nextRoute is CupertinoPageRoute && !nextRoute.fullscreenDialog);
144 145
  }

146 147
  @override
  void dispose() {
148
    _internalCupertinoPageRoute?.dispose();
149 150 151
    super.dispose();
  }

152
  @override
153
  Widget buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) {
154
    final Widget result = builder(context);
155
    assert(() {
156 157 158 159 160 161
      if (result == null) {
        throw new FlutterError(
          'The builder for route "${settings.name}" returned null.\n'
          'Route builders must never return null.'
        );
      }
162
      return true;
163
    }());
164 165 166
    return result;
  }

167
  @override
168
  Widget buildTransitions(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
169
    if (_useCupertinoTransitions) {
170
      return _cupertinoPageRoute.buildTransitions(context, animation, secondaryAnimation, child);
171 172
    } else {
      return new _MountainViewPageTransition(
173
        routeAnimation: animation,
174
        child: child,
175
        fade: debugEnableFadingRoutes, // ignore: deprecated_member_use
176
      );
177
    }
178 179
  }

180
  @override
181 182
  String get debugLabel => '${super.debugLabel}(${settings.name})';
}