StackedScrollView class

A widget that displays a scrollable view behind another widget.

This widget is typically used to display a search bar at the top or a button at the bottom of a scrollable view. The scrollable backgroundChild will have padding applied to it so that the content of the scrollable view will be offset properly to account for foregroundChild.

For example, if alignToTop is true, the foregroundChild will be placed at the top and the scrollable backgroundChild will have padding applied to the top to account for the size of the foregroundChild, but once scrolled, the background content will behind and past the foreground, while the latter stays fixed in place.

Inheritance

Constructors

StackedScrollView({Key? key, bool alignToTop = true, Axis scrollDirection = Axis.vertical, bool reverse = false, EdgeInsets? padding, bool? primary, ScrollPhysics? physics, ScrollController? controller, DragStartBehavior dragStartBehavior = DragStartBehavior.start, Clip clipBehavior = Clip.hardEdge, String? restorationId, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, required Widget foregroundChild, required Widget backgroundChild})
A widget that displays a scrollable view behind another widget.
const

Properties

alignToTop → bool
Whether to align the foregroundChild to the top of the scrollable view.
final
backgroundChild → Widget
The scrollable widget to show behind the foregroundChild.
final
clipBehavior → Clip
The clipping behavior to use.
final
controller → ScrollController?
The controller that manages the scroll view.
final
dragStartBehavior → DragStartBehavior
Determines the way that drag start behavior is handled.
final
foregroundChild → Widget
The widget to show in front of the backgroundChild.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior
How this scroll view should dismiss the on-screen keyboard.
final
padding → EdgeInsets?
The amount of space by which to inset the foregroundChild.
final
physics → ScrollPhysics?
How the scroll view should respond to user input.
final
primary → bool?
Whether this is the primary scroll view associated with the parent
final
restorationId → String?
Restoration ID to save and restore the scroll offset of the scrollable.
final
reverse → bool
Whether the scroll view scrolls in the reading direction.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollDirection → Axis
The direction in which this widget scrolls.
final

Methods

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

Operators

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