ScrollView class

A widget that scrolls.

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 control the initial scroll offset of the scroll view, provide a controller with its ScrollController.initialScrollOffset property set.

See also:

Inheritance
Implementers

Constructors

ScrollView({Key key, Axis scrollDirection: Axis.vertical, bool reverse: false, ScrollController controller, bool primary, ScrollPhysics physics, bool shrinkWrap: false, double cacheExtent, int semanticChildCount })
Creates a widget that scrolls. [...]

Properties

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. [...]
final
controller ScrollController
An object that can be used to control the position to which this scroll view is scrolled. [...]
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 PrimaryScrollController. [...]
final
reverse bool
Whether the scroll view scrolls in the reading direction. [...]
final
scrollDirection Axis
The axis along which the scroll view scrolls. [...]
final
semanticChildCount int
The number of children that will contribute semantic information. [...]
final
shrinkWrap bool
Whether the extent of the scroll view in the scrollDirection should be determined by the contents being viewed. [...]
final
hashCode int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget. [...]
override
buildSlivers(BuildContext context) List<Widget>
Build the list of widgets to place inside the viewport. [...]
@protected
buildViewport(BuildContext context, ViewportOffset offset, AxisDirection axisDirection, List<Widget> slivers) Widget
Build the viewport. [...]
@protected
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
override
getDirection(BuildContext context) AxisDirection
Returns the AxisDirection in which the scroll view scrolls. [...]
@protected
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) String
Returns 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 ==(dynamic other) bool
The equality operator. [...]
inherited