indexed_list_view: ^2.0.0 copied to clipboard
Infinite ListView that lets you programmatically jump instantly to any item, by index. Performant for lists of any size.
Similar to a ListView, but lets you programmatically jump to any item, by index. The index jump happens instantly, no matter if you have millions of items.
Limitation: The list is always infinite both to positive and negative indexes. In other words, it can be scrolled indefinitely both to the top and to the bottom.
You can define index bounds by giving it a
but this will not prevent the list from scrolling indefinitely.
When showing items out of the index bounds, or when your
it will ask the
emptyItemBuilder to create an "empty" item to be displayed instead.
As default, this will return empty containers.
Import the package #
Add indexed_list_view as a dependency
pubspec.yaml file, and then import it:
Use the package #
First, create an indexed scroll controller:
var controller = IndexedScrollController();
Optionally, you may setup an initial index and/or initial scroll offset:
var controller = IndexedScrollController( initialIndex: 75, initialScrollOffset : 30.0);
Then, create the indexed list view, and pass it the controller:
IndexedListView.builder( controller: controller, itemBuilder: itemBuilder);
There is also the separated constructor, same as
IndexedListView.separated( controller: controller, itemBuilder: itemBuilder, separatorBuilder: separatorBuilder);
To jump, use the controller methods like
The IndexedScrollController has not only an
offset in pixels,
but also an
origin-index that indicates which item is considered to be at the offset position
So there are two ways for you to move the list programmatically:
You can change only the
or else change the
originIndex and the
offset at the same time.
To change the
originIndex you make an "index jump".
This jump is cheap, since it doesn't need to build all widgets between the old and new positions.
It will just change the origin.
If you want to move the list programmatically you must create a scroll controller of type
and pass it in the list constructor.
However, if all you need is an infinite list without jumps, then there is no need to even create a controller.
You move the list programmatically by calling the controller methods.
Controller Methods #
The is the most common method for you to use. It jumps the origin-index to the given index, and the scroll-position to 0.0.
Jumps the origin-index to the given index, and the scroll-position to offset, without animation.
If the current origin-index is already the same as the given index, animates the position from its current value to the offset position relative to the origin-index.
However, if the current origin-index is different from the given index, this will jump to the new index, without any animation. In general, there are never animations when the index changes.
animateToIndex()but also lets you specify the new offset.
Goes to origin-index "0", and then jumps the scroll position from its current value to the given offset, without animation.
If the current origin-index is already "0", animates the position from its current value to the offset position.
However, if the current origin-index is different from "0", this will jump to index "0" and the given offset, without any animation. In general, there are never animations when the index changes.
Jumps the offset, relative to the current origin-index.
Animates the offset, relative to the current origin-index.
Jumps the offset, adding or subtracting from the current offset. It keeps the same origin-index.
Animates the offset, adding or subtracting from the current offset. It keeps the same origin-index.
Don't forget to check the example tab. It shows an infinite list of items of different heights, and you may tap buttons to run some of the methods explained above.
Hopefully this widget will become obsolete when Flutter's original ListView allows for negative indexes and for indexed jumps. See: https://github.com/flutter/flutter/issues/12319
The Flutter packages I've authored:
My Medium Articles:
- Async Redux: Flutter’s non-boilerplate version of Redux (versions: Português)
- i18n_extension (versions: Português)
- Flutter: The Advanced Layout Rule Even Beginners Must Know (versions: русский)
My article in the official Flutter documentation: