Scaffold class

Implements the basic material design visual layout structure.

This class provides APIs for showing drawers, snack bars, and bottom sheets.

To display a snackbar or a persistent bottom sheet, obtain the ScaffoldState for the current BuildContext via Scaffold.of and use the ScaffoldState.showSnackBar and ScaffoldState.showBottomSheet functions.

See also:



Scaffold({Key key, PreferredSizeWidget appBar, Widget body, Widget floatingActionButton, FloatingActionButtonLocation floatingActionButtonLocation, FloatingActionButtonAnimator floatingActionButtonAnimator, List<Widget> persistentFooterButtons, Widget drawer, Widget endDrawer, Widget bottomNavigationBar, Color backgroundColor, bool resizeToAvoidBottomPadding: true, bool primary: true })
Creates a visual scaffold for material design widgets.


appBar PreferredSizeWidget
An app bar to display at the top of the scaffold.
backgroundColor Color
The color of the Material widget that underlies the entire Scaffold. [...]
body Widget
The primary content of the scaffold. [...]
bottomNavigationBar Widget
A bottom navigation bar to display at the bottom of the scaffold. [...]
drawer Widget
A panel displayed to the side of the body, often hidden on mobile devices. Swipes in from either left-to-right (TextDirection.ltr) or right-to-left (TextDirection.rtl) [...]
endDrawer Widget
A panel displayed to the side of the body, often hidden on mobile devices. Swipes in from right-to-left (TextDirection.ltr) or left-to-right (TextDirection.rtl) [...]
floatingActionButton Widget
A button displayed floating above body, in the bottom right corner. [...]
floatingActionButtonAnimator FloatingActionButtonAnimator
Animator to move the floatingActionButton to a new floatingActionButtonLocation. [...]
floatingActionButtonLocation FloatingActionButtonLocation
Responsible for determining where the floatingActionButton should go. [...]
persistentFooterButtons List<Widget>
A set of buttons that are displayed at the bottom of the scaffold. [...]
primary bool
Whether this scaffold is being displayed at the top of the screen. [...]
resizeToAvoidBottomPadding bool
Whether the body (and other floating widgets) should size themselves to avoid the window's bottom padding. [...]
hashCode int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited


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


operator ==(dynamic other) bool
The equality operator. [...]

Static Methods

geometryOf(BuildContext context) ValueListenable<ScaffoldGeometry>
Returns a ValueListenable for the ScaffoldGeometry for the closest Scaffold ancestor of the given context. [...]
hasDrawer(BuildContext context, { bool registerForUpdates: true }) bool
Whether the Scaffold that most tightly encloses the given context has a drawer. [...]
of(BuildContext context, { bool nullOk: false }) ScaffoldState
The state from the closest instance of this class that encloses the given context. [...]
setFloatingActionButtonNotchFor(BuildContext context, ComputeNotch computeNotch) VoidCallback
Sets the ScaffoldGeometry.floatingActionButtonNotch for the closest Scaffold ancestor of the given context, if one exists. [...]