BottomAppBarModifier class

A container that is typically used with Scaffold.bottomNavigationBar, and can have a notch along the top that makes room for an overlapping FloatingActionButton.

Typically used with a Scaffold and a FloatingActionButton.

{@tool snippet}

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

{@end-tool}

{@tool dartpad} 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.

** See code in examples/api/lib/material/bottom_app_bar/bottom_app_bar.1.dart ** {@end-tool}

See also:

Inheritance
Available extensions

Constructors

BottomAppBarModifier({Key? key, Widget? child, Key? modifierKey, Color? color, double? elevation, NotchedShape? shape, Clip clipBehavior = Clip.none, double notchMargin = 4.0})
Creates a bottom application bar.
const

Properties

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
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
modifierKey → Key?
The actual key of the widget, which Modifier wrapped
finalinherited
notchMargin → double
The margin between the FloatingActionButton and the BottomAppBar's notch.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shape → NotchedShape?
The notch that is made for the floating action button.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
buildWithChild(BuildContext context, Widget? child) → Widget
A build method that receives an extra child parameter.
override
createElement() → SingleChildStatelessElement
Create a SingleChildStatelessElement
inherited
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
modified() → Modifier

Available on Widget, provided by the ModifierTransformer extension

Transform normal widget to Modifier
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