ListView class

A scrollable list of widgets arranged linearly.

ListView is the most commonly used scrolling widget. It displays its children one after another in the scroll direction. In the cross axis, the children are required to fill the ListView.

If non-null, the itemExtent forces the children to have the given extent in the scroll direction. Specifying an itemExtent is more efficient than letting the children determine their own extent because the scrolling machinery can make use of the foreknowledge of the children’s extent to save work, for example when the scroll position changes drastically.

There are four options for constructing a ListView:

1. The default constructor takes an explicit List<Widget> of children. This constructor is appropriate for list views with a small number of children because constructing the List requires doing work for every child that could possibly be displayed in the list view instead of just those children that are actually visible.

2. The ListView.builder constructor takes an IndexedWidgetBuilder, which builds the children on demand. This constructor is appropriate for list views with a large (or infinite) number of children because the builder is called only for those children that are actually visible.

3. The ListView.separated constructor takes two IndexedWidgetBuilders: itemBuilder builds child items on demand, and separatorBuilder similarly builds separator children which appear in between the child items. This constructor is appropriate for list views with a fixed number of children.

4. The ListView.custom constructor takes a SliverChildDelegate, which provides the ability to customize additional aspects of the child model. For example, a SliverChildDelegate can control the algorithm used to estimate the size of children that are not actually visible.

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

By default, ListView will automatically pad the list’s scrollable extremities to avoid partial obstructions indicated by MediaQuery‘s padding. To avoid this behavior, override with a zero padding property.

Sample An infinite list of children:
assignment

ListView.builder(
  padding: EdgeInsets.all(8.0), itemExtent: 20.0, itemBuilder: (BuildContext context, int index) { return Text('entry $index'); }, )

Child elements’ lifecycle

Creation

While laying out the list, visible children’s elements, states and render objects will be created lazily based on existing widgets (such as when using the default constructor) or lazily provided ones (such as when using the ListView.builder constructor).

Destruction

When a child is scrolled out of view, the associated element subtree, states and render objects are destroyed. A new child at the same position in the list will be lazily recreated along with new elements, states and render objects when it is scrolled back.

Destruction mitigation

In order to preserve state as child elements are scrolled in and out of view, the following options are possible:

• Moving the ownership of non-trivial UI-state-driving business logic out of the list child subtree. For instance, if a list contains posts with their number of upvotes coming from a cached network response, store the list of posts and upvote number in a data model outside the list. Let the list child UI subtree be easily recreate-able from the source-of-truth model object. Use StatefulWidgets in the child widget subtree to store instantaneous UI state only.

• Letting KeepAlive be the root widget of the list child widget subtree that needs to be preserved. The KeepAlive widget marks the child subtree’s top render object child for keep-alive. When the associated top render object is scrolled out of view, the list keeps the child’s render object (and by extension, its associated elements and states) in a cache list instead of destroying them. When scrolled back into view, the render object is repainted as-is (if it wasn’t marked dirty in the interim).

  This only works if addAutomaticKeepAlives and addRepaintBoundaries are false since those parameters cause the ListView to wrap each child widget subtree with other widgets.

• Using AutomaticKeepAlive widgets (inserted by default when addAutomaticKeepAlives is true). Instead of unconditionally caching the child element subtree when scrolling off-screen like KeepAlive,AutomaticKeepAlive can let whether to cache the subtree be determined by descendant logic in the subtree.

  As an example, the EditableText widget signals its list child element subtree to stay alive while its text field has input focus. If it doesn’t have focus and no other descendants signaled for keep-alive via aKeepAliveNotification, the list child element subtree will be destroyed when scrolled away.

  AutomaticKeepAlive descendants typically signal it to be kept alive by using the AutomaticKeepAliveClientMixin, then implementing the wantKeepAlive getter and calling updateKeepAlive.

Transitioning to CustomScrollView

A ListView is basically a CustomScrollView with a single SliverList in its CustomScrollView.slivers property.

If ListView is no longer sufficient, for example because the scroll view is to have both a list and a grid, or because the list is to be combined with a SliverAppBar, etc, it is straight-forward to port code from usingListView to using CustomScrollView directly.

The key, scrollDirection, reverse, controller, primary, physics, and shrinkWrap properties on ListView map directly to the identically named properties on CustomScrollView.

The CustomScrollView.slivers property should be a list containing either a SliverList or a SliverFixedExtentList; the former if itemExtent on the ListView was null, and the latter if itemExtent was not null.

The childrenDelegate property on ListView corresponds to the SliverList.delegate (or SliverFixedExtentList.delegate) property. The new ListView constructor’s children argument corresponds to the childrenDelegate being a SliverChildListDelegate with that same argument. The new ListView.builderconstructor’s itemBuilder and childCount arguments correspond to the childrenDelegate being aSliverChildBuilderDelegate with the matching arguments.

The padding property corresponds to having a SliverPadding in the CustomScrollView.slivers property instead of the list itself, and having the SliverList instead be a child of the SliverPadding.

CustomScrollViews don’t automatically avoid obstructions from MediaQuery like ListViews do. To reproduce the behavior, wrap the slivers in SliverSafeAreas.

Once code has been ported to use CustomScrollView, other slivers, such as SliverGrid or SliverAppBar, can be put in the CustomScrollView.slivers list.

Sample Here are two brief snippets showing a 
ListView and its equivalent using 
CustomScrollView:
assignment

