Timeline.builder constructor

Timeline.builder({
  1. Key? key,
  2. Axis? scrollDirection,
  3. bool reverse = false,
  4. ScrollController? controller,
  5. bool? primary,
  6. ScrollPhysics? physics,
  7. bool shrinkWrap = false,
  8. EdgeInsetsGeometry? padding,
  9. double? itemExtent,
  10. required IndexedWidgetBuilder itemBuilder,
  11. required int itemCount,
  12. bool addAutomaticKeepAlives = true,
  13. bool addRepaintBoundaries = true,
  14. bool addSemanticIndexes = true,
  15. double? cacheExtent,
  16. int? semanticChildCount,
  17. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  18. ScrollViewKeyboardDismissBehavior keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual,
  19. String? restorationId,
  20. Clip clipBehavior = Clip.hardEdge,
  21. TimelineThemeData? theme,
})

Creates a scrollable, linear array of widgets that are created 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.

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

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 timeline view's children are created in advance, or all at once when the Timeline itself is created, it is more efficient to use the Timeline constructor. Even more efficient, however, is to create the instances on demand using this constructor's itemBuilder callback.

The addAutomaticKeepAlives argument corresponds to the SliverChildBuilderDelegate.addAutomaticKeepAlives property. The addRepaintBoundaries argument corresponds to the SliverChildBuilderDelegate.addRepaintBoundaries property. The addSemanticIndexes argument corresponds to the SliverChildBuilderDelegate.addSemanticIndexes property. None may be null.

Timeline.builder by default does not support child reordering. If you are planning to change child order at a later time, consider using Timeline or Timeline.custom.

Implementation

Timeline.builder({
  Key? key,
  Axis? scrollDirection,
  bool reverse = false,
  ScrollController? controller,
  bool? primary,
  ScrollPhysics? physics,
  bool shrinkWrap = false,
  EdgeInsetsGeometry? padding,
  this.itemExtent,
  required IndexedWidgetBuilder itemBuilder,
  required 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,
  TimelineThemeData? theme,
})  : assert(itemCount >= 0),
      assert(semanticChildCount == null || semanticChildCount <= itemCount),
      assert(scrollDirection == null || theme == null,
          'Cannot provide both a scrollDirection and a theme.'),
      childrenDelegate = SliverChildBuilderDelegate(
        itemBuilder,
        childCount: itemCount,
        addAutomaticKeepAlives: addAutomaticKeepAlives,
        addRepaintBoundaries: addRepaintBoundaries,
        addSemanticIndexes: addSemanticIndexes,
      ),
      this.theme = theme,
      super(
        key: key,
        scrollDirection: scrollDirection ?? theme?.direction ?? Axis.vertical,
        reverse: reverse,
        controller: controller,
        primary: primary,
        physics: physics,
        shrinkWrap: shrinkWrap,
        padding: padding,
        cacheExtent: cacheExtent,
        semanticChildCount: semanticChildCount ?? itemCount,
        dragStartBehavior: dragStartBehavior,
        keyboardDismissBehavior: keyboardDismissBehavior,
        restorationId: restorationId,
        clipBehavior: clipBehavior,
      );