GridView.builder constructor

GridView.builder({
  1. required ScrollViewProperties properties,
  2. Key? key,
  3. ScrollPhysics? physics,
  4. bool shrinkWrap = false,
  5. EdgeInsetsGeometry? padding,
  6. required SliverGridDelegate gridDelegate,
  7. required IndexedWidgetBuilder itemBuilder,
  8. ChildIndexGetter? findChildIndexCallback,
  9. int? itemCount,
  10. bool addAutomaticKeepAlives = true,
  11. bool addRepaintBoundaries = true,
  12. bool addSemanticIndexes = true,
  13. double? cacheExtent,
  14. int? semanticChildCount,
  15. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  16. ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual,
  17. String? restorationId,
  18. Clip clipBehavior = Clip.hardEdge,
})

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 GridView to estimate the maximum scroll extent.

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

The findChildIndexCallback corresponds to the SliverChildBuilderDelegate.findChildIndexCallback property. If null, a child widget may not map to its existing RenderObject when the order of children returned from the children builder changes. This may result in state-loss. This callback needs to be implemented if the order of the children may change at a later time.

The gridDelegate argument must not be null.

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

Implementation

GridView.builder({
  required ScrollViewProperties properties,
  Key? key,
  ScrollPhysics? physics,
  bool shrinkWrap = false,
  EdgeInsetsGeometry? padding,
  required this.gridDelegate,
  required IndexedWidgetBuilder 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,
})  : assert(gridDelegate != null),
      childrenDelegate = SliverChildBuilderDelegate(
        itemBuilder,
        findChildIndexCallback: findChildIndexCallback,
        childCount: itemCount,
        addAutomaticKeepAlives: addAutomaticKeepAlives,
        addRepaintBoundaries: addRepaintBoundaries,
        addSemanticIndexes: addSemanticIndexes,
      ),
      super(
        properties: properties,
        key: key,
        physics: physics,
        shrinkWrap: shrinkWrap,
        padding: padding,
        cacheExtent: cacheExtent,
        semanticChildCount: semanticChildCount ?? itemCount,
        dragStartBehavior: dragStartBehavior,
        keyboardDismissBehavior: keyboardDismissBehavior,
        restorationId: restorationId,
        clipBehavior: clipBehavior,
      );