Unverified Commit 15f187fc authored by LongCatIsLooong's avatar LongCatIsLooong Committed by GitHub

Add docs to AppBar (#31317)

- Added docs to AppBar to cover AppBar's inherited MediaQuery when not used in a Scaffold in general
- s/Hero]s/Hero]es/
parent 76f2c362
...@@ -68,9 +68,13 @@ class _ToolbarContainerLayout extends SingleChildLayoutDelegate { ...@@ -68,9 +68,13 @@ class _ToolbarContainerLayout extends SingleChildLayoutDelegate {
/// menu"). /// menu").
/// ///
/// App bars are typically used in the [Scaffold.appBar] property, which places /// App bars are typically used in the [Scaffold.appBar] property, which places
/// the app bar as a fixed-height widget at the top of the screen. For a /// the app bar as a fixed-height widget at the top of the screen. For a scrollable
/// scrollable app bar, see [SliverAppBar], which embeds an [AppBar] in a sliver /// app bar, see [SliverAppBar], which embeds an [AppBar] in a sliver for use in
/// for use in a [CustomScrollView]. /// a [CustomScrollView].
///
/// When not used as [Scaffold.appBar], or when wrapped in a [Hero], place the app
/// bar in a [MediaQuery] to take care of the padding around the content of the
/// app bar if needed, as the padding will not be handled by [Scaffold].
/// ///
/// The AppBar displays the toolbar widgets, [leading], [title], and [actions], /// The AppBar displays the toolbar widgets, [leading], [title], and [actions],
/// above the [bottom] (if any). The [bottom] is usually used for a [TabBar]. If /// above the [bottom] (if any). The [bottom] is usually used for a [TabBar]. If
......
...@@ -21,7 +21,7 @@ import 'transitions.dart'; ...@@ -21,7 +21,7 @@ import 'transitions.dart';
/// [MaterialRectArcTween]. /// [MaterialRectArcTween].
typedef CreateRectTween = Tween<Rect> Function(Rect begin, Rect end); typedef CreateRectTween = Tween<Rect> Function(Rect begin, Rect end);
/// A function that lets [Hero]s self supply a [Widget] that is shown during the /// A function that lets [Hero]es self supply a [Widget] that is shown during the
/// hero's flight from one route to another instead of default (which is to /// hero's flight from one route to another instead of default (which is to
/// show the destination route's instance of the Hero). /// show the destination route's instance of the Hero).
typedef HeroFlightShuttleBuilder = Widget Function( typedef HeroFlightShuttleBuilder = Widget Function(
...@@ -122,10 +122,10 @@ Rect _boundingBoxFor(BuildContext context, [BuildContext ancestorContext]) { ...@@ -122,10 +122,10 @@ Rect _boundingBoxFor(BuildContext context, [BuildContext ancestorContext]) {
/// ///
/// ### Nested Navigators /// ### Nested Navigators
/// ///
/// If either or both routes contain nested [Navigator]s, only [Hero]s /// If either or both routes contain nested [Navigator]s, only [Hero]es
/// contained in the top-most routes (as defined by [Route.isCurrent]) *of those /// contained in the top-most routes (as defined by [Route.isCurrent]) *of those
/// nested [Navigator]s* are considered for animation. Just like in the /// nested [Navigator]s* are considered for animation. Just like in the
/// non-nested case the top-most routes containing these [Hero]s in the nested /// non-nested case the top-most routes containing these [Hero]es in the nested
/// [Navigator]s have to be [PageRoute]s. /// [Navigator]s have to be [PageRoute]s.
/// ///
/// ## Parts of a Hero Transition /// ## Parts of a Hero Transition
...@@ -135,7 +135,7 @@ class Hero extends StatefulWidget { ...@@ -135,7 +135,7 @@ class Hero extends StatefulWidget {
/// Create a hero. /// Create a hero.
/// ///
/// The [tag] and [child] parameters must not be null. /// The [tag] and [child] parameters must not be null.
/// The [child] parameter and all of the its descendants must not be [Hero]s. /// The [child] parameter and all of the its descendants must not be [Hero]es.
const Hero({ const Hero({
Key key, Key key,
@required this.tag, @required this.tag,
...@@ -184,7 +184,7 @@ class Hero extends StatefulWidget { ...@@ -184,7 +184,7 @@ class Hero extends StatefulWidget {
/// well as the incoming and outgoing routes' [Hero] descendants' widgets and /// well as the incoming and outgoing routes' [Hero] descendants' widgets and
/// layout. /// layout.
/// ///
/// When both the source and destination [Hero]s provide a [flightShuttleBuilder], /// When both the source and destination [Hero]es provide a [flightShuttleBuilder],
/// the destination's [flightShuttleBuilder] takes precedence. /// the destination's [flightShuttleBuilder] takes precedence.
/// ///
/// If none is provided, the destination route's Hero child is shown in-flight /// If none is provided, the destination route's Hero child is shown in-flight
...@@ -200,7 +200,7 @@ class Hero extends StatefulWidget { ...@@ -200,7 +200,7 @@ class Hero extends StatefulWidget {
/// Whether to perform the hero transition if the [PageRoute] transition was /// Whether to perform the hero transition if the [PageRoute] transition was
/// triggered by a user gesture, such as a back swipe on iOS. /// triggered by a user gesture, such as a back swipe on iOS.
/// ///
/// If [Hero]s with the same [tag] on both the from and the to routes have /// If [Hero]es with the same [tag] on both the from and the to routes have
/// [transitionOnUserGestures] set to true, a back swipe gesture will /// [transitionOnUserGestures] set to true, a back swipe gesture will
/// trigger the same hero animation as a programmatically triggered push or /// trigger the same hero animation as a programmatically triggered push or
/// pop. /// pop.
......
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