Commit 582ee409 authored by Seth Ladd's avatar Seth Ladd Committed by Adam Barth

link more explicitly from route to navigator (#9843)

* link more explicitly from route to navigator

* fix from review
parent 9846385b
...@@ -39,7 +39,7 @@ class _MountainViewPageTransition extends StatelessWidget { ...@@ -39,7 +39,7 @@ class _MountainViewPageTransition extends StatelessWidget {
} }
} }
/// A modal route that replaces the entire screen with a material design transition. /// A modal route that replaces the entire screen with a platform-adaptive transition.
/// ///
/// For Android, the entrance transition for the page slides the page upwards and fades it /// 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. /// in. The exit transition is the same, but in reverse.
......
...@@ -22,6 +22,12 @@ import 'ticker_provider.dart'; ...@@ -22,6 +22,12 @@ import 'ticker_provider.dart';
/// "routes" that are pushed on and popped off the navigator. Most routes have /// "routes" that are pushed on and popped off the navigator. Most routes have
/// visual affordances, which they place in the navigators [Overlay] using one /// visual affordances, which they place in the navigators [Overlay] using one
/// or more [OverlayEntry] objects. /// or more [OverlayEntry] objects.
///
/// See [Navigator] for more explanation of how to use a Route
/// with navigation, including code examples.
///
/// See [MaterialPageRoute] for a route that replaces the
/// entire screen with a platform-adaptive transition.
abstract class Route<T> { abstract class Route<T> {
/// The navigator that the route is in, if any. /// The navigator that the route is in, if any.
NavigatorState get navigator => _navigator; NavigatorState get navigator => _navigator;
...@@ -351,7 +357,7 @@ typedef bool RoutePredicate(Route<dynamic> route); ...@@ -351,7 +357,7 @@ typedef bool RoutePredicate(Route<dynamic> route);
/// ``` /// ```
/// ///
/// It usually isn't necessary to provide a widget that pops the Navigator /// It usually isn't necessary to provide a widget that pops the Navigator
/// in a route with a Scaffold because the Scaffold automatically adds a /// in a route with a [Scaffold] because the Scaffold automatically adds a
/// 'back' button to its AppBar. Pressing the back button causes /// 'back' button to its AppBar. Pressing the back button causes
/// [Navigator.pop] to be called. On Android, pressing the system back /// [Navigator.pop] to be called. On Android, pressing the system back
/// button does the same thing. /// button does the same thing.
...@@ -359,7 +365,11 @@ typedef bool RoutePredicate(Route<dynamic> route); ...@@ -359,7 +365,11 @@ typedef bool RoutePredicate(Route<dynamic> route);
/// ### Using named navigator routes /// ### Using named navigator routes
/// ///
/// Mobile apps often manage a large number of routes and it's often /// Mobile apps often manage a large number of routes and it's often
/// easiest to refer to them by name. The [MaterialApp] can be created /// easiest to refer to them by name. Route names, by convention,
/// use a path-like structure (for example, '/a/b/c').
/// The app's home page route is named '/' by default.
///
/// The [MaterialApp] can be created
/// with a `Map<String, WidgetBuilder>` which maps from a route's name to /// with a `Map<String, WidgetBuilder>` which maps from a route's name to
/// a builder function that will create it. The [MaterialApp] uses this /// a builder function that will create it. The [MaterialApp] uses this
/// map to create a value for its navigator's [onGenerateRoute] callback. /// map to create a value for its navigator's [onGenerateRoute] callback.
...@@ -383,9 +393,6 @@ typedef bool RoutePredicate(Route<dynamic> route); ...@@ -383,9 +393,6 @@ typedef bool RoutePredicate(Route<dynamic> route);
/// Navigator.of(context).pushNamed('/b'); /// Navigator.of(context).pushNamed('/b');
/// ``` /// ```
/// ///
/// The app's home page route is named '/' by default and other routes are
/// given pathnames by convention.
///
/// ### Routes can return a value /// ### Routes can return a value
/// ///
/// When a route is pushed to ask the user for a value, the value can be /// When a route is pushed to ask the user for a value, the value can be
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment