ReorderableListView.builder constructor

const ReorderableListView.builder({
  1. Key? key,
  2. required IndexedWidgetBuilder itemBuilder,
  3. required int itemCount,
  4. required ReorderCallback onReorder,
  5. void onReorderStart(
    1. int index
    )?,
  6. void onReorderEnd(
    1. int index
    )?,
  7. double? itemExtent,
  8. ItemExtentBuilder? itemExtentBuilder,
  9. Widget? prototypeItem,
  10. ReorderItemProxyDecorator? proxyDecorator,
  11. bool buildDefaultDragHandles = true,
  12. EdgeInsets? padding,
  13. Widget? header,
  14. Widget? footer,
  15. Axis scrollDirection = Axis.vertical,
  16. bool reverse = false,
  17. ScrollController? scrollController,
  18. bool? primary,
  19. ScrollPhysics? physics,
  20. bool shrinkWrap = false,
  21. double anchor = 0.0,
  22. double? cacheExtent,
  23. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  24. ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual,
  25. String? restorationId,
  26. Clip clipBehavior = Clip.hardEdge,
  27. double? autoScrollerVelocityScalar,
})

Creates a reorderable list from widget items that are created on demand.

This constructor is appropriate for list views with a large number of children because the builder is called only for those children that are actually visible.

The itemBuilder callback will be called only with indices greater than or equal to zero and less than itemCount.

The itemBuilder should always return a non-null widget, and actually create the widget instances when called. Avoid using a builder that returns a previously-constructed widget; if the list view's children are created in advance, or all at once when the ReorderableListView itself is created, it is more efficient to use the ReorderableListView constructor. Even more efficient, however, is to create the instances on demand using this constructor's itemBuilder callback.

This example creates a list using the ReorderableListView.builder constructor. Using the IndexedWidgetBuilder, The list items are built lazily on demand.

link

To create a local project with this code sample, run:
flutter create --sample=material.ReorderableListView.builder.1 mysample

See also:

  • ReorderableListView, which allows you to build a reorderable list with all the items passed into the constructor.

Implementation

const ReorderableListView.builder({
  super.key,
  required this.itemBuilder,
  required this.itemCount,
  required this.onReorder,
  this.onReorderStart,
  this.onReorderEnd,
  this.itemExtent,
  this.itemExtentBuilder,
  this.prototypeItem,
  this.proxyDecorator,
  this.buildDefaultDragHandles = true,
  this.padding,
  this.header,
  this.footer,
  this.scrollDirection = Axis.vertical,
  this.reverse = false,
  this.scrollController,
  this.primary,
  this.physics,
  this.shrinkWrap = false,
  this.anchor = 0.0,
  this.cacheExtent,
  this.dragStartBehavior = DragStartBehavior.start,
  this.keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual,
  this.restorationId,
  this.clipBehavior = Clip.hardEdge,
  this.autoScrollerVelocityScalar,
}) : assert(itemCount >= 0),
     assert(
       (itemExtent == null && prototypeItem == null) ||
       (itemExtent == null && itemExtentBuilder == null) ||
       (prototypeItem == null && itemExtentBuilder == null),
       'You can only pass one of itemExtent, prototypeItem and itemExtentBuilder.',
     );