ListView(
  shrinkWrap: true, padding: const EdgeInsets.all(20.0), children: <Widget>[ const Text('I\'m dedicating every day to you'), const Text('Domestic life was never quite my style'), const Text('When you smile, you knock me out, I fall apart'), const Text('And I thought I was so smart'), ], )

Sample
assignment

CustomScrollView(
  shrinkWrap: true, slivers: <Widget>[ SliverPadding( padding: const EdgeInsets.all(20.0), sliver: SliverList( delegate: SliverChildListDelegate( <Widget>[ const Text('I\'m dedicating every day to you'), const Text('Domestic life was never quite my style'), const Text('When you smile, you knock me out, I fall apart'), const Text('And I thought I was so smart'), ], ), ), ), ], )

See also:

• SingleChildScrollView, which is a scrollable widget that has a single child.
• PageView, which is a scrolling list of child widgets that are each the size of the viewport.
• GridView, which is scrollable, 2D array of widgets.
• CustomScrollView, which is a scrollable widget that creates custom scroll effects using slivers.
• ListBody, which arranges its children in a similar manner, but without scrolling.
• ScrollNotification and NotificationListener, which can be used to watch the scroll position without using a ScrollController.

Inheritance

• Object

 

• Diagnosticable

 

• DiagnosticableTree

 

• Widget

 

• StatelessWidget

 

• ScrollView

 

• BoxScrollView

 

• ListView

Constructors

ListView({Key key, Axis scrollDirection: Axis.vertical, bool reverse: false, ScrollController controller, bool primary, ScrollPhysics physics, bool shrinkWrap: false, EdgeInsetsGeometry padding, double itemExtent, bool addAutomaticKeepAlives: true, bool addRepaintBoundaries: true, bool addSemanticIndexes: true, double cacheExtent, List<Widget> children: const [], int semanticChildCount, DragStartBehavior dragStartBehavior: DragStartBehavior.down })

Creates a scrollable, linear array of widgets from an explicit 
List. 
[…]

ListView.builder({Key key, Axis scrollDirection: Axis.vertical, bool reverse: false, ScrollController controller, bool primary, ScrollPhysics physics, bool shrinkWrap: false, EdgeInsetsGeometry padding, double itemExtent, @required IndexedWidgetBuilder itemBuilder, int itemCount, bool addAutomaticKeepAlives: true, bool addRepaintBoundaries: true, bool addSemanticIndexes: true, double cacheExtent, int semanticChildCount, DragStartBehavior dragStartBehavior: DragStartBehavior.down })

Creates a scrollable, linear array of widgets that are created on demand. 
[…]

ListView.custom({Key key, Axis scrollDirection: Axis.vertical, bool reverse: false, ScrollController controller, bool primary, ScrollPhysics physics, bool shrinkWrap: false, EdgeInsetsGeometry padding, double itemExtent, @required SliverChildDelegate childrenDelegate, double cacheExtent, int semanticChildCount })

Creates a scrollable, linear array of widgets with a custom child model. 
[…] const

ListView.separated({Key key, Axis scrollDirection: Axis.vertical, bool reverse: false, ScrollController controller, bool primary, ScrollPhysics physics, bool shrinkWrap: false, EdgeInsetsGeometry padding, @required IndexedWidgetBuilder itemBuilder, @required IndexedWidgetBuilder separatorBuilder, @required int itemCount, bool addAutomaticKeepAlives: true, bool addRepaintBoundaries: true, bool addSemanticIndexes: true, double cacheExtent })

Creates a fixed-length scrollable linear array of list “items” separated by list item “separators”. 
[…]

Properties

childrenDelegate → SliverChildDelegate

A delegate that provides the children for the 
ListView. 
[…] final

itemExtent → double

If non-null, forces the children to have the given extent in the scroll direction. 
[…] final

anchor → double

The relative position of the zero scroll offset. 
[…] final, inherited

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, inherited

center → Key

The first child in the 
GrowthDirection.forward growth direction. 
[…] final, inherited

controller → ScrollController

An object that can be used to control the position to which this scroll view is scrolled. 
[…] final, inherited

dragStartBehavior → DragStartBehavior

Determines the way that drag start behavior is handled. 
[…] final, inherited

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

padding → EdgeInsetsGeometry

The amount of space by which to inset the children. final, inherited

physics → ScrollPhysics

How the scroll view should respond to user input. 
[…] final, inherited

primary → bool

Whether this is the primary scroll view associated with the parent 
PrimaryScrollController. 
[…] final, inherited

reverse → bool

Whether the scroll view scrolls in the reading direction. 
[…] final, inherited

runtimeType → Type

A representation of the runtime type of the object. read-only, inherited

scrollDirection → Axis

The axis along which the scroll view scrolls. 
[…] final, inherited

semanticChildCount → int

The number of children that will contribute semantic information. 
[…] final, inherited

shrinkWrap → bool

Whether the extent of the scroll view in the 
scrollDirection should be determined by the contents being viewed. 
[…] final, inherited

Methods

buildChildLayout(BuildContext context) → Widget

Subclasses should override this method to build the layout model. override

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node. 
[…] override

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget. 
[…] inherited

buildSlivers(BuildContext context) → List<Widget>

Build the list of widgets to place inside the viewport. 
[…] inherited

buildViewport(BuildContext context, ViewportOffset offset, AxisDirection axisDirection, List<Widget> slivers) → Widget

Build the viewport. 
[…] @protected, inherited

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

getDirection(BuildContext context) → AxisDirection

Returns the 
AxisDirection in which the scroll view scrolls. 
[…] @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 
DiagnosticsNode.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