State for a Scaffold.

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

Inheritance
Mixes-in
  • TickerProviderStateMixin

Constructors

ScaffoldState()

Properties

appBarAnimation Animation<double>

The animation controlling the size of the app bar.

read-only
appBarHeight double

The height of the app bar when fully expanded.

read-only
config Scaffold

The current configuration.

read-only, inherited
context BuildContext

The location in the tree where this widget builds.

read-only, inherited
hashCode int

Get a hash code for this object.

read-only, inherited
mounted bool

Whether this State object is currently in a tree.

read-only, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) bool

The equality operator.

inherited

Methods

build(BuildContext context) Widget

Describes the part of the user interface represented by this widget.

dispose() → void

Called when this object is removed from the tree permanently.

hideCurrentSnackBar({SnackBarClosedReason reason: SnackBarClosedReason.hide }) → void

Removes the current SnackBar by running its normal exit animation.

initState() → void

Called when this object is inserted into the tree.

openDrawer() → void

Opens the Drawer (if any).

removeCurrentSnackBar({SnackBarClosedReason reason: SnackBarClosedReason.remove }) → void

Removes the current SnackBar (if any) immediately.

showBottomSheet(WidgetBuilder builder) PersistentBottomSheetController

Shows a persistent material design bottom sheet.

showSnackBar(SnackBar snackbar) ScaffoldFeatureController<SnackBar, SnackBarClosedReason>

Shows a SnackBar at the bottom of the scaffold.

createTicker(TickerCallback onTick) Ticker

Creates a ticker with the given callback.

inherited
deactivate() → void

Called when this object is removed from the tree.

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

inherited
dependenciesChanged() → void

Called when a dependency of this State object changes.

inherited
didUpdateConfig(Scaffold oldConfig) → void

Called whenever the configuration changes.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
reassemble() → void

Called whenever the application is reassembled during debugging.

inherited
setState(VoidCallback fn) → void

Notify the framework that the internal state of this object has changed.

inherited
toString() String

Returns a string representation of this object.

inherited