StaggeredGridView.builder constructor

StaggeredGridView.builder({
  1. Key? key,
  2. Axis scrollDirection = Axis.vertical,
  3. bool reverse = false,
  4. ScrollController? controller,
  5. bool? primary,
  6. ScrollPhysics? physics,
  7. bool shrinkWrap = false,
  8. EdgeInsetsGeometry? padding,
  9. required SliverStaggeredGridDelegate gridDelegate,
  10. required IndexedWidgetBuilder itemBuilder,
  11. int? itemCount,
  12. bool addAutomaticKeepAlives = true,
  13. bool addRepaintBoundaries = true,
  14. String? restorationId,
})

Creates a scrollable, 2D array of widgets that are created on demand.

This constructor is appropriate for grid views with a large (or infinite) number of children because the builder is called only for those children that are actually visible.

Providing a non-null itemCount improves the ability of the SliverStaggeredGridDelegate to estimate the maximum scroll extent.

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

The gridDelegate argument must not be null.

The addAutomaticKeepAlives argument corresponds to the SliverVariableSizeChildBuilderDelegate.addAutomaticKeepAlives property. The addRepaintBoundaries argument corresponds to the SliverVariableSizeChildBuilderDelegate.addRepaintBoundaries property. Both must not be null.

Implementation

StaggeredGridView.builder({
  Key? key,
  Axis scrollDirection = Axis.vertical,
  bool reverse = false,
  ScrollController? controller,
  bool? primary,
  ScrollPhysics? physics,
  bool shrinkWrap = false,
  EdgeInsetsGeometry? padding,
  required this.gridDelegate,
  required IndexedWidgetBuilder itemBuilder,
  int? itemCount,
  this.addAutomaticKeepAlives = true,
  bool addRepaintBoundaries = true,
  String? restorationId,
})  : childrenDelegate = SliverChildBuilderDelegate(
        itemBuilder,
        childCount: itemCount,
        addAutomaticKeepAlives: addAutomaticKeepAlives,
        addRepaintBoundaries: addRepaintBoundaries,
      ),
      super(
        key: key,
        scrollDirection: scrollDirection,
        reverse: reverse,
        controller: controller,
        primary: primary,
        physics: physics,
        shrinkWrap: shrinkWrap,
        padding: padding,
        restorationId: restorationId,
      );