ScrollView class abstract

A widget that combines a Scrollable and a Viewport to create an interactive scrolling pane of content in one dimension.

Scrollable widgets consist of three pieces:

  1. A Scrollable widget, which listens for various user gestures and implements the interaction design for scrolling.
  2. A viewport widget, such as Viewport or ShrinkWrappingViewport, which implements the visual design for scrolling by displaying only a portion of the widgets inside the scroll view.
  3. One or more slivers, which are widgets that can be composed to created various scrolling effects, such as lists, grids, and expanding headers.

ScrollView helps orchestrate these pieces by creating the Scrollable and the viewport and deferring to its subclass to create the slivers.

To learn more about slivers, see CustomScrollView.slivers.

To control the initial scroll offset of the scroll view, provide a controller with its ScrollController.initialScrollOffset property set.

Persisting the scroll position during a session

Scroll views attempt to persist their scroll position using PageStorage. This can be disabled by setting ScrollController.keepScrollOffset to false on the controller. If it is enabled, using a PageStorageKey for the key of this widget is recommended to help disambiguate different scroll views from each other.

See also:



ScrollView({Key? key, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, ScrollBehavior? scrollBehavior, bool shrinkWrap = false, Key? center, double anchor = 0.0, double? cacheExtent, int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge})
Creates a widget that scrolls.


anchor double
The relative position of the zero scroll offset.
cacheExtent double?
The viewport has an area before and after the visible area to cache items that are about to become visible when the user scrolls.
center Key?
The first child in the GrowthDirection.forward growth direction.
clipBehavior Clip
The content will be clipped (or not) according to this option.
controller ScrollController?
An object that can be used to control the position to which this scroll view is scrolled.
dragStartBehavior DragStartBehavior
Determines the way that drag start behavior is handled.
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
keyboardDismissBehavior ScrollViewKeyboardDismissBehavior
ScrollViewKeyboardDismissBehavior the defines how this ScrollView will dismiss the keyboard automatically.
physics ScrollPhysics?
How the scroll view should respond to user input.
primary bool?
Whether this is the primary scroll view associated with the parent PrimaryScrollController.
restorationId String?
Restoration ID to save and restore the scroll offset of the scrollable.
reverse bool
Whether the scroll view scrolls in the reading direction.
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollBehavior ScrollBehavior?
A ScrollBehavior that will be applied to this widget individually.
scrollDirection Axis
The Axis along which the scroll view's offset increases.
semanticChildCount int?
The number of children that will contribute semantic information.
shrinkWrap bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed.


build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
buildSlivers(BuildContext context) List<Widget>
Build the list of widgets to place inside the viewport.
buildViewport(BuildContext context, ViewportOffset offset, AxisDirection axisDirection, List<Widget> slivers) Widget
Build the viewport.
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
getDirection(BuildContext context) AxisDirection
Returns the AxisDirection in which the scroll view scrolls.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
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.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
toStringShort() String
A short, textual description of this widget.


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