From f48cc4611a7e53fd8f0736ede31863d432101737 Mon Sep 17 00:00:00 2001 From: Todd Volkert Date: Thu, 2 May 2019 08:02:11 -0700 Subject: [PATCH] Add documentation to Navigator (#31851) --- packages/flutter/lib/src/widgets/navigator.dart | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/flutter/lib/src/widgets/navigator.dart b/packages/flutter/lib/src/widgets/navigator.dart index 0c9a7ab58f..1cc159b055 100644 --- a/packages/flutter/lib/src/widgets/navigator.dart +++ b/packages/flutter/lib/src/widgets/navigator.dart @@ -394,6 +394,16 @@ class NavigatorObserver { /// manages a stack of [Route] objects and provides methods for managing /// the stack, like [Navigator.push] and [Navigator.pop]. /// +/// When your user interface fits this paradigm of a stack, where the user +/// should be able to _navigate_ back to an earlier element in the stack, +/// the use of routes and the Navigator is appropriate. On certain platforms, +/// such as Android, the system UI will provide a back button (outside the +/// bounds of your application) that will allow the user to navigate back +/// to earlier routes in your application's stack. On platforms that don't +/// have this build-in navigation mechanism, the use of an [AppBar] (typically +/// used in the [Scaffold.appBar] property) can automatically add a back +/// button for user navigation. +/// /// ### Displaying a full-screen route /// /// Although you can create a navigator directly, it's most common to use