userScrollDirection property

ScrollDirection userScrollDirection
override

The direction in which the user is trying to change pixels, relative to the viewport's RenderViewportBase.axisDirection.

If the user is not scrolling, this will return ScrollDirection.idle even if there is (for example) a ScrollActivity currently animating the position.

This is exposed in SliverConstraints.userScrollDirection, which is used by some slivers to determine how to react to a change in scroll offset. For example, RenderSliverFloatingPersistentHeader will only expand a floating app bar when the userScrollDirection is in the positive scroll offset direction.

Implementation

@override
ScrollDirection get userScrollDirection => _userScrollDirection;