Common
interface BringIntoViewSpecThe configuration of how a scrollable reacts to bring into view requests.
Check the following sample for a use case usage of this API:
Properties
Common
Deprecated Animation spec customization is no longer supported.
val scrollAnimationSpec: AnimationSpec<Float>An Animation Spec to be used as the animation to run to fulfill the BringIntoView requests.
Functions
calculateScrollDistance
fun calculateScrollDistance(offset: Float, size: Float, containerSize: Float): FloatCalculate the offset needed to bring one of the scrollable container's child into view. This will be called for every frame of the scrolling animation. This means that, as the animation progresses, the offset will naturally change to fulfill the scroll request.
All distances below are represented in pixels.
Parameters
| offset | from the side closest to the start of the container. |
| size | is the child size. |
| containerSize | Is the main axis size of the scrollable container. |
Returns
| The necessary amount to scroll to satisfy the bring into view request. Returning zero from here means that the request was satisfied and the scrolling animation should stop. |
