CustomListView class

A custom ListView.

Unlike the ListView that force its children cross axis length to stretch, this widget can manipulate the cross axis length of the item.

{@tool snippet}

CustomListView(
  // adjust default item delegate here
  viewDelegate: CustomListViewDelegate(
    mainAxisLength: 200.0,
    crossAxisLength: 400.0,

    // alignment can also be specified
    crossAxisAlignment: CustomListViewItemAlignment.center,
  ),
  children: [
    CustomListViewItemDelegate(
      // overrides default
      mainAxisLength: 400.0,
      crossAxisLength: 200.0,
      crossAxisAlignment: CustomListViewItemAlignment.start,
      child: Text('Title'), // actual item that will be displayed
    ),
    CustomListViewItemDelegate(child: Card()),
  ],
);

{@end-tool}

See also:

• CustomListViewItemDelegate, delegate to customize children.
• CustomListViewDelegate, default delegate for the children.
• Demo link.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• ScrollView
• BoxScrollView
• ListView
• CustomListView

Constructors

CustomListView({Key? key, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, double? itemExtent, Widget? prototypeItem, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, double? cacheExtent, List<CustomListViewItemDelegate> children = const [], int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, CustomListViewItemAlignment crossAxisAlignment = CustomListViewItemAlignment.center, CustomListViewDelegate? viewDelegate})

A custom ListView.

CustomListView.builder({Key? key, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, double? itemExtent, Widget? prototypeItem, required NullableIndexedCustomListViewBuilder itemBuilder, ChildIndexGetter? findChildIndexCallback, int? itemCount, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, double? cacheExtent, int? semanticChildCount, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, CustomListViewItemAlignment crossAxisAlignment = CustomListViewItemAlignment.center, CustomListViewDelegate? viewDelegate})

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.

CustomListView.separated({Key? key, Axis scrollDirection = Axis.vertical, bool reverse = false, ScrollController? controller, bool? primary, ScrollPhysics? physics, bool shrinkWrap = false, EdgeInsetsGeometry? padding, required NullableIndexedCustomListViewBuilder itemBuilder, ChildIndexGetter? findChildIndexCallback, required IndexedCustomListViewBuilder separatorBuilder, required int itemCount, bool addAutomaticKeepAlives = true, bool addRepaintBoundaries = true, bool addSemanticIndexes = true, double? cacheExtent, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip clipBehavior = Clip.hardEdge, CustomListViewItemAlignment crossAxisAlignment = CustomListViewItemAlignment.center, CustomListViewDelegate? viewDelegate})

This constructor is CustomListView.builder with a separatorBuilder. The separatorBuilder is called between each item to separate them.

Properties

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

childrenDelegate → SliverChildDelegate

A delegate that provides the children for the ListView.

final, inherited

clipBehavior → Clip

The content will be clipped (or not) according to this option.

final, inherited

controller → ScrollController?

An object that can be used to control the position to which this scroll view is scrolled.

final, inherited

crossAxisAlignment → CustomListViewItemAlignment

How the CustomListView children should be placed along the cross axis.

final

dragStartBehavior → DragStartBehavior

Determines the way that drag start behavior is handled.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hitTestBehavior → HitTestBehavior

Defines the behavior of gesture detector used in this Scrollable.

final, inherited

itemExtent → double?

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

final, inherited

itemExtentBuilder → ItemExtentBuilder?

If non-null, forces the children to have the corresponding extent returned by the builder.

final, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior

ScrollViewKeyboardDismissBehavior the defines how this ScrollView will dismiss the keyboard automatically.

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

prototypeItem → Widget?

If non-null, forces the children to have the same extent as the given widget in the scroll direction.

final, inherited

restorationId → String?

Restoration ID to save and restore the scroll offset of the scrollable.

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.

no setter, inherited

scrollBehavior → ScrollBehavior?

A ScrollBehavior that will be applied to this widget individually.

final, inherited

scrollDirection → Axis

The Axis along which the scroll view's offset increases.

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

viewDelegate → CustomListViewDelegate?

CustomListViewItemDelegate default values.

final

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

inherited

buildChildLayout(BuildContext context) → Widget

Subclasses should override this method to build the layout model.

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.

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.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

getDirection(BuildContext context) → AxisDirection

Returns the AxisDirection in which the scroll view scrolls.

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