BottomAppBar class

A container that is typically used with Scaffold.bottomNavigationBar.

Typically used with a Scaffold and a FloatingActionButton.

link
Scaffold(
  bottomNavigationBar: BottomAppBar(
    color: Colors.white,
    child: bottomAppBarContents,
  ),
  floatingActionButton: const FloatingActionButton(onPressed: null),
)

This example shows the BottomAppBar, which can be configured to have a notch using the BottomAppBar.shape property. This also includes an optional FloatingActionButton, which illustrates the FloatingActionButtonLocations in relation to the BottomAppBar.
link

To create a local project with this code sample, run:
flutter create --sample=material.BottomAppBar.2 mysample

This example shows Material 3 BottomAppBar with its expected look and behaviors.

This also includes an optional FloatingActionButton, which illustrates the FloatingActionButtonLocation.endContained.

link

To create a local project with this code sample, run:
flutter create --sample=material.BottomAppBar.3 mysample

See also:

Inheritance

Constructors

BottomAppBar({Key? key, Color? color, double? elevation, NotchedShape? shape, Clip clipBehavior = Clip.none, double notchMargin = 4.0, Widget? child, EdgeInsetsGeometry? padding, Color? surfaceTintColor, Color? shadowColor, double? height})
Creates a bottom application bar.
const

Properties

child Widget?
The widget below this widget in the tree.
final
clipBehavior Clip
The content will be clipped (or not) according to this option.
final
color Color?
The bottom app bar's background color.
final
elevation double?
The z-coordinate at which to place this bottom app bar relative to its parent.
final
hashCode int
The hash code for this object.
no setterinherited
height double?
The double value used to indicate the height of the BottomAppBar.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
notchMargin double
The margin between the FloatingActionButton and the BottomAppBar's notch.
final
padding EdgeInsetsGeometry?
The amount of space to surround the child inside the bounds of the BottomAppBar.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shadowColor Color?
The color of the shadow below the app bar.
final
shape NotchedShape?
The notch that is made for the floating action button.
final
surfaceTintColor Color?
A custom color for the Material 3 surface-tint elevation effect.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<StatefulWidget>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited