[FloatingActionButtonLocation] Add diagrams to documentation of FloatingActionButtonLocation (#70184)
diff --git a/packages/flutter/lib/src/material/floating_action_button_location.dart b/packages/flutter/lib/src/material/floating_action_button_location.dart index 74e6bb0..6c43bff 100644 --- a/packages/flutter/lib/src/material/floating_action_button_location.dart +++ b/packages/flutter/lib/src/material/floating_action_button_location.dart
@@ -58,6 +58,64 @@ /// [FloatingActionButton] placements in Material Design applications. These /// locations are available as static members of this class. /// +/// ## Floating Action Button placements +/// +/// The following diagrams show the available placement locations for the FloatingActionButton. +/// +/// * [FloatingActionButtonLocation.centerDocked]: +///  +/// +/// * [FloatingActionButtonLocation.centerFloat]: +///  +/// +/// * [FloatingActionButtonLocation.centerTop]: +///  +/// +/// * [FloatingActionButtonLocation.endDocked]: +///  +/// +/// * [FloatingActionButtonLocation.endFloat]: +///  +/// +/// * [FloatingActionButtonLocation.endTop]: +///  +/// +/// * [FloatingActionButtonLocation.startDocked]: +///  +/// +/// * [FloatingActionButtonLocation.startFloat]: +///  +/// +/// * [FloatingActionButtonLocation.startTop]: +///  +/// +/// * [FloatingActionButtonLocation.miniCenterDocked]: +///  +/// +/// * [FloatingActionButtonLocation.miniCenterFloat]: +///  +/// +/// * [FloatingActionButtonLocation.miniCenterTop]: +///  +/// +/// * [FloatingActionButtonLocation.miniEndDocked]: +///  +/// +/// * [FloatingActionButtonLocation.miniEndFloat]: +///  +/// +/// * [FloatingActionButtonLocation.miniEndTop]: +///  +/// +/// * [FloatingActionButtonLocation.miniStartDocked]: +///  +/// +/// * [FloatingActionButtonLocation.miniStartFloat]: +///  +/// +/// * [FloatingActionButtonLocation.miniStartTop]: +///  +/// /// See also: /// /// * [FloatingActionButton], which is a circular button typically shown in the @@ -81,6 +139,8 @@ /// /// This is unlikely to be a useful location for apps that lack a top [AppBar] /// or that use a [SliverAppBar] in the scaffold body itself. + /// + ///  static const FloatingActionButtonLocation startTop = _StartTopFabLocation(); /// Start-aligned [FloatingActionButton], floating over the transition between @@ -94,6 +154,8 @@ /// /// This is unlikely to be a useful location for apps that lack a top [AppBar] /// or that use a [SliverAppBar] in the scaffold body itself. + /// + ///  static const FloatingActionButtonLocation miniStartTop = _MiniStartTopFabLocation(); /// Centered [FloatingActionButton], floating over the transition between @@ -101,6 +163,8 @@ /// /// This is unlikely to be a useful location for apps that lack a top [AppBar] /// or that use a [SliverAppBar] in the scaffold body itself. + /// + ///  static const FloatingActionButtonLocation centerTop = _CenterTopFabLocation(); /// Centered [FloatingActionButton], floating over the transition between @@ -109,6 +173,8 @@ /// /// This is unlikely to be a useful location for apps that lack a top [AppBar] /// or that use a [SliverAppBar] in the scaffold body itself. + /// + ///  static const FloatingActionButtonLocation miniCenterTop = _MiniCenterTopFabLocation(); /// End-aligned [FloatingActionButton], floating over the transition between @@ -120,6 +186,8 @@ /// /// This is unlikely to be a useful location for apps that lack a top [AppBar] /// or that use a [SliverAppBar] in the scaffold body itself. + /// + ///  static const FloatingActionButtonLocation endTop = _EndTopFabLocation(); /// End-aligned [FloatingActionButton], floating over the transition between @@ -133,6 +201,8 @@ /// /// This is unlikely to be a useful location for apps that lack a top [AppBar] /// or that use a [SliverAppBar] in the scaffold body itself. + /// + ///  static const FloatingActionButtonLocation miniEndTop = _MiniEndTopFabLocation(); /// Start-aligned [FloatingActionButton], floating at the bottom of the screen. @@ -140,6 +210,8 @@ /// To align a floating action button with [CircleAvatar]s in the /// [ListTile.leading] slots of [ListTile]s in a [ListView] in the [Scaffold.body], /// use [miniStartFloat] and set [FloatingActionButton.mini] to true. + /// + ///  static const FloatingActionButtonLocation startFloat = _StartFloatFabLocation(); /// Start-aligned [FloatingActionButton], floating at the bottom of the screen, @@ -153,12 +225,16 @@ /// Compared to [FloatingActionButtonLocation.startFloat], floating action /// buttons using this location will move horizontally _and_ vertically /// closer to the edges, by [kMiniButtonOffsetAdjustment] each. + /// + ///  static const FloatingActionButtonLocation miniStartFloat = _MiniStartFloatFabLocation(); /// Centered [FloatingActionButton], floating at the bottom of the screen. /// /// To position a mini floating action button, use [miniCenterFloat] and /// set [FloatingActionButton.mini] to true. + /// + ///  static const FloatingActionButtonLocation centerFloat = _CenterFloatFabLocation(); /// Centered [FloatingActionButton], floating at the bottom of the screen, @@ -172,6 +248,8 @@ /// Compared to [FloatingActionButtonLocation.centerFloat], floating action /// buttons using this location will move vertically down /// by [kMiniButtonOffsetAdjustment]. + /// + ///  static const FloatingActionButtonLocation miniCenterFloat = _MiniCenterFloatFabLocation(); /// End-aligned [FloatingActionButton], floating at the bottom of the screen. @@ -181,6 +259,8 @@ /// To align a floating action button with [CircleAvatar]s in the /// [ListTile.trailing] slots of [ListTile]s in a [ListView] in the [Scaffold.body], /// use [miniEndFloat] and set [FloatingActionButton.mini] to true. + /// + ///  static const FloatingActionButtonLocation endFloat = _EndFloatFabLocation(); /// End-aligned [FloatingActionButton], floating at the bottom of the screen, @@ -194,6 +274,8 @@ /// Compared to [FloatingActionButtonLocation.endFloat], floating action /// buttons using this location will move horizontally _and_ vertically /// closer to the edges, by [kMiniButtonOffsetAdjustment] each. + /// + ///  static const FloatingActionButtonLocation miniEndFloat = _MiniEndFloatFabLocation(); /// Start-aligned [FloatingActionButton], floating over the @@ -210,6 +292,8 @@ /// /// This is unlikely to be a useful location for apps that lack a bottom /// navigation bar. + /// + ///  static const FloatingActionButtonLocation startDocked = _StartDockedFabLocation(); /// Start-aligned [FloatingActionButton], floating over the @@ -228,6 +312,8 @@ /// /// This is unlikely to be a useful location for apps that lack a bottom /// navigation bar. + /// + ///  static const FloatingActionButtonLocation miniStartDocked = _MiniStartDockedFabLocation(); /// Centered [FloatingActionButton], floating over the @@ -240,6 +326,8 @@ /// /// This is unlikely to be a useful location for apps that lack a bottom /// navigation bar. + /// + ///  static const FloatingActionButtonLocation centerDocked = _CenterDockedFabLocation(); /// Centered [FloatingActionButton], floating over the @@ -253,6 +341,8 @@ /// /// This is unlikely to be a useful location for apps that lack a bottom /// navigation bar. + /// + ///  static const FloatingActionButtonLocation miniCenterDocked = _MiniCenterDockedFabLocation(); /// End-aligned [FloatingActionButton], floating over the @@ -265,6 +355,8 @@ /// /// This is unlikely to be a useful location for apps that lack a bottom /// navigation bar. + /// + ///  static const FloatingActionButtonLocation endDocked = _EndDockedFabLocation(); /// End-aligned [FloatingActionButton], floating over the @@ -287,6 +379,8 @@ /// /// This is unlikely to be a useful location for apps that lack a bottom /// navigation bar. + /// + ///  static const FloatingActionButtonLocation miniEndDocked = _MiniEndDockedFabLocation(); /// Places the [FloatingActionButton] based on the [Scaffold]'s layout.