ScaffoldGeometry class

Geometry information for Scaffold components after layout is finished.

To get a ValueNotifier for the scaffold geometry of a given BuildContext, use Scaffold.geometryOf.

The ScaffoldGeometry is only available during the paint phase, because its value is computed during the animation and layout phases prior to painting.

For an example of using the ScaffoldGeometry, see the BottomAppBar, which uses the ScaffoldGeometry to paint a notch around the FloatingActionButton.

For information about the Scaffold's geometry that is used while laying out the FloatingActionButton, see ScaffoldPrelayoutGeometry.

Annotations
  • @immutable

Constructors

ScaffoldGeometry({double bottomNavigationBarTop, Rect floatingActionButtonArea, ComputeNotch floatingActionButtonNotch })
Create an object that describes the geometry of a Scaffold.
const

Properties

bottomNavigationBarTop double
The distance from the Scaffold's top edge to the top edge of the rectangle in which the Scaffold.bottomNavigationBar bar is laid out. [...]
final
floatingActionButtonArea Rect
The Scaffold.floatingActionButton's bounding rectangle. [...]
final
floatingActionButtonNotch ComputeNotch
A ComputeNotch for the floating action button. [...]
final
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

copyWith({double bottomNavigationBarTop, Rect floatingActionButtonArea, ComputeNotch floatingActionButtonNotch }) ScaffoldGeometry
Creates a copy of this ScaffoldGeometry but with the given fields replaced with the new values.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

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