ScaffoldState class

State for a Scaffold.

Can display BottomSheets. Retrieve a ScaffoldState from the current BuildContext using Scaffold.of.

Mixed in types




appBarMaxHeight double?
The max height the Scaffold.appBar uses.
no setter
bucket RestorationBucket?
The RestorationBucket used for the restoration data of the RestorablePropertys registered to this mixin.
no setterinherited
context BuildContext
The location in the tree where this widget builds.
no setterinherited
hasAppBar bool
Whether this scaffold has a non-null Scaffold.appBar.
no setter
hasDrawer bool
Whether this scaffold has a non-null Scaffold.drawer.
no setter
hasEndDrawer bool
Whether this scaffold has a non-null Scaffold.endDrawer.
no setter
hasFloatingActionButton bool
Whether this scaffold has a non-null Scaffold.floatingActionButton.
no setter
hashCode int
The hash code for this object.
no setterinherited
isDrawerOpen bool
Whether the Scaffold.drawer is opened.
no setter
isEndDrawerOpen bool
Whether the Scaffold.endDrawer is opened.
no setter
mounted bool
Whether this State object is currently in a tree.
no setterinherited
restorationId String?
The restoration ID used for the RestorationBucket in which the mixin will store the restoration data of all registered properties.
no setteroverride
restorePending bool
Whether restoreState will be called at the beginning of the next build phase.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
widget Scaffold
The current configuration.
no setterinherited


activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
closeDrawer() → void
Closes Scaffold.drawer if it is currently opened.
closeEndDrawer() → void
Closes Scaffold.endDrawer if it is currently opened.
createTicker(TickerCallback onTick) Ticker
Creates a ticker with the given callback.
deactivate() → void
Called when this object is removed from the tree.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
didChangeDependencies() → void
Called when a dependency of this State object changes.
didToggleBucket(RestorationBucket? oldBucket) → void
Called when bucket switches between null and non-null values.
didUpdateRestorationId() → void
Must be called when the value returned by restorationId changes.
didUpdateWidget(covariant Scaffold oldWidget) → void
Called whenever the widget configuration changes.
dispose() → void
Called when this object is removed from the tree permanently.
initState() → void
Called when this object is inserted into the tree.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
openDrawer() → void
Opens the Drawer (if any).
openEndDrawer() → void
Opens the end side Drawer (if any).
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
registerForRestoration(RestorableProperty<Object?> property, String restorationId) → void
Registers a RestorableProperty for state restoration.
restoreState(RestorationBucket? oldBucket, bool initialRestore) → void
Called to initialize or restore the RestorablePropertys used by the State object.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
showBodyScrim(bool value, double opacity) → void
Whether to show a ModalBarrier over the body of the scaffold.
showBottomSheet(WidgetBuilder builder, {Color? backgroundColor, double? elevation, ShapeBorder? shape, Clip? clipBehavior, BoxConstraints? constraints, bool? enableDrag, AnimationController? transitionAnimationController}) PersistentBottomSheetController
Shows a Material Design bottom sheet in the nearest Scaffold. To show a persistent bottom sheet, use the Scaffold.bottomSheet.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel =}) String
A string representation of this object.
toStringShort() String
A brief description of this object, usually just the runtimeType and the hashCode.
unregisterFromRestoration(RestorableProperty<Object?> property) → void
Unregisters a RestorableProperty from state restoration.


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