Skip to content

Clarify route transition animations #186552

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

Open
mvincentong wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Clarify route transition animations #186552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions packages/flutter/lib/src/widgets/pages.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,13 @@ class PageRouteBuilder<T> extends PageRoute<T> {
/// {@template flutter.widgets.pageRouteBuilder.transitionsBuilder}
/// Used to build the route's transitions.
///
/// The [animation] argument drives this route's own entrance and exit
/// transition. The [secondaryAnimation] argument drives transitions for this
/// route when another route is pushed on top of it or popped from above it, if
/// both routes allow transition coordination. See
/// [TransitionRoute.canTransitionTo] and
/// [TransitionRoute.canTransitionFrom].
///
/// See [ModalRoute.buildTransitions] for complete definition of the parameters.
/// {@endtemplate}
///
Expand Down
11 changes: 11 additions & 0 deletions packages/flutter/lib/src/widgets/routes.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2802,6 +2802,17 @@ typedef RoutePageBuilder =
/// Signature for the function that builds a route's transitions.
/// Used in [PageRouteBuilder] and [showGeneralDialog].
///
/// The [animation] argument drives this route's transition when it is pushed
/// onto or popped off the [Navigator]. The [secondaryAnimation] argument lets
/// this route coordinate with the transition of the route above it: when a new
/// route is pushed on top of this one, this route's [secondaryAnimation] runs
/// from 0.0 to 1.0, and when that route is popped it runs from 1.0 to 0.0.
///
/// A route only receives a running [secondaryAnimation] when this route's
/// [TransitionRoute.canTransitionTo] method and the next route's
/// [TransitionRoute.canTransitionFrom] method both return true. Otherwise,
/// [secondaryAnimation] remains [kAlwaysDismissedAnimation].
///
/// See [ModalRoute.buildTransitions] for complete definition of the parameters.
typedef RouteTransitionsBuilder =
Widget Function(
Expand Down