ScrollMixin mixin

A mixin that provides scroll-based data fetching capabilities.

This mixin can be used with controllers that need to load more data when the user scrolls to the top or bottom of a scrollable view.

Example:

class MyController extends GetxController with ScrollMixin {
  @override
  Future<void> onEndScroll() async {
    // Load more data when scrolled to bottom
  }

  @override
  Future<void> onTopScroll() async {
    // Load previous data when scrolled to top
  }
}
Superclass constraints

Properties

hashCode → int
The hash code for this object.
no setterinherited
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scroll → ScrollController
The scroll controller used to detect scroll position
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
override
onDelete() → void
inherited
onEndScroll() → Future<void>
this method is called when the scroll is at the bottom
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
onStart() → void
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclasses. This method should be internal and is required to define the lifetime cycle of the subclass.
inherited
onTopScroll() → Future<void>
this method is called when the scroll is at the top
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited