animateToItem method

Future<void> animateToItem(
  1. int index, {
  2. Duration duration = const Duration(milliseconds: 300),
  3. Curve curve = Curves.ease,
})

Animates the controlled carousel to the given item index.

For CarouselView, this will scroll the carousel so the item at index becomes the leading item.

If the index is less than 0, the carousel will scroll to the first item. If the index is greater than the number of items, the carousel will scroll to the last item.

For CarouselView.weighted, animates to make the item at index occupy the primary, most prominent position determined by the largest weight in flexWeights.

The animation uses the provided Duration and Curve. The returned Future completes when the animation finishes.

The Duration defaults to 300 milliseconds and Curve defaults to Curves.ease.

Does nothing if the carousel is not attached to this controller.

Implementation

Future<void> animateToItem(
  int index, {
  Duration duration = const Duration(milliseconds: 300),
  Curve curve = Curves.ease,
}) async {
  if (!hasClients || _carouselState == null) {
    return;
  }

  final bool hasFlexWeights = _carouselState!._flexWeights?.isNotEmpty ?? false;
  index = index.clamp(0, _carouselState!.widget.children.length - 1);

  await Future.wait<void>(<Future<void>>[
    for (final _CarouselPosition position in positions.cast<_CarouselPosition>())
      position.animateTo(
        _getTargetOffset(position, index, hasFlexWeights),
        duration: duration,
        curve: curve,
      ),
  ]);
}