ScaffoldState class Null safety

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. [...]
bucket RestorationBucket?
The RestorationBucket used for the restoration data of the RestorablePropertys registered to this mixin. [...]
read-only, inherited
context BuildContext
The location in the tree where this widget builds. [...]
read-only, inherited
hasAppBar bool
Whether this scaffold has a non-null Scaffold.appBar.
hasDrawer bool
Whether this scaffold has a non-null Scaffold.drawer.
hasEndDrawer bool
Whether this scaffold has a non-null Scaffold.endDrawer.
hasFloatingActionButton bool
Whether this scaffold has a non-null Scaffold.floatingActionButton.
hashCode int
The hash code for this object. [...]
read-only, inherited
isDrawerOpen bool
Whether the Scaffold.drawer is opened. [...]
isEndDrawerOpen bool
Whether the Scaffold.endDrawer is opened. [...]
mounted bool
Whether this State object is currently in a tree. [...]
read-only, inherited
restorationId String?
The restoration ID used for the RestorationBucket in which the mixin will store the restoration data of all registered properties. [...]
read-only, override
restorePending bool
Whether restoreState will be called at the beginning of the next build phase. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
widget Scaffold
The current configuration. [...]
read-only, inherited


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. [...]
@mustCallSuper, @protected, inherited
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. [...]
@mustCallSuper, @protected, inherited
didUpdateRestorationId() → void
Must be called when the value returned by restorationId changes. [...]
@protected, inherited
didUpdateWidget(covariant Scaffold oldWidget) → void
Called whenever the widget configuration changes. [...]
dispose() → void
Called when this object is removed from the tree permanently. [...]
hideCurrentSnackBar({SnackBarClosedReason reason = SnackBarClosedReason.hide}) → void
ScaffoldMessengerState.hideCurrentSnackBar removes the current SnackBar by running its normal exit animation. This method should not be used, and will be deprecated in the near future. [...]
@Deprecated('Use ScaffoldMessenger.hideCurrentSnackBar. ' 'This feature was deprecated after v1.23.0-14.0.pre.')
initState() → void
Called when this object is inserted into the tree. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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. [...]
@mustCallSuper, @protected, inherited
registerForRestoration(RestorableProperty<Object?> property, String restorationId) → void
Registers a RestorableProperty for state restoration. [...]
@protected, inherited
removeCurrentSnackBar({SnackBarClosedReason reason = SnackBarClosedReason.remove}) → void
ScaffoldMessengerState.removeCurrentSnackBar removes the current SnackBar (if any) immediately. This method should not be used, and will be deprecated in the near future. [...]
@Deprecated('Use ScaffoldMessenger.removeCurrentSnackBar. ' 'This feature was deprecated after v1.23.0-14.0.pre.')
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. [...]
@protected, inherited
showBodyScrim(bool value, double opacity) → void
Whether to show a ModalBarrier over the body of the scaffold. [...]
showBottomSheet<T>(WidgetBuilder builder, {Color? backgroundColor, double? elevation, ShapeBorder? shape, Clip? clipBehavior, BoxConstraints? constraints, bool? enableDrag, AnimationController? transitionAnimationController}) PersistentBottomSheetController<T>
Shows a material design bottom sheet in the nearest Scaffold. To show a persistent bottom sheet, use the Scaffold.bottomSheet. [...]
showSnackBar(SnackBar snackbar) ScaffoldFeatureController<SnackBar, SnackBarClosedReason>
ScaffoldMessengerState.showSnackBar shows a SnackBar at the bottom of the scaffold. This method should not be used, and will be deprecated in the near future.. [...]
@Deprecated('Use ScaffoldMessenger.showSnackBar. ' 'This feature was deprecated after v1.23.0-14.0.pre.')
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. [...]
@protected, inherited


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